|
|||||||||||
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. Parameters are allowed to be treated as connectable elements. Parameters have support for streaming, exceptions, and parameter sets.
The following features are supported:
UMLPackage.getParameter()
Field Summary |
Fields inherited from interface org.eclipse.uml2.uml.NamedElement |
SEPARATOR |
Method Summary | |
ValueSpecification |
createDefaultValue(String name,
Type type,
EClass eClass)
Creates a new ValueSpecification , with the specified 'Name', and 'Type', 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. |
Operation |
getOperation()
Returns the value of the 'Operation' reference |
ParameterSet |
getParameterSet(String name)
Retrieves the first ParameterSet with the specified 'Name' from the 'Parameter Set' reference list |
ParameterSet |
getParameterSet(String name,
boolean ignoreCase)
Retrieves the first 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 |
isSetDefault()
Returns whether the value of the ' Default ' attribute is set |
boolean |
isSetEffect()
Returns whether the value of the ' Effect ' attribute is set |
boolean |
isStream()
Returns the value of the 'Is Stream' attribute. |
void |
setBooleanDefaultValue(boolean value)
Sets the default value for this parameter to the specified Boolean value |
void |
setDefault(String value)
Sets the value of the ' Default ' attribute |
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 |
setIntegerDefaultValue(int value)
Sets the default value for this parameter 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 |
setNullDefaultValue()
Sets the default value for this parameter to the null value |
void |
setStringDefaultValue(String value)
Sets the default value for this parameter to the specified string value |
void |
setUnlimitedNaturalDefaultValue(int value)
Sets the default value for this parameter to the specified unlimited natural value |
void |
unsetDefault()
Unsets the value of the ' Default ' attribute |
void |
unsetEffect()
Unsets the value of the ' Effect ' attribute |
boolean |
validateConnectorEnd(DiagnosticChain diagnostics,
Map context)
A parameter may only be associated with a connector end within the context of a collaboration. |
boolean |
validateInAndOut(DiagnosticChain diagnostics,
Map context)
Only in and inout parameters may have a delete effect. |
boolean |
validateNotException(DiagnosticChain diagnostics,
Map context)
An input parameter cannot be an exception. |
boolean |
validateReentrantBehaviors(DiagnosticChain diagnostics,
Map context)
Reentrant behaviors cannot have stream parameters. |
boolean |
validateStreamAndException(DiagnosticChain diagnostics,
Map context)
A parameter cannot be a stream and exception at the same time. |
Methods inherited from interface org.eclipse.uml2.uml.ConnectableElement |
getEnds |
Methods inherited from interface org.eclipse.uml2.uml.TypedElement |
getType, setType |
Methods inherited from interface org.eclipse.uml2.uml.NamedElement |
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership |
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.uml.ParameterableElement |
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter |
Methods inherited from interface org.eclipse.uml2.uml.MultiplicityElement |
compatibleWith, createLowerValue, createUpperValue, getLower, getLowerValue, getUpper, getUpperValue, includesCardinality, includesMultiplicity, is, isMultivalued, isOrdered, isUnique, lowerBound, setIsOrdered, setIsUnique, setLower, setLowerValue, setUpper, setUpperValue, upperBound, validateLowerGe0, validateUpperGeLower, validateUpperGt0, validateValueSpecificationConstant, validateValueSpecificationNoSideEffects |
Method Detail |
public EList getParameterSets()
ParameterSet
.
It is bidirectional and its opposite is 'Parameter
'.
The parameter sets containing the parameter. See ParameterSet.
UMLPackage.getParameter_ParameterSet()
,
ParameterSet.getParameters()
public ParameterSet getParameterSet(String name)
ParameterSet
with the specified 'Name' from the 'Parameter Set' reference list.
name
- The 'Name' of the ParameterSet
to retrieve, or null
.
ParameterSet
with the specified 'Name', or null
.Parameter.getParameterSets()
public ParameterSet getParameterSet(String name, boolean ignoreCase)
ParameterSet
with the specified 'Name' from the 'Parameter Set' reference list.
name
- The 'Name' of the ParameterSet
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.
ParameterSet
with the specified 'Name', or null
.Parameter.getParameterSets()
public Operation getOperation()
UMLPackage.getParameter_Operation()
public ParameterDirectionKind getDirection()
"in"
.
The literals are from the enumeration ParameterDirectionKind
.
Indicates whether a parameter is being sent into or out of a behavioral element.
ParameterDirectionKind
,
Parameter.setDirection(ParameterDirectionKind)
,
UMLPackage.getParameter_Direction()
public void setDirection(ParameterDirectionKind value)
Direction
' attribute.
value
- the new value of the 'Direction' attribute.ParameterDirectionKind
,
Parameter.getDirection()
public String getDefault()
Parameter.isSetDefault()
,
Parameter.unsetDefault()
,
Parameter.setDefault(String)
,
UMLPackage.getParameter_Default()
public void setDefault(String value)
Default
' attribute.
value
- the new value of the 'Default' attribute.Parameter.isSetDefault()
,
Parameter.unsetDefault()
,
Parameter.getDefault()
public void unsetDefault()
Default
' attribute.
Parameter.isSetDefault()
,
Parameter.getDefault()
,
Parameter.setDefault(String)
public boolean isSetDefault()
Default
' attribute is set.
Parameter.unsetDefault()
,
Parameter.getDefault()
,
Parameter.setDefault(String)
public ValueSpecification getDefaultValue()
Parameter.setDefaultValue(ValueSpecification)
,
UMLPackage.getParameter_DefaultValue()
public void setDefaultValue(ValueSpecification value)
Default Value
' containment reference.
value
- the new value of the 'Default Value' containment reference.Parameter.getDefaultValue()
public ValueSpecification createDefaultValue(String name, Type type, EClass eClass)
ValueSpecification
, with the specified 'Name', and 'Type', and sets the 'Default Value' containment reference.
name
- The 'Name' for the new ValueSpecification
, or null
.type
- The 'Type' for the new ValueSpecification
, or null
.eClass
- The Ecore class of the ValueSpecification
to create.
ValueSpecification
.Parameter.getDefaultValue()
public boolean isException()
"false"
.
Tells whether an output parameter may emit a value to the exclusion of the other outputs.
Parameter.setIsException(boolean)
,
UMLPackage.getParameter_IsException()
public void setIsException(boolean value)
Is Exception
' attribute.
value
- the new value of the 'Is Exception' attribute.Parameter.isException()
public boolean isStream()
"false"
.
Tells whether an input parameter may accept values while its behavior is executing, or whether an output parameter post values while the behavior is executing.
Parameter.setIsStream(boolean)
,
UMLPackage.getParameter_IsStream()
public void setIsStream(boolean value)
Is Stream
' attribute.
value
- the new value of the 'Is Stream' attribute.Parameter.isStream()
public ParameterEffectKind getEffect()
ParameterEffectKind
.
Specifies the effect that the owner of the parameter has on values passed in or out of the parameter.
ParameterEffectKind
,
Parameter.isSetEffect()
,
Parameter.unsetEffect()
,
Parameter.setEffect(ParameterEffectKind)
,
UMLPackage.getParameter_Effect()
public void setEffect(ParameterEffectKind value)
Effect
' attribute.
value
- the new value of the 'Effect' attribute.ParameterEffectKind
,
Parameter.isSetEffect()
,
Parameter.unsetEffect()
,
Parameter.getEffect()
public void unsetEffect()
Effect
' attribute.
Parameter.isSetEffect()
,
Parameter.getEffect()
,
Parameter.setEffect(ParameterEffectKind)
public boolean isSetEffect()
Effect
' attribute is set.
Parameter.unsetEffect()
,
Parameter.getEffect()
,
Parameter.setEffect(ParameterEffectKind)
public boolean validateConnectorEnd(DiagnosticChain diagnostics, Map context)
public boolean validateStreamAndException(DiagnosticChain diagnostics, Map context)
public boolean validateNotException(DiagnosticChain diagnostics, Map context)
public boolean validateReentrantBehaviors(DiagnosticChain diagnostics, Map context)
public boolean validateInAndOut(DiagnosticChain diagnostics, Map context)
public void setBooleanDefaultValue(boolean value)
public void setIntegerDefaultValue(int value)
public void setStringDefaultValue(String value)
public void setUnlimitedNaturalDefaultValue(int value)
public void setNullDefaultValue()
|
Copyright 2003, 2006 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |