|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StateMachine
A representation of the model object 'State Machine'. StateMachines can be used to express event-driven behaviors of parts of a system. Behavior is modeled as a traversal of a graph of Vertices interconnected by one or more joined Transition arcs that are triggered by the dispatching of successive Event occurrences. During this traversal, the StateMachine may execute a sequence of Behaviors associated with various elements of the StateMachine.
From package UML::StateMachines.
The following features are supported:
UMLPackage.getStateMachine()
Field Summary |
---|
Fields inherited from interface org.eclipse.uml2.uml.NamedElement |
---|
SEPARATOR |
Method Summary | |
---|---|
boolean |
ancestor(Vertex s1,
Vertex s2)
The query ancestor(s1, s2) checks whether Vertex s2 is an ancestor of Vertex s1. |
Pseudostate |
createConnectionPoint(java.lang.String name)
Creates a new Pseudostate , with the specified 'Name', and appends it to the 'Connection Point' containment reference list |
Region |
createRegion(java.lang.String name)
Creates a new Region , with the specified 'Name', and appends it to the 'Region' 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. |
StateMachine |
getExtendedStateMachine(java.lang.String name)
Retrieves the first StateMachine with the specified 'Name' from the 'Extended State Machine' reference list |
StateMachine |
getExtendedStateMachine(java.lang.String name,
boolean ignoreCase,
org.eclipse.emf.ecore.EClass eClass)
Retrieves the first StateMachine with the specified 'Name' from the 'Extended State Machine' reference list |
org.eclipse.emf.common.util.EList<StateMachine> |
getExtendedStateMachines()
Returns the value of the 'Extended State Machine' reference list. |
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. |
State |
getSubmachineState(java.lang.String name)
Retrieves the first State with the specified 'Name' from the 'Submachine State' reference list |
State |
getSubmachineState(java.lang.String name,
boolean ignoreCase,
org.eclipse.emf.ecore.EClass eClass)
Retrieves the first State with the specified 'Name' from the 'Submachine State' reference list |
org.eclipse.emf.common.util.EList<State> |
getSubmachineStates()
Returns the value of the 'Submachine State' reference list. |
Region |
LCA(Vertex s1,
Vertex s2)
The operation LCA(s1,s2) returns the Region that is the least common ancestor of Vertices s1 and s2, based on the StateMachine containment hierarchy. |
State |
LCAState(Vertex v1,
Vertex v2)
This utility funciton is like the LCA, except that it returns the nearest composite State that contains both input Vertices. |
boolean |
validateClassifierContext(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
The Classifier context of a StateMachine cannot be an Interface. |
boolean |
validateConnectionPoints(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
The connection points of a StateMachine are Pseudostates of kind entry point or exit point. |
boolean |
validateContextClassifier(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
The context Classifier of the method StateMachine of a BehavioralFeature must be the Classifier that owns the BehavioralFeature. |
boolean |
validateMethod(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A StateMachine as the method for a BehavioralFeature cannot have entry/exit connection points. |
Methods inherited from interface org.eclipse.uml2.uml.Class |
---|
createNestedClassifier, createOwnedOperation, createOwnedOperation, createOwnedReception, getExtension, getExtension, getExtensions, getNestedClassifier, getNestedClassifier, getNestedClassifiers, getOwnedOperation, getOwnedOperation, getOwnedOperations, getOwnedReception, getOwnedReception, getOwnedReceptions, getSuperClass, getSuperClass, getSuperClasses, isActive, isMetaclass, setIsActive, validatePassiveClass |
Methods inherited from interface org.eclipse.uml2.uml.EncapsulatedClassifier |
---|
createOwnedPort, getOwnedPort, getOwnedPort, getOwnedPort, getOwnedPorts |
Methods inherited from interface org.eclipse.uml2.uml.StructuredClassifier |
---|
allRoles, createOwnedAttribute, createOwnedAttribute, createOwnedAttribute, createOwnedConnector, getOwnedAttribute, getOwnedAttribute, getOwnedAttributes, getOwnedConnector, getOwnedConnector, getOwnedConnectors, getPart, getPart, getParts, getRole, getRole, getRoles |
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.Type |
---|
conformsTo, createAssociation, getAssociations, getPackage, setPackage |
Methods inherited from interface org.eclipse.uml2.uml.PackageableElement |
---|
validateNamespaceNeedsVisibility |
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.ParameterableElement |
---|
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter |
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 |
Methods inherited from interface org.eclipse.uml2.uml.TemplateableElement |
---|
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBinding, getTemplateBinding, getTemplateBindings, isTemplate, parameterableElements, setOwnedTemplateSignature |
Methods inherited from interface org.eclipse.uml2.uml.BehavioredClassifier |
---|
createClassifierBehavior, createInterfaceRealization, createOwnedBehavior, getAllImplementedInterfaces, getClassifierBehavior, getImplementedInterfaces, getInterfaceRealization, getInterfaceRealization, getInterfaceRealizations, getOwnedBehavior, getOwnedBehavior, getOwnedBehaviors, setClassifierBehavior, validateClassBehavior |
Method Detail |
---|
org.eclipse.emf.common.util.EList<Region> getRegions()
Region
.
It is bidirectional and its opposite is 'State Machine
'.
This feature subsets the following features:
The Regions owned directly by the StateMachine.From package UML::StateMachines.
UMLPackage.getStateMachine_Region()
,
Region.getStateMachine()
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()
org.eclipse.emf.common.util.EList<State> getSubmachineStates()
State
.
It is bidirectional and its opposite is 'Submachine
'.
References the submachine(s) in case of a submachine State. Multiple machines are referenced in case of a concurrent State.
From package UML::StateMachines.
UMLPackage.getStateMachine_SubmachineState()
,
State.getSubmachine()
State getSubmachineState(java.lang.String name)
State
with the specified 'Name' from the 'Submachine State' reference list.
name
- The 'Name' of the State
to retrieve, or null
.
State
with the specified 'Name', or null
.getSubmachineStates()
State getSubmachineState(java.lang.String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass)
State
with the specified 'Name' from the 'Submachine State' reference list.
name
- The 'Name' of the State
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.eClass
- The Ecore class of the State
to retrieve, or null
.
State
with the specified 'Name', or null
.getSubmachineStates()
org.eclipse.emf.common.util.EList<Pseudostate> getConnectionPoints()
Pseudostate
.
It is bidirectional and its opposite is 'State Machine
'.
This feature subsets the following features:
The connection points defined for this StateMachine. They represent the interface of the StateMachine when used as part of submachine StateFrom package UML::StateMachines.
UMLPackage.getStateMachine_ConnectionPoint()
,
Pseudostate.getStateMachine()
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()
org.eclipse.emf.common.util.EList<StateMachine> getExtendedStateMachines()
StateMachine
.
This feature redefines the following features:
The StateMachines of which this is an extension.From package UML::StateMachines.
UMLPackage.getStateMachine_ExtendedStateMachine()
StateMachine getExtendedStateMachine(java.lang.String name)
StateMachine
with the specified 'Name' from the 'Extended State Machine' reference list.
name
- The 'Name' of the StateMachine
to retrieve, or null
.
StateMachine
with the specified 'Name', or null
.getExtendedStateMachines()
StateMachine getExtendedStateMachine(java.lang.String name, boolean ignoreCase, org.eclipse.emf.ecore.EClass eClass)
StateMachine
with the specified 'Name' from the 'Extended State Machine' reference list.
name
- The 'Name' of the StateMachine
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.eClass
- The Ecore class of the StateMachine
to retrieve, or null
.
StateMachine
with the specified 'Name', or null
.getExtendedStateMachines()
boolean validateClassifierContext(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 validateContextClassifier(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.
Region LCA(Vertex s1, Vertex s2)
From package UML::StateMachines.
boolean ancestor(Vertex s1, Vertex s2)
From package UML::StateMachines.
State LCAState(Vertex v1, Vertex v2)
From package UML::StateMachines.
boolean validateConnectionPoints(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 validateMethod(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.
|
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 |