org.eclipse.uml2
Interface Parameter

All Superinterfaces:
ConnectableElement, Element, EModelElement, EObject, MultiplicityElement, NamedElement, Notifier, ParameterableElement, TemplateableElement, TypedElement

public interface Parameter
extends ConnectableElement, TypedElement, MultiplicityElement

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:

See Also:
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

copyright

public static final String copyright

See Also:
Constant Field Values
Method Detail

getDefault

public String getDefault()
Returns the value of the 'Default' attribute. The default value is "".

If the meaning of the 'Default' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Default' attribute.
See Also:
UML2Package.getParameter_Default()

getDirection

public ParameterDirectionKind getDirection()
Returns the value of the 'Direction' attribute. The default value is "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.

Returns:
the value of the 'Direction' attribute.
See Also:
ParameterDirectionKind, setDirection(ParameterDirectionKind), UML2Package.getParameter_Direction()

setDirection

public void setDirection(ParameterDirectionKind value)
Sets the value of the 'Direction' attribute.

Parameters:
value - the new value of the 'Direction' attribute.
See Also:
ParameterDirectionKind, getDirection()

isException

public boolean isException()
Returns the value of the 'Is Exception' attribute. The default value is "false".

If the meaning of the 'Is Exception' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Exception' attribute.
See Also:
setIsException(boolean), UML2Package.getParameter_IsException()

setIsException

public void setIsException(boolean value)
Sets the value of the 'Is Exception' attribute.

Parameters:
value - the new value of the 'Is Exception' attribute.
See Also:
isException()

isStream

public boolean isStream()
Returns the value of the 'Is Stream' attribute. The default value is "false".

If the meaning of the 'Is Stream' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Stream' attribute.
See Also:
setIsStream(boolean), UML2Package.getParameter_IsStream()

setIsStream

public void setIsStream(boolean value)
Sets the value of the 'Is Stream' attribute.

Parameters:
value - the new value of the 'Is Stream' attribute.
See Also:
isStream()

getEffect

public ParameterEffectKind getEffect()
Returns the value of the 'Effect' attribute. The literals are from the enumeration ParameterEffectKind.

If the meaning of the 'Effect' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Effect' attribute.
See Also:
ParameterEffectKind, setEffect(ParameterEffectKind), UML2Package.getParameter_Effect()

setEffect

public void setEffect(ParameterEffectKind value)
Sets the value of the 'Effect' attribute.

Parameters:
value - the new value of the 'Effect' attribute.
See Also:
ParameterEffectKind, getEffect()

getOperation

public Operation getOperation()
Returns the value of the 'Operation' container reference. It is bidirectional and its opposite is '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.

Returns:
the value of the 'Operation' container reference.
See Also:
setOperation(Operation), UML2Package.getParameter_Operation(), Operation.getOwnedParameters()

setOperation

public void setOperation(Operation value)
Sets the value of the 'Operation' container reference.

Parameters:
value - the new value of the 'Operation' container reference.
See Also:
getOperation()

getDefaultValue

public ValueSpecification getDefaultValue()
Returns the value of the 'Default Value' containment reference.

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.

Returns:
the value of the 'Default Value' containment reference.
See Also:
setDefaultValue(ValueSpecification), UML2Package.getParameter_DefaultValue()

setDefaultValue

public void setDefaultValue(ValueSpecification value)
Sets the value of the 'Default Value' containment reference.

Parameters:
value - the new value of the 'Default Value' containment reference.
See Also:
getDefaultValue()

createDefaultValue

public ValueSpecification createDefaultValue(EClass eClass)
Creates a ValueSpecification and sets the 'Default Value' containment reference.

Parameters:
eClass - The Ecore class of the ValueSpecification to create.
Returns:
The new ValueSpecification.
See Also:
getDefaultValue()

getParameterSets

public EList getParameterSets()
Returns the value of the 'Parameter Set' reference list. The list contents are of type 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...

Returns:
the value of the 'Parameter Set' reference list.
See Also:
UML2Package.getParameter_ParameterSet(), ParameterSet.getParameters()

getParameterSet

public ParameterSet getParameterSet(String unqualifiedName)
Retrieves the ParameterSet with the specified name from the 'Parameter Set' reference list.

Parameters:
unqualifiedName - The unqualified name of the ParameterSet to retrieve.
Returns:
The ParameterSet with the specified name, or null.
See Also:
getParameterSets()

getNamespace

public Namespace getNamespace()

Specified by:
getNamespace in interface NamedElement

getOwnedElements

public EList getOwnedElements()

Specified by:
getOwnedElements in interface NamedElement

setBooleanDefault

public void setBooleanDefault(boolean value)
Sets the default to the specified boolean value.

Parameters:
value - The new value of the default.
See Also:
getDefault()

setIntegerDefault

public void setIntegerDefault(int value)
Sets the default to the specified integer value.

Parameters:
value - The new value of the default.
See Also:
getDefault()

setStringDefault

public void setStringDefault(String value)
Sets the default to the specified string value.

Parameters:
value - The new value of the default.
See Also:
getDefault()

setUnlimitedNaturalDefault

public void setUnlimitedNaturalDefault(int value)
Sets the default to the specified unlimited natural value.

Parameters:
value - The new value of the default.
See Also:
getDefault()

Copyright 2003, 2004 IBM Corporation and others.
All Rights Reserved.