|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A representation of the model object 'Parameter'. A parameter is a specification of an argument used to pass information into or out of an invocation of a behavioral feature. It has a type, and may have a multiplicity and an optional default value.
The following features are supported:
UML2Package.getParameter()
Field Summary | |
static String |
copyright
|
Fields inherited from interface org.eclipse.uml2.NamedElement |
SEPARATOR |
Fields inherited from interface org.eclipse.uml2.MultiplicityElement |
UNLIMITED_UPPER_BOUND |
Method Summary | |
ValueSpecification |
createDefaultValue(EClass eClass)
Creates a ValueSpecification and sets the 'Default Value' containment reference |
String |
getDefault()
Returns the value of the 'Default' attribute. |
ValueSpecification |
getDefaultValue()
Returns the value of the 'Default Value' containment reference |
ParameterDirectionKind |
getDirection()
Returns the value of the 'Direction' attribute. |
ParameterEffectKind |
getEffect()
Returns the value of the 'Effect' attribute. |
Namespace |
getNamespace()
|
Operation |
getOperation()
Returns the value of the 'Operation' container reference. |
EList |
getOwnedElements()
|
ParameterSet |
getParameterSet(String unqualifiedName)
Retrieves the ParameterSet with the specified name from the 'Parameter Set' reference list |
EList |
getParameterSets()
Returns the value of the 'Parameter Set' reference list. |
boolean |
isException()
Returns the value of the 'Is Exception' attribute. |
boolean |
isStream()
Returns the value of the 'Is Stream' attribute. |
void |
setBooleanDefault(boolean value)
Sets the default to the specified boolean value. |
void |
setDefaultValue(ValueSpecification value)
Sets the value of the ' Default Value ' containment reference |
void |
setDirection(ParameterDirectionKind value)
Sets the value of the ' Direction ' attribute |
void |
setEffect(ParameterEffectKind value)
Sets the value of the ' Effect ' attribute |
void |
setIntegerDefault(int value)
Sets the default to the specified integer value. |
void |
setIsException(boolean value)
Sets the value of the ' Is Exception ' attribute |
void |
setIsStream(boolean value)
Sets the value of the ' Is Stream ' attribute |
void |
setOperation(Operation value)
Sets the value of the ' Operation ' container reference |
void |
setStringDefault(String value)
Sets the default to the specified string value. |
void |
setUnlimitedNaturalDefault(int value)
Sets the default to the specified unlimited natural value. |
Methods inherited from interface org.eclipse.uml2.ConnectableElement |
getEnds |
Methods inherited from interface org.eclipse.uml2.NamedElement |
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getOwner, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership |
Methods inherited from interface org.eclipse.uml2.TemplateableElement |
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature |
Methods inherited from interface org.eclipse.uml2.Element |
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf |
Methods inherited from interface org.eclipse.emf.ecore.EModelElement |
getEAnnotation, getEAnnotations |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
eAdapters, eDeliver, eNotify, eSetDeliver |
Methods inherited from interface org.eclipse.uml2.ParameterableElement |
getOwner, getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter |
Methods inherited from interface org.eclipse.uml2.TypedElement |
getType, setType |
Methods inherited from interface org.eclipse.uml2.MultiplicityElement |
createLowerValue, createUpperValue, getLower, getLowerValue, getUpper, getUpperValue, includesCardinality, includesMultiplicity, isMultivalued, isOrdered, isUnique, lower, lowerBound, setIsOrdered, setIsUnique, setLowerBound, setLowerValue, setUpperBound, setUpperValue, upper, upperBound, validateLowerEqLowerbound, validateLowerGe0, validateUpperEqUpperbound, validateUpperGeLower, validateUpperGt0 |
Field Detail |
public static final String copyright
Method Detail |
public String getDefault()
""
.
If the meaning of the 'Default' attribute isn't clear, there really should be more of a description here...
UML2Package.getParameter_Default()
public ParameterDirectionKind getDirection()
"in"
.
The literals are from the enumeration ParameterDirectionKind
.
If the meaning of the 'Direction' attribute isn't clear, there really should be more of a description here...
Indicates whether a parameter is being sent into or out of a behavioral element. The default value is in.
ParameterDirectionKind
,
setDirection(ParameterDirectionKind)
,
UML2Package.getParameter_Direction()
public void setDirection(ParameterDirectionKind value)
Direction
' attribute.
value
- the new value of the 'Direction' attribute.ParameterDirectionKind
,
getDirection()
public boolean isException()
"false"
.
If the meaning of the 'Is Exception' attribute isn't clear, there really should be more of a description here...
setIsException(boolean)
,
UML2Package.getParameter_IsException()
public void setIsException(boolean value)
Is Exception
' attribute.
value
- the new value of the 'Is Exception' attribute.isException()
public boolean isStream()
"false"
.
If the meaning of the 'Is Stream' attribute isn't clear, there really should be more of a description here...
setIsStream(boolean)
,
UML2Package.getParameter_IsStream()
public void setIsStream(boolean value)
Is Stream
' attribute.
value
- the new value of the 'Is Stream' attribute.isStream()
public ParameterEffectKind getEffect()
ParameterEffectKind
.
If the meaning of the 'Effect' attribute isn't clear, there really should be more of a description here...
ParameterEffectKind
,
setEffect(ParameterEffectKind)
,
UML2Package.getParameter_Effect()
public void setEffect(ParameterEffectKind value)
Effect
' attribute.
value
- the new value of the 'Effect' attribute.ParameterEffectKind
,
getEffect()
public Operation getOperation()
Owned Parameter
'.
If the meaning of the 'Operation' reference isn't clear, there really should be more of a description here...
References the Operation for which this is a formal parameter. Subsets NamedElement:: namespace.
setOperation(Operation)
,
UML2Package.getParameter_Operation()
,
Operation.getOwnedParameters()
public void setOperation(Operation value)
Operation
' container reference.
value
- the new value of the 'Operation' container reference.getOperation()
public ValueSpecification getDefaultValue()
If the meaning of the 'Default Value' containment reference isn't clear, there really should be more of a description here...
Specifies a ValueSpecification that represents a value to be used when no argument is supplied for the Parameter. Subsets Element::ownedElement.
setDefaultValue(ValueSpecification)
,
UML2Package.getParameter_DefaultValue()
public void setDefaultValue(ValueSpecification value)
Default Value
' containment reference.
value
- the new value of the 'Default Value' containment reference.getDefaultValue()
public ValueSpecification createDefaultValue(EClass eClass)
ValueSpecification
and sets the 'Default Value' containment reference.
eClass
- The Ecore class of the ValueSpecification
to create.
ValueSpecification
.getDefaultValue()
public EList getParameterSets()
ParameterSet
.
It is bidirectional and its opposite is 'Parameter
'.
If the meaning of the 'Parameter Set' reference list isn't clear, there really should be more of a description here...
UML2Package.getParameter_ParameterSet()
,
ParameterSet.getParameters()
public ParameterSet getParameterSet(String unqualifiedName)
ParameterSet
with the specified name from the 'Parameter Set' reference list.
unqualifiedName
- The unqualified name of the ParameterSet
to retrieve.
ParameterSet
with the specified name, or null
.getParameterSets()
public Namespace getNamespace()
getNamespace
in interface NamedElement
public EList getOwnedElements()
getOwnedElements
in interface NamedElement
public void setBooleanDefault(boolean value)
value
- The new value of the default.getDefault()
public void setIntegerDefault(int value)
value
- The new value of the default.getDefault()
public void setStringDefault(String value)
value
- The new value of the default.getDefault()
public void setUnlimitedNaturalDefault(int value)
value
- The new value of the default.getDefault()
|
Copyright 2003, 2004 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |