public class UmlOperation extends AbstractUmlObject
Modifier and Type | Class and Description |
---|---|
static class |
UmlOperation.Data
Data from the UML model repository specific to
UmlOperation . |
static class |
UmlOperation.ReturnKind |
CLASS_SEPARATOR, NULL_OBJ_NAME, PACKAGE_SEPARATOR
Modifier and Type | Method and Description |
---|---|
UmlClass |
addException(UmlClass exc)
Adds non-null class
exc to this operation, and returns the same object. |
UmlParameter |
addParameter(UmlParameter par)
Adds non-null parameter
par to this operation, and returns the same object. |
UmlClass |
getContainingClass() |
java.lang.String |
getEaExceptionTypeInfo(int i) |
int |
getEaReturnTypeId() |
java.lang.String |
getEaReturnTypeInfo()
Returns known (string) info from EA; useful to display in case the return type of this
operation in EA model is not a valid UML class, so the model can be corrected.
|
java.lang.String |
getEaReturnTypeName() |
java.util.Set<UmlClass> |
getEfferentClasses()
Returns all classes that I use as type for return value, parameter or exception.
|
java.util.List<UmlClass> |
getExceptions()
Returns all exceptions declared for this operation.
|
java.lang.String |
getExceptionsSignature()
Returns potentially empty string containing comma-separated list of exceptions that follow
the 'throw' statement in operation signature.
|
UmlKind |
getKind()
Returns kind of this UML object, as assigned by the application.
|
static java.util.List<UmlKind> |
getKinds(Nature nature)
Returns all available classifications (kinds) for operations.
|
Namespace |
getNamespace()
Returns the namespace of this UML object, based on tagged values in the UML model and when
missing, calculated by the application.
|
Nature |
getNature()
Returns the nature of this UML object, which determines the validation rules to apply, and
sometimes document generation formats.
|
OwningWg |
getOwner()
Returns the IEC working group owning this UML object, as calculated by the application based
on the UML model structure.
|
java.util.List<UmlParameter> |
getParameters()
Returns all parameters of this operation.
|
java.util.Set<java.lang.String> |
getPredefinedTagNames()
Returns allowed tag names, as expected to be found in the UML model.
|
java.lang.String |
getQualifiedName()
Returns the name of this UML object combined with some container-related information (e.g.,
packageName.className, or containingPackageName.packageName).
|
UmlClass |
getReturnType()
Returns return type of this operation, null if kind is
UmlOperation.ReturnKind.OP_RET_VOID . |
java.lang.String |
getSignature()
E.g.
|
boolean |
isAbstract() |
boolean |
isFinal() |
boolean |
isInformative()
Returns whether this UML object is informative (and thus should be ignored when generating
official IEC documents).
|
boolean |
isStatic() |
boolean |
isVoidReturned() |
java.lang.String |
toString() |
addDeprecAndInf, addTaggedValue, appendRemainingCustomStereotypes, classifyPerScope, classifyPerScopePerTag, classifyPerTag, collectDuplicateDescriptions, collectDuplicateNames, collectForScope, collectNames, collectQNames, findAllForName, findWithSameUuidAndLog, getAlias, getDescription, getHtmlDescription, getId, getName, getSince, getStereotype, getTaggedValues, getUnallowedTagNames, getUuid, getVisibility, initFromTags, isDeprecated, saveTags, toShortString, toShortString, validateTag
public static java.util.List<UmlKind> getKinds(Nature nature)
nature
- ignored in this methodpublic UmlClass getContainingClass()
public boolean isAbstract()
public boolean isStatic()
public boolean isFinal()
public boolean isVoidReturned()
public int getEaReturnTypeId()
public java.lang.String getEaReturnTypeName()
public java.lang.String getEaReturnTypeInfo()
public java.lang.String getEaExceptionTypeInfo(int i)
public UmlClass getReturnType()
UmlOperation.ReturnKind.OP_RET_VOID
.public UmlParameter addParameter(UmlParameter par)
par
to this operation, and returns the same object.public java.util.List<UmlParameter> getParameters()
public UmlClass addException(UmlClass exc)
exc
to this operation, and returns the same object.public java.util.List<UmlClass> getExceptions()
public java.util.Set<UmlClass> getEfferentClasses()
public java.lang.String getExceptionsSignature()
public java.lang.String getSignature()
public OwningWg getOwner()
UmlObject
getOwner
in interface UmlObject
getOwner
in class AbstractUmlObject
public Namespace getNamespace()
Returns own namespace initialised from tagged values if not empty. Otherwise, returns the namespace of the containing class.
public Nature getNature()
UmlObject
getNature
in interface UmlObject
getNature
in class AbstractUmlObject
public boolean isInformative()
AbstractUmlObject
This default implementation returns true if objects steretypes include . If there are additional criteria for deriving informative status, ensure to invoke this default implementation first.
isInformative
in interface UmlObject
isInformative
in class AbstractUmlObject
UmlObject.isInformative()
public UmlKind getKind()
UmlObject
getKind
in interface UmlObject
getKind
in class AbstractUmlObject
public java.lang.String getQualifiedName()
UmlObject
getQualifiedName
in interface UmlObject
getQualifiedName
in class AbstractUmlObject
public java.util.Set<java.lang.String> getPredefinedTagNames()
UmlObject
public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2009-2016 Tatjana (Tanja) Kostic