org.eclipse.uml2
Interface LoopNode

All Superinterfaces:
Action, ActivityGroup, ActivityNode, Element, EModelElement, EObject, ExecutableNode, NamedElement, Namespace, Notifier, RedefinableElement, StructuredActivityNode, TemplateableElement

public interface LoopNode
extends StructuredActivityNode

A representation of the model object 'Loop Node'.

The following features are supported:

See Also:
UML2Package.getLoopNode()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 OutputPin createLoopVariable()
          Creates a OutputPin and appends it to the 'Loop Variable' containment reference list
 OutputPin createLoopVariable(EClass eClass)
          Deprecated. Use #createLoopVariable() instead.
 InputPin createLoopVariableInput()
          Creates a InputPin and appends it to the 'Loop Variable Input' containment reference list
 InputPin createLoopVariableInput(EClass eClass)
          Creates a InputPin and appends it to the 'Loop Variable Input' containment reference list
 OutputPin createResult()
          Creates a OutputPin and appends it to the 'Result' containment reference list
 OutputPin createResult(EClass eClass)
          Deprecated. Use #createResult() instead.
 OutputPin getBodyOutput(java.lang.String name)
          Retrieves the OutputPin with the specified 'Name' from the 'Body Output' reference list
 EList getBodyOutputs()
          Returns the value of the 'Body Output' reference list.
 ActivityNode getBodyPart(java.lang.String name)
          Retrieves the ActivityNode with the specified 'Name' from the 'Body Part' reference list
 EList getBodyParts()
          Returns the value of the 'Body Part' reference list.
 OutputPin getDecider()
          Returns the value of the 'Decider' reference
 OutputPin getLoopVariable(java.lang.String name)
          Retrieves the OutputPin with the specified 'Name' from the 'Loop Variable' containment reference list
 InputPin getLoopVariableInput(java.lang.String name)
          Retrieves the InputPin with the specified 'Name' from the 'Loop Variable Input' containment reference list
 EList getLoopVariableInputs()
          Returns the value of the 'Loop Variable Input' containment reference list.
 EList getLoopVariables()
          Returns the value of the 'Loop Variable' containment reference list.
 OutputPin getResult(java.lang.String name)
          Retrieves the OutputPin with the specified 'Name' from the 'Result' containment reference list
 EList getResults()
          Returns the value of the 'Result' containment reference list.
 ActivityNode getSetupPart(java.lang.String name)
          Retrieves the ActivityNode with the specified 'Name' from the 'Setup Part' reference list
 EList getSetupParts()
          Returns the value of the 'Setup Part' reference list.
 ActivityNode getTest(java.lang.String name)
          Retrieves the ActivityNode with the specified 'Name' from the 'Test' reference list
 EList getTests()
          Returns the value of the 'Test' reference list.
 boolean isTestedFirst()
          Returns the value of the 'Is Tested First' attribute
 void setDecider(OutputPin value)
          Sets the value of the 'Decider' reference
 void setIsTestedFirst(boolean value)
          Sets the value of the 'Is Tested First' attribute
 
Methods inherited from interface org.eclipse.uml2.StructuredActivityNode
createContainedEdge, createContainedNode, createVariable, createVariable, getContainedEdge, getContainedEdges, getContainedNode, getContainedNodes, getVariable, getVariables, isMustIsolate, setMustIsolate
 
Methods inherited from interface org.eclipse.uml2.Action
createLocalPostcondition, createLocalPostcondition, createLocalPrecondition, createLocalPrecondition, getContext, getEffect, getInput, getInputs, getLocalPostcondition, getLocalPostconditions, getLocalPrecondition, getLocalPreconditions, getOutput, getOutputs, setEffect
 
Methods inherited from interface org.eclipse.uml2.ExecutableNode
createHandler, createHandler, getHandlers
 
Methods inherited from interface org.eclipse.uml2.ActivityNode
getActivity, getIncoming, getIncomings, getInGroups, getInInterruptibleRegions, getInPartition, getInPartitions, getInStructuredNode, getOutgoing, getOutgoings, getRedefinedElement, getRedefinedElements, setActivity, setInStructuredNode
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createDependency, createNameExpression, createNameExpression, getClientDependencies, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getValue, hasKeyword, hasValue, 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.Namespace
createElementImport, createElementImport, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMembers, getNamesOfMember, getOwnedMember, getOwnedMembers, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable
 
Methods inherited from interface org.eclipse.uml2.ActivityGroup
getActivity, getActivityGroup_activity, getSubgroups, getSuperGroup, setActivity, setActivityGroup_activity
 

Field Detail

copyright

public static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

isTestedFirst

public boolean isTestedFirst()
Returns the value of the 'Is Tested First' attribute.

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

Returns:
the value of the 'Is Tested First' attribute.
See Also:
setIsTestedFirst(boolean), UML2Package.getLoopNode_IsTestedFirst()

setIsTestedFirst

public void setIsTestedFirst(boolean value)
Sets the value of the 'Is Tested First' attribute.

Parameters:
value - the new value of the 'Is Tested First' attribute.
See Also:
isTestedFirst()

getBodyParts

public EList getBodyParts()
Returns the value of the 'Body Part' reference list. The list contents are of type ActivityNode.

If the meaning of the 'Body Part' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Body Part' reference list.
See Also:
UML2Package.getLoopNode_BodyPart()

getBodyPart

public ActivityNode getBodyPart(java.lang.String name)
Retrieves the ActivityNode with the specified 'Name' from the 'Body Part' reference list.

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

getSetupParts

public EList getSetupParts()
Returns the value of the 'Setup Part' reference list. The list contents are of type ActivityNode.

If the meaning of the 'Setup Part' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Setup Part' reference list.
See Also:
UML2Package.getLoopNode_SetupPart()

getSetupPart

public ActivityNode getSetupPart(java.lang.String name)
Retrieves the ActivityNode with the specified 'Name' from the 'Setup Part' reference list.

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

getDecider

public OutputPin getDecider()
Returns the value of the 'Decider' reference.

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

Returns:
the value of the 'Decider' reference.
See Also:
setDecider(OutputPin), UML2Package.getLoopNode_Decider()

setDecider

public void setDecider(OutputPin value)
Sets the value of the 'Decider' reference.

Parameters:
value - the new value of the 'Decider' reference.
See Also:
getDecider()

getTests

public EList getTests()
Returns the value of the 'Test' reference list. The list contents are of type ActivityNode.

If the meaning of the 'Test' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Test' reference list.
See Also:
UML2Package.getLoopNode_Test()

getTest

public ActivityNode getTest(java.lang.String name)
Retrieves the ActivityNode with the specified 'Name' from the 'Test' reference list.

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

getResults

public EList getResults()
Returns the value of the 'Result' containment reference list. The list contents are of type OutputPin.

If the meaning of the 'Result' containment reference list isn't clear, there really should be more of a description here...

A list of output pins that constitute the data flow output of the entire loop.

Returns:
the value of the 'Result' containment reference list.
See Also:
UML2Package.getLoopNode_Result()

getResult

public OutputPin getResult(java.lang.String name)
Retrieves the OutputPin with the specified 'Name' from the 'Result' containment reference list.

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

createResult

public OutputPin createResult(EClass eClass)
Deprecated. Use #createResult() instead.

Creates a OutputPin and appends it to the 'Result' containment reference list.

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

createResult

public OutputPin createResult()
Creates a OutputPin and appends it to the 'Result' containment reference list.

Returns:
The new OutputPin.
See Also:
getResults()

getLoopVariables

public EList getLoopVariables()
Returns the value of the 'Loop Variable' containment reference list. The list contents are of type OutputPin.

If the meaning of the 'Loop Variable' containment reference list isn't clear, there really should be more of a description here...

A list of output pins owned by the loop that hold the values of the loop variables during an execution of the loop. When the test fails, the values are copied to the result pins of the loop.

Returns:
the value of the 'Loop Variable' containment reference list.
See Also:
UML2Package.getLoopNode_LoopVariable()

getLoopVariable

public OutputPin getLoopVariable(java.lang.String name)
Retrieves the OutputPin with the specified 'Name' from the 'Loop Variable' containment reference list.

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

createLoopVariable

public OutputPin createLoopVariable(EClass eClass)
Deprecated. Use #createLoopVariable() instead.

Creates a OutputPin and appends it to the 'Loop Variable' containment reference list.

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

createLoopVariable

public OutputPin createLoopVariable()
Creates a OutputPin and appends it to the 'Loop Variable' containment reference list.

Returns:
The new OutputPin.
See Also:
getLoopVariables()

getBodyOutputs

public EList getBodyOutputs()
Returns the value of the 'Body Output' reference list. The list contents are of type OutputPin.

If the meaning of the 'Body Output' reference list isn't clear, there really should be more of a description here...

A list of output pins within the body fragment the values of which are copied to the loop variable pins after completion of execution of the body, before the next iteration of the loop begins or before the loop exits.

Returns:
the value of the 'Body Output' reference list.
See Also:
UML2Package.getLoopNode_BodyOutput()

getBodyOutput

public OutputPin getBodyOutput(java.lang.String name)
Retrieves the OutputPin with the specified 'Name' from the 'Body Output' reference list.

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

getLoopVariableInputs

public EList getLoopVariableInputs()
Returns the value of the 'Loop Variable Input' containment reference list. The list contents are of type InputPin.

If the meaning of the 'Loop Variable Input' containment reference list isn't clear, there really should be more of a description here...

A list of values that are copied into the loop variable pins before the first iteration of the loop.

Returns:
the value of the 'Loop Variable Input' containment reference list.
See Also:
UML2Package.getLoopNode_LoopVariableInput()

getLoopVariableInput

public InputPin getLoopVariableInput(java.lang.String name)
Retrieves the InputPin with the specified 'Name' from the 'Loop Variable Input' containment reference list.

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

createLoopVariableInput

public InputPin createLoopVariableInput(EClass eClass)
Creates a InputPin and appends it to the 'Loop Variable Input' containment reference list.

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

createLoopVariableInput

public InputPin createLoopVariableInput()
Creates a InputPin and appends it to the 'Loop Variable Input' containment reference list.

Returns:
The new InputPin.
See Also:
getLoopVariableInputs()

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