| Package | Description |
|---|---|
| org.apache.commons.scxml2 |
The Commons SCXML executor and core concepts.
|
| org.apache.commons.scxml2.env |
A collection of classes that may be commonly used to bridge the
SCXML executor to the runtime environment.
|
| org.apache.commons.scxml2.model |
A collection of classes needed to model SCXML documents.
|
| org.apache.commons.scxml2.semantics |
A collection of classes responsible for implementations of the
org.apache.commons.scxml2.SCXMLSemantics interface. |
| Modifier and Type | Method and Description |
|---|---|
Set<EnterableState> |
Status.getActiveStates()
Get the active states configuration.
|
Set<EnterableState> |
StateConfiguration.getActiveStates()
Get the active states
|
Set<EnterableState> |
SCInstance.getLastConfiguration(History history)
Get the last configuration for this history.
|
Set<EnterableState> |
Status.getStates()
Get the atomic states configuration (leaf only).
|
Set<EnterableState> |
StateConfiguration.getStates()
Get the current atomic states (leaf only).
|
| Modifier and Type | Method and Description |
|---|---|
void |
StateConfiguration.enterState(EnterableState state)
Enter an active state
If the state is atomic also record it add it to the current states
|
void |
StateConfiguration.exitState(EnterableState state)
Exit an active state
If the state is atomic also remove it from current states
|
void |
NotificationRegistry.fireOnEntry(Observable source,
EnterableState state)
Inform all relevant listeners that a EnterableState has been
entered.
|
void |
NotificationRegistry.fireOnExit(Observable source,
EnterableState state)
Inform all relevant listeners that a EnterableState has been
exited.
|
Context |
SCInstance.getContext(EnterableState state)
Get the context for an EnterableState or create one if not created before.
|
Context |
ActionExecutionContext.getContext(EnterableState state) |
void |
SCXMLListener.onEntry(EnterableState state)
Handle the entry into a EnterableState.
|
void |
SCXMLListener.onExit(EnterableState state)
Handle the exit out of a EnterableState.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
SCXMLSemantics.isLegalConfiguration(Set<EnterableState> states,
ErrorReporter errRep)
Checks whether a given set of states is a legal Harel State Table
configuration (with the respect to the definition of the OR and AND
states).
|
void |
SCInstance.setLastConfiguration(History history,
Set<EnterableState> lc)
Set the last configuration for this history.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Tracer.onEntry(EnterableState state) |
void |
SimpleSCXMLListener.onEntry(EnterableState state) |
void |
AbstractStateMachine.EntryListener.onEntry(EnterableState entered)
Handle the entry into a EnterableState.
|
void |
AbstractSCXMLListener.onEntry(EnterableState state) |
void |
Tracer.onExit(EnterableState state) |
void |
SimpleSCXMLListener.onExit(EnterableState state) |
void |
AbstractStateMachine.EntryListener.onExit(EnterableState exited)
No-op.
|
void |
AbstractSCXMLListener.onExit(EnterableState state) |
| Modifier and Type | Class and Description |
|---|---|
class |
Final
The class in this SCXML object model that corresponds to the
<final> SCXML element.
|
class |
Parallel
The class in this SCXML object model that corresponds to the
<parallel> SCXML element, which is a wrapper element to
encapsulate parallel state machines.
|
class |
State
The class in this SCXML object model that corresponds to the
<state> SCXML element.
|
class |
TransitionalState
An abstract base class for state elements in SCXML that can be transitioned out from, such as State or Parallel.
|
| Modifier and Type | Method and Description |
|---|---|
EnterableState |
TransitionTarget.getAncestor(int level)
Get the ancestor of this TransitionTarget at specified level
|
EnterableState |
SCXML.getFirstChild()
Get the first immediate child of the SCXML root.
|
EnterableState |
TransitionTarget.getParent()
Get the parent TransitionTarget.
|
EnterableState |
Executable.getParent()
Get the EnterableState parent.
|
EnterableState |
Invoke.getParentEnterableState()
Get the parent EnterableState.
|
EnterableState |
Action.getParentEnterableState()
Return the
EnterableState whose Context this action
executes in. |
| Modifier and Type | Method and Description |
|---|---|
List<EnterableState> |
TransitionalState.getChildren()
Get the set of child transition targets (may be empty).
|
List<EnterableState> |
SCXML.getChildren()
Get the immediate child targets of the SCXML root.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
TransitionalState.addChild(EnterableState es)
Add a child.
|
void |
State.addChild(EnterableState es)
Adds an EnterableState (State, Final or Parallel) child
|
void |
SCXML.addChild(EnterableState es)
Add an immediate child of the SCXML root.
|
protected void |
TransitionTarget.setParent(EnterableState parent)
Set the parent EnterableState.
|
void |
OnExit.setParent(EnterableState parent)
Set the EnterableState parent.
|
void |
OnEntry.setParent(EnterableState parent)
Set the EnterableState parent.
|
protected void |
Executable.setParent(EnterableState parent)
Set the EnterableState parent.
|
void |
Invoke.setParentEnterableState(EnterableState parent)
Set the parent EnterableState.
|
| Modifier and Type | Method and Description |
|---|---|
Set<EnterableState> |
Step.getDefaultEntrySet() |
Set<EnterableState> |
Step.getEntrySet() |
Set<EnterableState> |
Step.getExitSet() |
Map<History,Set<EnterableState>> |
Step.getNewHistoryConfigurations() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
SCXMLSemanticsImpl.containsDescendant(Set<EnterableState> states,
EnterableState state) |
boolean |
SCXMLSemanticsImpl.isInFinalState(EnterableState es,
Set<EnterableState> configuration)
This method corresponds to the Algorithm for SCXML processing isFinalState() function.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SCXMLSemanticsImpl.computeExitSet(SimpleTransition transition,
Set<EnterableState> exitSet,
Set<EnterableState> activeStates)
Compute and store the set of states to exit for one specific transition in the provided step.
|
void |
SCXMLSemanticsImpl.computeExitSet(SimpleTransition transition,
Set<EnterableState> exitSet,
Set<EnterableState> activeStates)
Compute and store the set of states to exit for one specific transition in the provided step.
|
boolean |
SCXMLSemanticsImpl.containsDescendant(Set<EnterableState> states,
EnterableState state) |
boolean |
SCXMLSemanticsImpl.isInFinalState(EnterableState es,
Set<EnterableState> configuration)
This method corresponds to the Algorithm for SCXML processing isFinalState() function.
|
boolean |
SCXMLSemanticsImpl.isLegalConfiguration(Set<EnterableState> states,
ErrorReporter errRep)
Checks whether a given set of states is a legal Harel State Table
configuration (with the respect to the definition of the OR and AND
states).
|
void |
SCXMLSemanticsImpl.recordHistory(Step step,
Set<EnterableState> atomicStates,
Set<EnterableState> activeStates)
Record the history configurations for states to exit if applicable and temporarily store this in the step.
|
void |
SCXMLSemanticsImpl.recordHistory(Step step,
Set<EnterableState> atomicStates,
Set<EnterableState> activeStates)
Record the history configurations for states to exit if applicable and temporarily store this in the step.
|
Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.