org.eclipse.uml2
Interface Transition

All Superinterfaces:

Element, EModelElement, EObject, NamedElement, Notifier, RedefinableElement, TemplateableElement

All Known Subinterfaces:

ProtocolTransition

public interface Transition

extends RedefinableElement

A representation of the model object 'Transition'.

The following features are supported:

• Kind
• Container
• Source
• Target
• Redefined Transition
• Trigger
• Guard
• Effect

See Also:

UML2Package.getTransition()

Field Summary

static java.lang.String

copyright

Fields inherited from interface org.eclipse.uml2.NamedElement

SEPARATOR

Method Summary

Activity	createEffect() Creates a Activity and sets the 'Effect' containment reference
Activity	createEffect(EClass eClass) Deprecated. Use #createEffect() instead.
Constraint	createGuard() Creates a Constraint and sets the 'Guard' containment reference
Constraint	createGuard(EClass eClass) Creates a Constraint and sets the 'Guard' containment reference
Region	getContainer() Returns the value of the 'Container' container reference.
Activity	getEffect() Returns the value of the 'Effect' containment reference
Constraint	getGuard() Returns the value of the 'Guard' containment reference
TransitionKind	getKind() Returns the value of the 'Kind' attribute.
RedefinableElement	getRedefinedElement(java.lang.String name) Retrieves the RedefinableElement with the specified 'Name' from the 'Redefined Element' reference list
EList	getRedefinedElements() Returns the value of the 'Redefined Element' reference list.
Transition	getRedefinedTransition() Returns the value of the 'Redefined Transition' reference
Vertex	getSource() Returns the value of the 'Source' reference.
Vertex	getTarget() Returns the value of the 'Target' reference.
Trigger	getTrigger(java.lang.String name) Retrieves the Trigger with the specified 'Name' from the 'Trigger' reference list
EList	getTriggers() Returns the value of the 'Trigger' reference list.
void	setContainer(Region value) Sets the value of the 'Container' container reference
void	setEffect(Activity value) Sets the value of the 'Effect' containment reference
void	setGuard(Constraint value) Sets the value of the 'Guard' containment reference
void	setKind(TransitionKind value) Sets the value of the 'Kind' attribute
void	setRedefinedTransition(Transition value) Sets the value of the 'Redefined Transition' reference
void	setSource(Vertex value) Sets the value of the 'Source' reference
void	setTarget(Vertex value) Sets the value of the 'Target' reference

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

Field Detail

copyright

public static final java.lang.String copyright

See Also:

Constant Field Values

Method Detail

getKind

public TransitionKind getKind()

Returns the value of the 'Kind' attribute. The literals are from the enumeration TransitionKind.

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

See definition of TransitionKind.

Returns:

the value of the 'Kind' attribute.

See Also:

TransitionKind, setKind(TransitionKind), UML2Package.getTransition_Kind()

setKind

public void setKind(TransitionKind value)

Sets the value of the 'Kind' attribute.

Parameters:

value - the new value of the 'Kind' attribute.

See Also:

TransitionKind, getKind()

getContainer

public Region getContainer()

Returns the value of the 'Container' container reference. It is bidirectional and its opposite is 'Transition'.

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

Returns:

the value of the 'Container' container reference.

See Also:

setContainer(Region), UML2Package.getTransition_Container(), Region.getTransitions()

setContainer

public void setContainer(Region value)

Sets the value of the 'Container' container reference.

Parameters:

value - the new value of the 'Container' container reference.

See Also:

getContainer()

getSource

public Vertex getSource()

Returns the value of the 'Source' reference. It is bidirectional and its opposite is 'Outgoing'.

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

Designates the originating vertex (state or pseudostate) of the transition.

Returns:

the value of the 'Source' reference.

See Also:

setSource(Vertex), UML2Package.getTransition_Source(), Vertex.getOutgoings()

setSource

public void setSource(Vertex value)

Sets the value of the 'Source' reference.

Parameters:

value - the new value of the 'Source' reference.

See Also:

getSource()

getTarget

public Vertex getTarget()

Returns the value of the 'Target' reference. It is bidirectional and its opposite is 'Incoming'.

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

Designates the target vertex that is reached when the transition is taken.

Returns:

the value of the 'Target' reference.

See Also:

setTarget(Vertex), UML2Package.getTransition_Target(), Vertex.getIncomings()

setTarget

public void setTarget(Vertex value)

Sets the value of the 'Target' reference.

Parameters:

value - the new value of the 'Target' reference.

See Also:

getTarget()

getRedefinedTransition

public Transition getRedefinedTransition()

Returns the value of the 'Redefined Transition' reference.

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

Returns:

the value of the 'Redefined Transition' reference.

See Also:

setRedefinedTransition(Transition), UML2Package.getTransition_RedefinedTransition()

setRedefinedTransition

public void setRedefinedTransition(Transition value)

Sets the value of the 'Redefined Transition' reference.

Parameters:

value - the new value of the 'Redefined Transition' reference.

See Also:

getRedefinedTransition()

getTriggers

public EList getTriggers()

Returns the value of the 'Trigger' reference list. The list contents are of type Trigger.

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

Specifies the triggers that may fire the transition.

Returns:

the value of the 'Trigger' reference list.

See Also:

UML2Package.getTransition_Trigger()

getTrigger

public Trigger getTrigger(java.lang.String name)

Retrieves the Trigger with the specified 'Name' from the 'Trigger' reference list.

Parameters:

name - The 'Name' of the Trigger to retrieve.

Returns:

The Trigger with the specified 'Name', or null.

See Also:

getTriggers()

getGuard

public Constraint getGuard()

Returns the value of the 'Guard' containment reference.

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

A guard is a constraint that provides a fine-grained control over the firing of the transition. The guard is evaluated when an event is dispatched by the state machine. If the guard is true at that time, the transition may be enabled, otherwise, it is disabled. Guards should be pure expressions without side effects. Guard expressions with side effects are ill formed.

Returns:

the value of the 'Guard' containment reference.

See Also:

setGuard(Constraint), UML2Package.getTransition_Guard()

setGuard

public void setGuard(Constraint value)

Sets the value of the 'Guard' containment reference.

Parameters:

value - the new value of the 'Guard' containment reference.

See Also:

getGuard()

createGuard

public Constraint createGuard(EClass eClass)

Creates a Constraint and sets the 'Guard' containment reference.

Parameters:

eClass - The Ecore class of the Constraint to create.

Returns:

The new Constraint.

See Also:

getGuard()

createGuard

public Constraint createGuard()

Creates a Constraint and sets the 'Guard' containment reference.

Returns:

The new Constraint.

See Also:

getGuard()

getEffect

public Activity getEffect()

Returns the value of the 'Effect' containment reference.

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

Specifies an optional activity to be performed when the transition fires.

Returns:

the value of the 'Effect' containment reference.

See Also:

setEffect(Activity), UML2Package.getTransition_Effect()

setEffect

public void setEffect(Activity value)

Sets the value of the 'Effect' containment reference.

Parameters:

value - the new value of the 'Effect' containment reference.

See Also:

getEffect()

createEffect

public Activity createEffect(EClass eClass)

Deprecated. Use #createEffect() instead.

Creates a Activity and sets the 'Effect' containment reference.

Parameters:

eClass - The Ecore class of the Activity to create.

Returns:

The new Activity.

See Also:

getEffect()

createEffect

public Activity createEffect()

Creates a Activity and sets the 'Effect' containment reference.

Returns:

The new Activity.

See Also:

getEffect()

getRedefinedElements

public EList getRedefinedElements()

Returns the value of the 'Redefined Element' reference list. The list contents are of type RedefinableElement. redefinable element that is being redefined by this element. This is a derived union.

Specified by:

getRedefinedElements in interface RedefinableElement

Returns:

the value of the 'Redefined Element' reference list.

See Also:

org.eclipse.uml2.UML2Package#getRedefinableElement_RedefinedElement()

getRedefinedElement

public RedefinableElement getRedefinedElement(java.lang.String name)

Retrieves the RedefinableElement with the specified 'Name' from the 'Redefined Element' reference list.

Specified by:

getRedefinedElement in interface RedefinableElement

Parameters:

name - The 'Name' of the RedefinableElement to retrieve.

Returns:

The RedefinableElement with the specified 'Name', or null.

See Also:

getRedefinedElements()