Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


org.eclipse.uml2.uml
Interface Parameter

All Superinterfaces:
ConnectableElement, Element, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, MultiplicityElement, NamedElement, org.eclipse.emf.common.notify.Notifier, ParameterableElement, TypedElement

public interface Parameter
extends ConnectableElement, 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. Parameters are allowed to be treated as connectable elements. Parameters have support for streaming, exceptions, and parameter sets.

The following features are supported:

See Also:
UMLPackage.getParameter()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml. NamedElement
SEPARATOR
 
Method Summary
  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 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 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.
 
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, createUsage, 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.uml2.uml. Element
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
 
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, validateValueSpecificationConstant, validateValueSpecificationNoSideEffects
 

Method Detail

getParameterSets

org.eclipse.emf.common.util.EList<
ParameterSet> 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'. The parameter sets containing the parameter. See ParameterSet.

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

getParameterSet

ParameterSet getParameterSet(java.lang.String name)
Retrieves the first ParameterSet with the specified ' Name ' from the ' Parameter Set ' reference list.

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

getParameterSet

ParameterSet getParameterSet(java.lang.String name,
                             boolean ignoreCase)
Retrieves the first ParameterSet with the specified ' Name ' from the ' Parameter Set ' reference list.

Parameters:
name - The ' Name ' of the ParameterSet to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
Returns:
The first ParameterSet with the specified ' Name ', or null.
See Also:
getParameterSets()

getOperation

Operation getOperation()
Returns the value of the ' Operation ' reference.

This feature subsets the following features:

References the Operation owning this parameter.

Returns:
the value of the 'Operation' reference.
See Also:
UMLPackage.getParameter_Operation()

getDirection

ParameterDirectionKind getDirection()
Returns the value of the ' Direction ' attribute. The default value is "in". The literals are from the enumeration ParameterDirectionKind. Indicates whether a parameter is being sent into or out of a behavioral element.

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

setDirection

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

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

getDefault

java.lang.String getDefault()
Returns the value of the ' Default ' attribute. Specifies a String that represents a value to be used when no argument is supplied for the Parameter.

Returns:
the value of the 'Default' attribute.
See Also:
isSetDefault(), unsetDefault(), setDefault(String), UMLPackage.getParameter_Default()

setDefault

void setDefault(java.lang.String value)
Sets the value of the ' Default' attribute.

Parameters:
value - the new value of the 'Default' attribute.
See Also:
isSetDefault(), unsetDefault(), getDefault()

unsetDefault

void unsetDefault()
Unsets the value of the ' Default' attribute.

See Also:
isSetDefault(), getDefault(), setDefault(String)

isSetDefault

boolean isSetDefault()
Returns whether the value of the ' Default' attribute is set.

Returns:
whether the value of the 'Default' attribute is set.
See Also:
unsetDefault(), getDefault(), setDefault(String)

getDefaultValue

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

This feature subsets the following features:

Specifies a ValueSpecification that represents a value to be used when no argument is supplied for the Parameter.

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

setDefaultValue

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

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.

Parameters:
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.
Returns:
The new ValueSpecification.
See Also:
getDefaultValue()

isException

boolean isException()
Returns the value of the ' Is Exception ' attribute. The default value is "false". Tells whether an output parameter may emit a value to the exclusion of the other outputs.

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

setIsException

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

boolean isStream()
Returns the value of the ' Is Stream ' attribute. The default value is "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.

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

setIsStream

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

ParameterEffectKind getEffect()
Returns the value of the ' Effect ' attribute. The literals are from the enumeration ParameterEffectKind. Specifies the effect that the owner of the parameter has on values passed in or out of the parameter.

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

setEffect

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

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

unsetEffect

void unsetEffect()
Unsets the value of the ' Effect' attribute.

See Also:
isSetEffect(), getEffect(), setEffect(ParameterEffectKind)

isSetEffect

boolean isSetEffect()
Returns whether the value of the ' Effect' attribute is set.

Returns:
whether the value of the 'Effect' attribute is set.
See Also:
unsetEffect(), getEffect(), setEffect(ParameterEffectKind)

validateConnectorEnd

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. self.end.notEmpty() implies self.collaboration.notEmpty()

Parameters:
diagnostics - The chain of diagnostics to which problems are to be appended.
context - The cache of context-specific information.

validateStreamAndException

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. true

Parameters:
diagnostics - The chain of diagnostics to which problems are to be appended.
context - The cache of context-specific information.

validateNotException

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. true

Parameters:
diagnostics - The chain of diagnostics to which problems are to be appended.
context - The cache of context-specific information.

validateReentrantBehaviors

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. true

Parameters:
diagnostics - The chain of diagnostics to which problems are to be appended.
context - The cache of context-specific information.

validateInAndOut

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. Only out, inout, and return parameters may have a create effect. true

Parameters:
diagnostics - The chain of diagnostics to which problems are to be appended.
context - The cache of context-specific information.

setBooleanDefaultValue

void setBooleanDefaultValue(boolean value)
Sets the default value for this parameter to the specified Boolean value.

Parameters:
value - The new default value.

setIntegerDefaultValue

void setIntegerDefaultValue(int value)
Sets the default value for this parameter to the specified integer value.

Parameters:
value - The new default value.

setStringDefaultValue

void setStringDefaultValue(java.lang.String value)
Sets the default value for this parameter to the specified string value.

Parameters:
value - The new default value.

setUnlimitedNaturalDefaultValue

void setUnlimitedNaturalDefaultValue(int value)
Sets the default value for this parameter to the specified unlimited natural value.

Parameters:
value - The new default value.

setNullDefaultValue

void setNullDefaultValue()
Sets the default value for this parameter to the null value.


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


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire