public interface State extends Namespace, RedefinableElement, Vertex
The following features are supported:
UMLPackage.getState()
SEPARATOR
Modifier and Type | Method and Description |
---|---|
ConnectionPointReference |
createConnection(String name)
Creates a new
ConnectionPointReference , with the specified 'Name', and appends it to the
'Connection' containment reference list |
Pseudostate |
createConnectionPoint(String name)
Creates a new
Pseudostate , with the specified 'Name', and appends it to the '
Connection Point' containment reference list |
Trigger |
createDeferrableTrigger(String name)
Creates a new
Trigger , with the specified 'Name', and appends it to the '
Deferrable Trigger' containment reference list |
Behavior |
createDoActivity(String name,
EClass eClass)
Creates a new
Behavior , with the specified 'Name', and sets the '
Do Activity' containment reference |
Behavior |
createEntry(String name,
EClass eClass)
Creates a new
Behavior , with the specified 'Name', and sets the 'Entry'
containment reference |
Behavior |
createExit(String name,
EClass eClass)
Creates a new
Behavior , with the specified 'Name', and sets the 'Exit'
containment reference |
Region |
createRegion(String name)
Creates a new
Region , with the specified 'Name', and appends it to the '
Region' containment reference list |
Constraint |
createStateInvariant(String name)
Creates a new
Constraint ,with the specified 'Name', and sets the '
State Invariant' containment reference |
Constraint |
createStateInvariant(String name,
EClass eClass)
Creates a new
Constraint , with the specified 'Name', and sets the '
State Invariant' containment reference |
ConnectionPointReference |
getConnection(String name)
Retrieves the first
ConnectionPointReference with the specified 'Name' from the '
Connection' containment reference list |
ConnectionPointReference |
getConnection(String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first
ConnectionPointReference with the specified 'Name' from the '
Connection' containment reference list |
Pseudostate |
getConnectionPoint(String name)
Retrieves the first
Pseudostate with the specified 'Name' from the '
Connection Point' containment reference list |
Pseudostate |
getConnectionPoint(String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first
Pseudostate with the specified 'Name' from the '
Connection Point' containment reference list |
MDWEList<Pseudostate> |
getConnectionPoints()
Returns the value of the 'Connection Point' containment reference list.
|
MDWEList<ConnectionPointReference> |
getConnections()
Returns the value of the 'Connection' containment reference list.
|
Trigger |
getDeferrableTrigger(String name)
Retrieves the first
Trigger with the specified 'Name' from the '
Deferrable Trigger' containment reference list |
Trigger |
getDeferrableTrigger(String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first
Trigger with the specified 'Name' from the '
Deferrable Trigger' containment reference list |
MDWEList<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(String name)
Retrieves the first
Region with the specified 'Name' from the 'Region'
containment reference list |
Region |
getRegion(String name,
boolean ignoreCase,
boolean createOnDemand)
Retrieves the first
Region with the specified 'Name' from the 'Region'
containment reference list |
MDWEList<Region> |
getRegions()
Returns the value of the 'Region' containment reference list.
|
Constraint |
getStateInvariant()
Returns the value of the 'State Invariant' containment 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 |
isRedefinitionContextValid(State redefined)
The query isRedefinitionContextValid() specifies whether the redefinition contexts of a state are properly related to the redefinition contexts
of the specified state to allow this element to redefine the other.
|
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 ' containment reference |
void |
setSubmachine(StateMachine value)
Sets the value of the '
Submachine ' reference |
boolean |
validateCompositeStates(DiagnosticChain diagnostics,
Map context)
Only composite states can have entry or exit pseudostates defined.
|
boolean |
validateDestinationsOrSourcesOfTransitions(DiagnosticChain diagnostics,
Map 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 state machine.
|
boolean |
validateEntryOrExit(DiagnosticChain diagnostics,
Map context)
Only entry or exit pseudostates can serve as connection points.
|
boolean |
validateSubmachineOrRegions(DiagnosticChain diagnostics,
Map context)
A state is not allowed to have both a submachine and regions.
|
boolean |
validateSubmachineStates(DiagnosticChain diagnostics,
Map context)
Only submachine states can have connection point references.
|
createElementImport, createElementImport, createOwnedDiagram, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImport, getElementImport, getElementImports, getImportedElements, getImportedMember, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMember, getMembers, getNamesOfMember, getOwnedDiagrams, getOwnedDiagrams, getOwnedMember, getOwnedMember, getOwnedMembers, getOwnedRule, getOwnedRule, getOwnedRules, getPackageImport, getPackageImport, getPackageImports, importMembers, membersAreDistinguishable, validateMembersDistinguishable
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
containingStateMachine, getContainer, getIncoming, getIncoming, getIncomings, getOutgoing, getOutgoing, getOutgoings, setContainer
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership
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
compareTo, eExtendedClass, eIsInstanceOf, eIsInstanceOf, eIsProfiled, eIsRemoved, eMetamodel, eMetaTypeName, eModel, eRemove, eSetUniqueID, eUniqueID, superScript, superScript, toBoolean, toBoolean, toByte, toByte, toChar, toChar, toDouble, toDouble, toFloat, toFloat, toInt, toInt, toList, toList, toList, toList, toList, toLong, toLong, toObject, toObject, toSet, toSet, toShort, toShort, toString, toString
getEAnnotation, getEAnnotations
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
eAdapters, eDeliver, eNotify, eSetDeliver
boolean isComposite()
"false"
.
A state with isComposite=true is said to be a composite state. A composite state is a state that contains at least one region.
UMLPackage.getState_IsComposite()
boolean isOrthogonal()
"false"
.
A state with isOrthogonal=true is said to be an orthogonal composite state. An orthogonal composite state contains two or more regions.
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 state
machine.
UMLPackage.getState_IsSimple()
boolean isSubmachineState()
"false"
.
A state with isSubmachineState=true is said to be a submachine state. Such a state refers to a state machine (submachine).
UMLPackage.getState_IsSubmachineState()
StateMachine getSubmachine()
Submachine State
'.
The state machine that is to be inserted in place of the (submachine) state.
setSubmachine(StateMachine)
,
UMLPackage.getState_Submachine()
,
StateMachine.getSubmachineStates()
void setSubmachine(StateMachine value)
Submachine
' reference.
value
- the new value of the 'Submachine' reference.getSubmachine()
MDWEList<ConnectionPointReference> getConnections()
ConnectionPointReference
.
It is bidirectional and its opposite is 'State
'.
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 submachinestate.
UMLPackage.getState_Connection()
,
ConnectionPointReference.getState()
ConnectionPointReference createConnection(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(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(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()
MDWEList<Pseudostate> getConnectionPoints()
Pseudostate
.
It is bidirectional and its opposite is 'State
'.
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.
UMLPackage.getState_ConnectionPoint()
,
Pseudostate.getState()
Pseudostate createConnectionPoint(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(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(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()
setRedefinedState(State)
,
UMLPackage.getState_RedefinedState()
void setRedefinedState(State value)
Redefined State
' reference.
value
- the new value of the 'Redefined State' reference.getRedefinedState()
Constraint getStateInvariant()
setStateInvariant(Constraint)
,
UMLPackage.getState_StateInvariant()
void setStateInvariant(Constraint value)
State Invariant
' containment reference.
value
- the new value of the 'State Invariant' containment reference.getStateInvariant()
Constraint createStateInvariant(String name, EClass eClass)
Constraint
, with the specified 'Name', and sets the '
State Invariant' containment reference.
name
- The 'Name' for the new Constraint
, or null
.eClass
- The Ecore class of the Constraint
to create.Constraint
.getStateInvariant()
Constraint createStateInvariant(String name)
Constraint
,with the specified 'Name', and sets the '
State Invariant' containment reference.
name
- The 'Name' for the new Constraint
, or null
.Constraint
.getStateInvariant()
Behavior getEntry()
setEntry(Behavior)
,
UMLPackage.getState_Entry()
void setEntry(Behavior value)
Entry
' containment reference.
value
- the new value of the 'Entry' containment reference.getEntry()
Behavior createEntry(String name, 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()
setExit(Behavior)
,
UMLPackage.getState_Exit()
void setExit(Behavior value)
Exit
' containment reference.
value
- the new value of the 'Exit' containment reference.getExit()
Behavior createExit(String name, EClass eClass)
Behavior
, with the specified 'Name', and sets the 'Exit'
containment reference.
Behavior getDoActivity()
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(String name, 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()
MDWEList<Trigger> getDeferrableTriggers()
Trigger
.
A list of triggers that are candidates to be retained by the state machine if they trigger no transitions out of the state (not consumed). A
deferred trigger is retained until the state machine reaches a state configuration where it is no longer deferred.
UMLPackage.getState_DeferrableTrigger()
Trigger createDeferrableTrigger(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(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(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()
MDWEList<Region> getRegions()
Region
.
It is bidirectional and its opposite is 'State
'.
The regions owned directly by the state.
UMLPackage.getState_Region()
,
Region.getState()
Region createRegion(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(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(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(DiagnosticChain diagnostics, Map context)
boolean validateDestinationsOrSourcesOfTransitions(DiagnosticChain diagnostics, Map context)
boolean validateSubmachineOrRegions(DiagnosticChain diagnostics, Map context)
boolean validateCompositeStates(DiagnosticChain diagnostics, Map context)
boolean validateEntryOrExit(DiagnosticChain diagnostics, Map context)
Classifier redefinitionContext()
boolean isRedefinitionContextValid(State redefined)