org.eclipse.uml2
Interface StateMachine

All Superinterfaces:
Behavior, BehavioredClassifier, Class, Classifier, Element, EModelElement, EncapsulatedClassifier, EObject, NamedElement, Namespace, Notifier, PackageableElement, ParameterableElement, RedefinableElement, StructuredClassifier, TemplateableElement, Type
All Known Subinterfaces:
ProtocolStateMachine

public interface StateMachine
extends Behavior

A representation of the model object 'State Machine'.

The following features are supported:

See Also:
UML2Package.getStateMachine()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Pseudostate createConnectionPoint()
          Creates a Pseudostate and appends it to the 'Connection Point' containment reference list
 Pseudostate createConnectionPoint(EClass eClass)
          Deprecated. Use #createConnectionPoint() instead.
 Region createRegion()
          Creates a Region and appends it to the 'Region' containment reference list
 Region createRegion(EClass eClass)
          Deprecated. Use #createRegion() instead.
 Pseudostate getConnectionPoint(java.lang.String name)
          Retrieves the Pseudostate with the specified 'Name' from the 'Connection Point' containment reference list
 EList getConnectionPoints()
          Returns the value of the 'Connection Point' containment reference list.
 StateMachine getExtendedStateMachine()
          Returns the value of the 'Extended State Machine' reference
 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.
 Region getRegion(java.lang.String name)
          Retrieves the Region with the specified 'Name' from the 'Region' containment reference list
 EList getRegions()
          Returns the value of the 'Region' containment reference list.
 BehavioredClassifier getStateMachine_redefinitionContext()
          Returns the value of the 'State Machine redefinition Context' container reference.
 void setExtendedStateMachine(StateMachine value)
          Sets the value of the 'Extended State Machine' reference
 void setStateMachine_redefinitionContext(BehavioredClassifier value)
          Sets the value of the 'State Machine redefinition Context' container reference
 
Methods inherited from interface org.eclipse.uml2.Behavior
createOwnedParameterSet, createOwnedParameterSet, createParameter, createParameter, getContext, getFormalParameter, getFormalParameters, getOwnedParameterSet, getOwnedParameterSets, getParameter, getParameters, getPostcondition, getPostconditions, getPrecondition, getPreconditions, getRedefinedBehavior, getRedefinedBehaviors, getReturnResult, getReturnResults, getSpecification, isReentrant, setContext, setIsReentrant, setSpecification
 
Methods inherited from interface org.eclipse.uml2.Class
createNestedClassifier, createOwnedAttribute, createOwnedOperation, createOwnedOperation, createOwnedOperation, createOwnedReception, createOwnedReception, getExtension, getExtensions, getNestedClassifier, getNestedClassifiers, getOwnedOperation, getOwnedOperations, getOwnedReception, getOwnedReceptions, getSuperClass, getSuperClasses, isActive, isMetaclass, setIsActive
 
Methods inherited from interface org.eclipse.uml2.BehavioredClassifier
createImplementation, createImplementation, createImplementation, createOwnedBehavior, createOwnedStateMachine, createOwnedStateMachine, createOwnedTrigger, getAllImplementedInterfaces, getClassifierBehavior, getImplementation, getImplementations, getImplementedInterfaces, getOwnedBehavior, getOwnedBehaviors, getOwnedStateMachine, getOwnedStateMachines, getOwnedTrigger, getOwnedTriggers, setClassifierBehavior
 
Methods inherited from interface org.eclipse.uml2.Classifier
allFeatures, allParents, conformsTo, createGeneralization, createGeneralization, createGeneralization, createOccurrence, createOccurrence, createOwnedUseCase, createOwnedUseCase, createSubstitution, createSubstitution, general, getAttribute, getAttributes, getFeature, getFeatures, getGeneral, getGeneralizations, getGenerals, getInheritedMember, getInheritedMembers, getOccurrence, getOccurrences, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitutions, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, inheritedMember, isAbstract, maySpecializeType, parents, setIsAbstract, setRepresentation, validateGeneralEqualsParents, validateInheritedMember, validateNoCyclesInGeneralization, validateSpecializeType
 
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.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.Type
conformsTo, createAssociation, getPackage
 
Methods inherited from interface org.eclipse.uml2.PackageableElement
getPackageableElement_visibility, setPackageableElement_visibility
 
Methods inherited from interface org.eclipse.uml2.ParameterableElement
getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.EncapsulatedClassifier
createOwnedPort, createOwnedPort, getOwnedPort, getOwnedPorts
 
Methods inherited from interface org.eclipse.uml2.StructuredClassifier
createOwnedAttribute, createOwnedAttribute, createOwnedConnector, createOwnedConnector, getOwnedAttribute, getOwnedAttributes, getOwnedConnector, getOwnedConnectors, getPart, getParts, getRole, getRoles
 

Field Detail

copyright

public static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getRegions

public EList getRegions()
Returns the value of the 'Region' containment reference list. The list contents are of type Region. It is bidirectional and its opposite is 'State Machine'.

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

Returns:
the value of the 'Region' containment reference list.
See Also:
UML2Package.getStateMachine_Region(), Region.getStateMachine()

getRegion

public Region getRegion(java.lang.String name)
Retrieves the Region with the specified 'Name' from the 'Region' containment reference list.

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

createRegion

public Region createRegion(EClass eClass)
Deprecated. Use #createRegion() instead.

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

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

createRegion

public Region createRegion()
Creates a Region and appends it to the 'Region' containment reference list.

Returns:
The new Region.
See Also:
getRegions()

getConnectionPoints

public EList getConnectionPoints()
Returns the value of the 'Connection Point' containment reference list. The list contents are of type Pseudostate.

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

Returns:
the value of the 'Connection Point' containment reference list.
See Also:
UML2Package.getStateMachine_ConnectionPoint()

getConnectionPoint

public Pseudostate getConnectionPoint(java.lang.String name)
Retrieves the Pseudostate with the specified 'Name' from the 'Connection Point' containment reference list.

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

createConnectionPoint

public Pseudostate createConnectionPoint(EClass eClass)
Deprecated. Use #createConnectionPoint() instead.

Creates a Pseudostate and appends it to the 'Connection Point' containment reference list.

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

createConnectionPoint

public Pseudostate createConnectionPoint()
Creates a Pseudostate and appends it to the 'Connection Point' containment reference list.

Returns:
The new Pseudostate.
See Also:
getConnectionPoints()

getExtendedStateMachine

public StateMachine getExtendedStateMachine()
Returns the value of the 'Extended State Machine' reference.

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

Returns:
the value of the 'Extended State Machine' reference.
See Also:
setExtendedStateMachine(StateMachine), UML2Package.getStateMachine_ExtendedStateMachine()

setExtendedStateMachine

public void setExtendedStateMachine(StateMachine value)
Sets the value of the 'Extended State Machine' reference.

Parameters:
value - the new value of the 'Extended State Machine' reference.
See Also:
getExtendedStateMachine()

getStateMachine_redefinitionContext

public BehavioredClassifier getStateMachine_redefinitionContext()
Returns the value of the 'State Machine redefinition Context' container reference. It is bidirectional and its opposite is 'Owned State Machine'.

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

Returns:
the value of the 'State Machine redefinition Context' container reference.
See Also:
setStateMachine_redefinitionContext(BehavioredClassifier), UML2Package.getStateMachine_StateMachine_redefinitionContext(), BehavioredClassifier.getOwnedStateMachines()

setStateMachine_redefinitionContext

public void setStateMachine_redefinitionContext(BehavioredClassifier value)
Sets the value of the 'State Machine redefinition Context' container reference.

Parameters:
value - the new value of the 'State Machine redefinition Context' container reference.
See Also:
getStateMachine_redefinitionContext()

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()

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