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.io |
A collection of classes for reading in and writing out SCXML
documents, to and from the Commons SCXML Java object model.
|
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 |
---|---|
protected void |
SCXMLExecutor.eventStep(TriggerEvent event) |
void |
SCXMLSemantics.finalStep(SCXMLExecutionContext exctx)
The final step in the execution of an SCXML state machine.
|
void |
SCXMLSemantics.firstStep(SCXMLExecutionContext exctx)
First step in the execution of an SCXML state machine.
|
static Evaluator |
EvaluatorFactory.getEvaluator(SCXML document)
Returns a dedicated Evaluator instance for a specific SCXML document its documentmodel.
|
void |
SCXMLExecutor.go()
Initiate state machine execution.
|
void |
SCXMLExecutionContext.initialize()
Initialize method which will cancel all current active Invokers, clear the internal event queue and mark the
state machine process as running (again).
|
protected void |
SCInstance.initialize()
(re)Initializes the state machine instance, clearing all variable contexts, histories and current status,
and clones the SCXML root datamodel into the root context.
|
void |
SCXMLSemantics.nextStep(SCXMLExecutionContext exctx,
TriggerEvent event)
Next step in the execution of an SCXML state machine.
|
void |
SCXMLExecutor.reset()
Clear all state and begin executing the state machine
|
void |
SCXMLExecutor.setConfiguration(Set<String> atomicStateIds)
Initializes the state machine with a specific active configuration
This will first (re)initialize the current state machine: clearing all variable contexts, histories and current
status, and clones the SCXML root datamodel into the root context.
|
protected void |
SCInstance.setErrorReporter(ErrorReporter errorReporter)
Set or re-attach the error reporter
|
void |
SCXMLExecutor.setEvaluator(Evaluator evaluator)
Set or replace the expression evaluator
If the state machine instance has been initialized before, it will be initialized again, destroying all existing
state!
|
protected void |
SCXMLExecutionContext.setEvaluator(Evaluator evaluator)
Set or replace the evaluator
If the state machine instance has been initialized before, it will be initialized again, destroying all existing
state!
|
protected void |
SCInstance.setEvaluator(Evaluator evaluator,
boolean reAttach)
Set or re-attach the evaluator
If not re-attaching and this state machine instance has been initialized before,
it will be initialized again, destroying all existing state!
|
void |
SCXMLExecutor.setSingleContext(boolean singleContext) |
void |
SCInstance.setSingleContext(boolean singleContext) |
void |
SCXMLExecutor.setStateMachine(SCXML stateMachine)
Set or replace the state machine to be executed
If the state machine instance has been initialized before, it will be initialized again, destroying all existing
state!
|
protected void |
SCXMLExecutionContext.setStateMachine(SCXML stateMachine)
Set or replace the state machine to be executed
If the state machine instance has been initialized before, it will be initialized again, destroying all existing
state!
|
protected void |
SCInstance.setStateMachine(SCXML stateMachine)
Sets the state machine for this instance.
|
void |
SCXMLExecutor.triggerEvent(TriggerEvent evt)
Convenience method when only one event needs to be triggered.
|
void |
SCXMLExecutor.triggerEvents()
Trigger all pending and incoming events, until there are no more pending events
|
void |
SCXMLExecutor.triggerEvents(TriggerEvent[] evts)
The worker method.
|
Constructor and Description |
---|
AbstractStateMachine(SCXML stateMachine)
Convenience constructor.
|
AbstractStateMachine(SCXML stateMachine,
Context rootCtx,
Evaluator evaluator)
Primary constructor.
|
AbstractStateMachine(URL scxmlDocument)
Convenience constructor, object instantiation incurs parsing cost.
|
AbstractStateMachine(URL scxmlDocument,
Context rootCtx,
Evaluator evaluator)
Primary constructor, object instantiation incurs parsing cost.
|
Modifier and Type | Method and Description |
---|---|
static SCXML |
SCXMLReader.read(InputStream scxmlStream)
Parse the SCXML document supplied by the given
InputStream . |
static SCXML |
SCXMLReader.read(InputStream scxmlStream,
SCXMLReader.Configuration configuration)
Parse the SCXML document supplied by the given
InputStream with the given SCXMLReader.Configuration . |
static SCXML |
SCXMLReader.read(Reader scxmlReader)
Parse the SCXML document supplied by the given
Reader . |
static SCXML |
SCXMLReader.read(Reader scxmlReader,
SCXMLReader.Configuration configuration)
Parse the SCXML document supplied by the given
Reader with the given SCXMLReader.Configuration . |
static SCXML |
SCXMLReader.read(Source scxmlSource)
Parse the SCXML document supplied by the given
Source . |
static SCXML |
SCXMLReader.read(Source scxmlSource,
SCXMLReader.Configuration configuration)
Parse the SCXML document supplied by the given
Source with the given SCXMLReader.Configuration . |
static SCXML |
SCXMLReader.read(String scxmlPath)
Parse the SCXML document at the supplied path.
|
static SCXML |
SCXMLReader.read(String scxmlPath,
SCXMLReader.Configuration configuration)
Parse the SCXML document at the supplied path with the given
SCXMLReader.Configuration . |
static SCXML |
SCXMLReader.read(URL scxmlURL)
Parse the SCXML document at the supplied
URL . |
static SCXML |
SCXMLReader.read(URL scxmlURL,
SCXMLReader.Configuration configuration)
Parse the SCXML document at the supplied
URL with the given SCXMLReader.Configuration . |
Modifier and Type | Method and Description |
---|---|
protected void |
NamelistHolder.addNamelistDataToPayload(ActionExecutionContext exctx,
Map<String,Object> payload)
Adds data to the payload data map based on the namelist which names are location expressions
(typically data ids or for example XPath variables).
|
protected void |
ParamsContainer.addParamsToPayload(ActionExecutionContext exctx,
Map<String,Object> payload)
Adds data to the payload data map based on the
Param s of this ParamsContainer |
void |
Var.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Send.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Script.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Raise.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Log.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Invoke.execute(ActionExecutionContext axctx) |
void |
If.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Foreach.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
ElseIf.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Cancel.execute(ActionExecutionContext exctx)
Execute this action instance.
|
void |
Assign.execute(ActionExecutionContext exctx)
Execute this action instance.
|
abstract void |
Action.execute(ActionExecutionContext exctx)
Execute this action instance.
|
EnterableState |
Action.getParentEnterableState()
Return the
EnterableState whose Context this action
executes in. |
protected Object |
PayloadProvider.makeEventPayload(Evaluator evaluator,
Map<String,Object> payload)
Converts a payload data map to be used for an event payload.
|
Modifier and Type | Method and Description |
---|---|
void |
SCXMLSemanticsImpl.buildStep(SCXMLExecutionContext exctx,
Step step)
buildStep builds the exitSet and entrySet for the current configuration given the transitionList on the step.
|
void |
SCXMLSemanticsImpl.enterStates(SCXMLExecutionContext exctx,
Step step,
Set<TransitionalState> statesToInvoke)
This method corresponds to the Algorithm for SCXML processing enterStates() procedure, where the states to enter
already have been pre-computed in
SCXMLSemanticsImpl.microStep(SCXMLExecutionContext, Step, java.util.Set) . |
void |
SCXMLSemanticsImpl.executeContent(SCXMLExecutionContext exctx,
Executable exec)
Executes the executable content for a specific executable in the micro step
|
void |
SCXMLSemanticsImpl.executeGlobalScript(SCXMLExecutionContext exctx)
Executes the global SCXML script element
|
void |
SCXMLSemanticsImpl.executeTransitionContent(SCXMLExecutionContext exctx,
Step step)
Executes the executable content for all transitions in the micro step
|
void |
SCXMLSemanticsImpl.exitStates(SCXMLExecutionContext exctx,
Step step,
Set<TransitionalState> statesToInvoke)
This method corresponds to the Algorithm for SCXML processing exitStates() procedure, where the states to exit
already have been pre-computed in
SCXMLSemanticsImpl.microStep(SCXMLExecutionContext, Step, java.util.Set) . |
void |
SCXMLSemanticsImpl.finalStep(SCXMLExecutionContext exctx)
The final step in the execution of an SCXML state machine.
|
void |
SCXMLSemanticsImpl.firstStep(SCXMLExecutionContext exctx)
First step in the execution of an SCXML state machine.
|
void |
SCXMLSemanticsImpl.initiateInvokes(SCXMLExecutionContext exctx,
Set<TransitionalState> statesToInvoke)
Initiate any new invoked activities.
|
void |
SCXMLSemanticsImpl.macroStep(SCXMLExecutionContext exctx,
Set<TransitionalState> statesToInvoke)
Perform a macro step in the execution of a state machine.
|
void |
SCXMLSemanticsImpl.microStep(SCXMLExecutionContext exctx,
Step step,
Set<TransitionalState> statesToInvoke)
Perform a micro step in the execution of a state machine.
|
void |
SCXMLSemanticsImpl.nextStep(SCXMLExecutionContext exctx,
TriggerEvent event)
Next step in the execution of an SCXML state machine.
|
void |
SCXMLSemanticsImpl.processInvokes(SCXMLExecutionContext exctx,
TriggerEvent event)
Forward events to invoked activities, execute finalize handlers.
|
void |
SCXMLSemanticsImpl.selectTransitions(SCXMLExecutionContext exctx,
Step step)
This method corresponds to the Algorithm for SCXML processing selectTransitions() as well as the
selectEventlessTransitions() procedure, depending on the event (or null) in the provided step
|
Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.