|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface State
A representation of the model object 'State'. A State models a situation during which some (usually implicit) invariant condition holds.
From package UML::StateMachines.
The following features are supported:
Connection
Connection Point
Deferrable Trigger
Do Activity
Entry
Exit
Is Composite
Is Orthogonal
Is Simple
Is Submachine State
Redefined State
State Invariant
Submachine
Region
UMLPackage.getState()
Field Summary |
---|
Fields inherited from interface org.eclipse.uml2.uml.NamedElement |
---|
SEPARATOR |
Method Summary | |
---|---|
ConnectionPointReference |
createConnection(java.lang.String name)
Creates a new ConnectionPointReference , with the specified 'Name', and appends it to the 'Connection' containment reference list |
Pseudostate |
createConnectionPoint(java.lang.String name)
Creates a new Pseudostate , with the specified 'Name', and appends it to the 'Connection Point' containment reference list |
Trigger |
createDeferrableTrigger(java.lang.String name)
Creates a new Trigger , with the specified 'Name', and appends it to the 'Deferrable Trigger' containment reference list |
Behavior |
createDoActivity(java.lang.String name,
org.eclipse.emf.ecore.EClass eClass)
Creates a new Behavior , with the specified 'Name', and sets the 'Do Activity' containment reference |
Behavior |
createEntry(java.lang.String name,
org.eclipse.emf.ecore.EClass eClass)
Creates a new Behavior , with the specified 'Name', and sets the 'Entry' containment reference |
Behavior |
createExit(java.lang.String name,
org.eclipse.emf.ecore.EClass eClass)
Creates a new Behavior , with the specified 'Name', and sets the 'Exit' containment reference |
Region |
createRegion(java.lang.String name)
Creates a new Region , with the specified 'Name', and appends it to the 'Region' containment reference list |
Constraint |
createStateInvariant(java.lang.String name)
Creates a new Constraint ,with the specified 'Name', and sets the 'State Invariant' reference |
Constraint |
createStateInvariant(java.lang.String name,
org.eclipse.emf.ecore.EClass eClass)
Creates a new Constraint , with the specified 'Name', and sets the 'State Invariant' reference |
ConnectionPointReference |
getConnection(java.lang.String name)
Retrieves the first ConnectionPointReference with the specified 'Name' from the 'Connection' containment reference list |
ConnectionPointReference |
getConnection(java.lang.String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first ConnectionPointReference with the specified 'Name' from the 'Connection' containment reference list |
Pseudostate |
getConnectionPoint(java.lang.String name)
Retrieves the first Pseudostate with the specified 'Name' from the 'Connection Point' containment reference list |
Pseudostate |
getConnectionPoint(java.lang.String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first Pseudostate with the specified 'Name' from the 'Connection Point' containment reference list |
org.eclipse.emf.common.util.EList<Pseudostate> |
getConnectionPoints()
Returns the value of the 'Connection Point' containment reference list. |
org.eclipse.emf.common.util.EList<ConnectionPointReference> |
getConnections()
Returns the value of the 'Connection' containment reference list. |
Trigger |
getDeferrableTrigger(java.lang.String name)
Retrieves the first Trigger with the specified 'Name' from the 'Deferrable Trigger' containment reference list |
Trigger |
getDeferrableTrigger(java.lang.String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first Trigger with the specified 'Name' from the 'Deferrable Trigger' containment reference list |
org.eclipse.emf.common.util.EList<Trigger> |
getDeferrableTriggers()
Returns the value of the 'Deferrable Trigger' containment reference list. |
Behavior |
getDoActivity()
Returns the value of the 'Do Activity' containment reference. |
Behavior |
getEntry()
Returns the value of the 'Entry' containment reference. |
Behavior |
getExit()
Returns the value of the 'Exit' containment reference. |
State |
getRedefinedState()
Returns the value of the 'Redefined State' reference. |
Region |
getRegion(java.lang.String name)
Retrieves the first Region with the specified 'Name' from the 'Region' containment reference list |
Region |
getRegion(java.lang.String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first Region with the specified 'Name' from the 'Region' containment reference list |
org.eclipse.emf.common.util.EList<Region> |
getRegions()
Returns the value of the 'Region' containment reference list. |
Constraint |
getStateInvariant()
Returns the value of the 'State Invariant' reference. |
StateMachine |
getSubmachine()
Returns the value of the 'Submachine' reference. |
boolean |
isComposite()
Returns the value of the 'Is Composite' attribute |
boolean |
isOrthogonal()
Returns the value of the 'Is Orthogonal' attribute |
boolean |
isSimple()
Returns the value of the 'Is Simple' attribute. |
boolean |
isSubmachineState()
Returns the value of the 'Is Submachine State' attribute |
Classifier |
redefinitionContext()
The redefinition context of a State is the nearest containing StateMachine. |
void |
setDoActivity(Behavior value)
Sets the value of the ' Do Activity ' containment reference |
void |
setEntry(Behavior value)
Sets the value of the ' Entry ' containment reference |
void |
setExit(Behavior value)
Sets the value of the ' Exit ' containment reference |
void |
setRedefinedState(State value)
Sets the value of the ' Redefined State ' reference |
void |
setStateInvariant(Constraint value)
Sets the value of the ' State Invariant ' reference |
void |
setSubmachine(StateMachine value)
Sets the value of the ' Submachine ' reference |
boolean |
validateCompositeStates(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Only composite States can have entry or exit Pseudostates defined. |
boolean |
validateDestinationsOrSourcesOfTransitions(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
The connection point references used as destinations/sources of Transitions associated with a submachine State must be defined as entry/exit points in the submachine StateMachine. |
boolean |
validateEntryOrExit(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Only entry or exit Pseudostates can serve as connection points. |
boolean |
validateSubmachineOrRegions(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A State is not allowed to have both a submachine and Regions. |
boolean |
validateSubmachineStates(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Only submachine States can have connection point references. |
Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement |
---|
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateNonLeafRedefinition, validateRedefinitionConsistent, validateRedefinitionContextValid |
Methods inherited from interface org.eclipse.uml2.uml.Vertex |
---|
containingStateMachine, getContainer, getIncoming, getIncoming, getIncomings, getOutgoing, getOutgoing, getOutgoings, isContainedInRegion, isContainedInState, setContainer |
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.emf.ecore.EModelElement |
---|
getEAnnotation, getEAnnotations |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Method Detail |
---|
boolean isComposite()
From package UML::StateMachines.
UMLPackage.getState_IsComposite()
boolean isOrthogonal()
From package UML::StateMachines.
UMLPackage.getState_IsOrthogonal()
boolean isSimple()
"true"
.
A State with isSimple=true is said to be a simple State A simple State does not have any Regions and it does not refer to any submachine StateMachine.
From package UML::StateMachines.
UMLPackage.getState_IsSimple()
boolean isSubmachineState()
From package UML::StateMachines.
UMLPackage.getState_IsSubmachineState()
StateMachine getSubmachine()
Submachine State
'.
The StateMachine that is to be inserted in place of the (submachine) State.
From package UML::StateMachines.
setSubmachine(StateMachine)
,
UMLPackage.getState_Submachine()
,
StateMachine.getSubmachineStates()
void setSubmachine(StateMachine value)
Submachine
' reference.
value
- the new value of the 'Submachine' reference.getSubmachine()
org.eclipse.emf.common.util.EList<ConnectionPointReference> getConnections()
ConnectionPointReference
.
It is bidirectional and its opposite is 'State
'.
This feature subsets the following features:
The entry and exit connection points used in conjunction with this (submachine) State, i.e., as targets and sources, respectively, in the Region with the submachine State. A connection point reference references the corresponding definition of a connection point Pseudostate in the StateMachine referenced by the submachine State.From package UML::StateMachines.
UMLPackage.getState_Connection()
,
ConnectionPointReference.getState()
ConnectionPointReference createConnection(java.lang.String name)
ConnectionPointReference
, with the specified 'Name', and appends it to the 'Connection' containment reference list.
name
- The 'Name' for the new ConnectionPointReference
, or null
.
ConnectionPointReference
.getConnections()
ConnectionPointReference getConnection(java.lang.String name)
ConnectionPointReference
with the specified 'Name' from the 'Connection' containment reference list.
name
- The 'Name' of the ConnectionPointReference
to retrieve, or null
.
ConnectionPointReference
with the specified 'Name', or null
.getConnections()
ConnectionPointReference getConnection(java.lang.String name, boolean ignoreCase, boolean createOnDemand)
ConnectionPointReference
with the specified 'Name' from the 'Connection' containment reference list.
name
- The 'Name' of the ConnectionPointReference
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.createOnDemand
- Whether to create a ConnectionPointReference
on demand if not found.
ConnectionPointReference
with the specified 'Name', or null
.getConnections()
org.eclipse.emf.common.util.EList<Pseudostate> getConnectionPoints()
Pseudostate
.
It is bidirectional and its opposite is 'State
'.
This feature subsets the following features:
The entry and exit Pseudostates of a composite State. These can only be entry or exit Pseudostates, and they must have different names. They can only be defined for composite States.From package UML::StateMachines.
UMLPackage.getState_ConnectionPoint()
,
Pseudostate.getState()
Pseudostate createConnectionPoint(java.lang.String name)
Pseudostate
, with the specified 'Name', and appends it to the 'Connection Point' containment reference list.
name
- The 'Name' for the new Pseudostate
, or null
.
Pseudostate
.getConnectionPoints()
Pseudostate getConnectionPoint(java.lang.String name)
Pseudostate
with the specified 'Name' from the 'Connection Point' containment reference list.
name
- The 'Name' of the Pseudostate
to retrieve, or null
.
Pseudostate
with the specified 'Name', or null
.getConnectionPoints()
Pseudostate getConnectionPoint(java.lang.String name, boolean ignoreCase, boolean createOnDemand)
Pseudostate
with the specified 'Name' from the 'Connection Point' containment reference list.
name
- The 'Name' of the Pseudostate
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.createOnDemand
- Whether to create a Pseudostate
on demand if not found.
Pseudostate
with the specified 'Name', or null
.getConnectionPoints()
State getRedefinedState()
This feature subsets the following features:
The State of which this State is a redefinition.From package UML::StateMachines.
setRedefinedState(State)
,
UMLPackage.getState_RedefinedState()
void setRedefinedState(State value)
Redefined State
' reference.
value
- the new value of the 'Redefined State' reference.getRedefinedState()
Constraint getStateInvariant()
This feature subsets the following features:
Specifies conditions that are always true when this State is the current State. In ProtocolStateMachines state invariants are additional conditions to the preconditions of the outgoing Transitions, and to the postcondition of the incoming Transitions.From package UML::StateMachines.
setStateInvariant(Constraint)
,
UMLPackage.getState_StateInvariant()
void setStateInvariant(Constraint value)
State Invariant
' reference.
value
- the new value of the 'State Invariant' reference.getStateInvariant()
Constraint createStateInvariant(java.lang.String name, org.eclipse.emf.ecore.EClass eClass)
Constraint
, with the specified 'Name', and sets the 'State Invariant' reference.
name
- The 'Name' for the new Constraint
, or null
.eClass
- The Ecore class of the Constraint
to create.
Constraint
.getStateInvariant()
Constraint createStateInvariant(java.lang.String name)
Constraint
,with the specified 'Name', and sets the 'State Invariant' reference.
name
- The 'Name' for the new Constraint
, or null
.
Constraint
.getStateInvariant()
Behavior getEntry()
This feature subsets the following features:
An optional Behavior that is executed whenever this State is entered regardless of the Transition taken to reach the State. If defined, entry Behaviors are always executed to completion prior to any internal Behavior or Transitions performed within the State.From package UML::StateMachines.
setEntry(Behavior)
,
UMLPackage.getState_Entry()
void setEntry(Behavior value)
Entry
' containment reference.
value
- the new value of the 'Entry' containment reference.getEntry()
Behavior createEntry(java.lang.String name, org.eclipse.emf.ecore.EClass eClass)
Behavior
, with the specified 'Name', and sets the 'Entry' containment reference.
name
- The 'Name' for the new Behavior
, or null
.eClass
- The Ecore class of the Behavior
to create.
Behavior
.getEntry()
Behavior getExit()
This feature subsets the following features:
An optional Behavior that is executed whenever this State is exited regardless of which Transition was taken out of the State. If defined, exit Behaviors are always executed to completion only after all internal and transition Behaviors have completed execution.From package UML::StateMachines.
setExit(Behavior)
,
UMLPackage.getState_Exit()
void setExit(Behavior value)
Exit
' containment reference.
value
- the new value of the 'Exit' containment reference.getExit()
Behavior createExit(java.lang.String name, org.eclipse.emf.ecore.EClass eClass)
Behavior
, with the specified 'Name', and sets the 'Exit' containment reference.
name
- The 'Name' for the new Behavior
, or null
.eClass
- The Ecore class of the Behavior
to create.
Behavior
.getExit()
Behavior getDoActivity()
This feature subsets the following features:
An optional Behavior that is executed while being in the State. The execution starts when this State is entered, and ceases either by itself when done, or when the State is exited, whichever comes first.From package UML::StateMachines.
setDoActivity(Behavior)
,
UMLPackage.getState_DoActivity()
void setDoActivity(Behavior value)
Do Activity
' containment reference.
value
- the new value of the 'Do Activity' containment reference.getDoActivity()
Behavior createDoActivity(java.lang.String name, org.eclipse.emf.ecore.EClass eClass)
Behavior
, with the specified 'Name', and sets the 'Do Activity' containment reference.
name
- The 'Name' for the new Behavior
, or null
.eClass
- The Ecore class of the Behavior
to create.
Behavior
.getDoActivity()
org.eclipse.emf.common.util.EList<Trigger> getDeferrableTriggers()
Trigger
.
This feature subsets the following features:
A list of Triggers that are candidates to be retained by the StateMachine if they trigger no Transitions out of the State (not consumed). A deferred Trigger is retained until the StateMachine reaches a State configuration where it is no longer deferred.From package UML::StateMachines.
UMLPackage.getState_DeferrableTrigger()
Trigger createDeferrableTrigger(java.lang.String name)
Trigger
, with the specified 'Name', and appends it to the 'Deferrable Trigger' containment reference list.
name
- The 'Name' for the new Trigger
, or null
.
Trigger
.getDeferrableTriggers()
Trigger getDeferrableTrigger(java.lang.String name)
Trigger
with the specified 'Name' from the 'Deferrable Trigger' containment reference list.
name
- The 'Name' of the Trigger
to retrieve, or null
.
Trigger
with the specified 'Name', or null
.getDeferrableTriggers()
Trigger getDeferrableTrigger(java.lang.String name, boolean ignoreCase, boolean createOnDemand)
Trigger
with the specified 'Name' from the 'Deferrable Trigger' containment reference list.
name
- The 'Name' of the Trigger
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.createOnDemand
- Whether to create a Trigger
on demand if not found.
Trigger
with the specified 'Name', or null
.getDeferrableTriggers()
org.eclipse.emf.common.util.EList<Region> getRegions()
Region
.
It is bidirectional and its opposite is 'State
'.
This feature subsets the following features:
The Regions owned directly by the State.From package UML::StateMachines.
UMLPackage.getState_Region()
,
Region.getState()
Region createRegion(java.lang.String name)
Region
, with the specified 'Name', and appends it to the 'Region' containment reference list.
name
- The 'Name' for the new Region
, or null
.
Region
.getRegions()
Region getRegion(java.lang.String name)
Region
with the specified 'Name' from the 'Region' containment reference list.
name
- The 'Name' of the Region
to retrieve, or null
.
Region
with the specified 'Name', or null
.getRegions()
Region getRegion(java.lang.String name, boolean ignoreCase, boolean createOnDemand)
Region
with the specified 'Name' from the 'Region' containment reference list.
name
- The 'Name' of the Region
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.createOnDemand
- Whether to create a Region
on demand if not found.
Region
with the specified 'Name', or null
.getRegions()
boolean validateSubmachineStates(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 validateDestinationsOrSourcesOfTransitions(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 validateSubmachineOrRegions(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 validateCompositeStates(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 validateEntryOrExit(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.
Classifier redefinitionContext()
From package UML::StateMachines.
|
Copyright 2003, 2014 IBM Corporation, CEA, and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |