public interface Parameter extends ConnectableElement, MultiplicityElement
From package UML::Classification.
The following features are supported:
UMLPackage.getParameter()
SEPARATOR
Modifier and Type | Method and Description |
---|---|
ValueSpecification |
createDefaultValue(java.lang.String name,
Type type,
org.eclipse.emf.ecore.EClass eClass)
Creates a new
ValueSpecification , with the specified 'Name', and 'Type', and sets the 'Default Value' containment reference |
java.lang.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(java.lang.String name)
Retrieves the first
ParameterSet with the specified 'Name' from the 'Parameter Set' reference list |
ParameterSet |
getParameterSet(java.lang.String name,
boolean ignoreCase)
Retrieves the first
ParameterSet with the specified 'Name' from the 'Parameter Set' reference list |
org.eclipse.emf.common.util.EList<ParameterSet> |
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(java.lang.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 |
setRealDefaultValue(double value)
Sets the default value for this parameter to the specified real value.
|
void |
setStringDefaultValue(java.lang.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(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A Parameter may only be associated with a Connector end within the context of a Collaboration.
|
boolean |
validateInAndOut(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Only in and inout Parameters may have a delete effect.
|
boolean |
validateNotException(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
An input Parameter cannot be an exception.
|
boolean |
validateObjectEffect(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Parameters typed by DataTypes cannot have an effect.
|
boolean |
validateReentrantBehaviors(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Reentrant behaviors cannot have stream Parameters.
|
boolean |
validateStreamAndException(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A Parameter cannot be a stream and exception at the same time.
|
getEnds
getType, setType
allNamespaces, allOwningPackages, createDependency, createNameExpression, createUsage, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership
addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, validateHasOwner, validateNotOwnSelf
getEAnnotation, getEAnnotations
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
eAdapters, eDeliver, eNotify, eSetDeliver
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter
compatibleWith, createLowerValue, createUpperValue, getLower, getLowerValue, getUpper, getUpperValue, includesMultiplicity, is, isMultivalued, isOrdered, isUnique, lowerBound, setIsOrdered, setIsUnique, setLower, setLowerValue, setUpper, setUpperValue, upperBound, validateLowerGe0, validateLowerIsInteger, validateUpperGeLower, validateUpperIsUnlimitedNatural, validateValueSpecificationConstant, validateValueSpecificationNoSideEffects
org.eclipse.emf.common.util.EList<ParameterSet> getParameterSets()
ParameterSet
.
It is bidirectional and its opposite is 'Parameter
'.
The ParameterSets containing the parameter. See ParameterSet.
From package UML::Classification.
UMLPackage.getParameter_ParameterSet()
,
ParameterSet.getParameters()
ParameterSet getParameterSet(java.lang.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
.getParameterSets()
ParameterSet getParameterSet(java.lang.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
.getParameterSets()
Operation getOperation()
This feature subsets the following features:
The Operation owning this parameter.From package UML::Classification.
UMLPackage.getParameter_Operation()
ParameterDirectionKind getDirection()
"in"
.
The literals are from the enumeration ParameterDirectionKind
.
Indicates whether a parameter is being sent into or out of a behavioral element.
From package UML::Classification.
ParameterDirectionKind
,
setDirection(ParameterDirectionKind)
,
UMLPackage.getParameter_Direction()
void setDirection(ParameterDirectionKind value)
Direction
' attribute.
value
- the new value of the 'Direction' attribute.ParameterDirectionKind
,
getDirection()
java.lang.String getDefault()
From package UML::Classification.
isSetDefault()
,
unsetDefault()
,
setDefault(String)
,
UMLPackage.getParameter_Default()
void setDefault(java.lang.String value)
Default
' attribute.
value
- the new value of the 'Default' attribute.isSetDefault()
,
unsetDefault()
,
getDefault()
void unsetDefault()
Default
' attribute.
isSetDefault()
,
getDefault()
,
setDefault(String)
boolean isSetDefault()
Default
' attribute is set.
unsetDefault()
,
getDefault()
,
setDefault(String)
ValueSpecification getDefaultValue()
This feature subsets the following features:
Specifies a ValueSpecification that represents a value to be used when no argument is supplied for the Parameter.From package UML::Classification.
setDefaultValue(ValueSpecification)
,
UMLPackage.getParameter_DefaultValue()
void setDefaultValue(ValueSpecification value)
Default Value
' containment reference.
value
- the new value of the 'Default Value' containment reference.getDefaultValue()
ValueSpecification createDefaultValue(java.lang.String name, Type type, org.eclipse.emf.ecore.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
.getDefaultValue()
boolean isException()
"false"
.
Tells whether an output parameter may emit a value to the exclusion of the other outputs.
From package UML::Classification.
setIsException(boolean)
,
UMLPackage.getParameter_IsException()
void setIsException(boolean value)
Is Exception
' attribute.
value
- the new value of the 'Is Exception' attribute.isException()
boolean isStream()
"false"
.
Tells whether an input parameter may accept values while its behavior is executing, or whether an output parameter may post values while the behavior is executing.
From package UML::Classification.
setIsStream(boolean)
,
UMLPackage.getParameter_IsStream()
void setIsStream(boolean value)
Is Stream
' attribute.
value
- the new value of the 'Is Stream' attribute.isStream()
ParameterEffectKind getEffect()
ParameterEffectKind
.
Specifies the effect that executions of the owner of the Parameter have on objects passed in or out of the parameter.
From package UML::Classification.
ParameterEffectKind
,
isSetEffect()
,
unsetEffect()
,
setEffect(ParameterEffectKind)
,
UMLPackage.getParameter_Effect()
void setEffect(ParameterEffectKind value)
Effect
' attribute.
value
- the new value of the 'Effect' attribute.ParameterEffectKind
,
isSetEffect()
,
unsetEffect()
,
getEffect()
void unsetEffect()
Effect
' attribute.
isSetEffect()
,
getEffect()
,
setEffect(ParameterEffectKind)
boolean isSetEffect()
Effect
' attribute is set.
unsetEffect()
,
getEffect()
,
setEffect(ParameterEffectKind)
boolean validateConnectorEnd(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateStreamAndException(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateObjectEffect(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateNotException(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateReentrantBehaviors(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateInAndOut(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
void setBooleanDefaultValue(boolean value)
value
- The new default value.
void setIntegerDefaultValue(int value)
value
- The new default value.
void setStringDefaultValue(java.lang.String value)
value
- The new default value.
void setUnlimitedNaturalDefaultValue(int value)
value
- The new default value.
void setNullDefaultValue()
void setRealDefaultValue(double value)
value
- The new default value.