SCInstance (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.SCInstance

All Implemented Interfaces:

Serializable
```
public class SCInstance
extends Object
implements Serializable
```
The SCInstance performs book-keeping functions for a particular execution of a state chart represented by a SCXML object.

See Also:
Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SCInstance(SCXMLIOProcessor internalIOProcessor, Evaluator evaluator, ErrorReporter errorReporter)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`cloneDatamodel(Datamodel datamodel, Context ctx, Evaluator evaluator, ErrorReporter errorReporter)` Clone data model.
`protected void`	`detach()` Detach this state machine instance to allow external serialization.
`Context`	`getContext(EnterableState state)` Get the context for an EnterableState or create one if not created before.
`Status`	`getCurrentStatus()`
`protected Evaluator`	`getEvaluator()`
`Context`	`getGlobalContext()`
`Set<EnterableState>`	`getLastConfiguration(History history)` Get the last configuration for this history.
`Context`	`getRootContext()` Get the root context.
`StateConfiguration`	`getStateConfiguration()`
`SCXML`	`getStateMachine()`
`Context`	`getSystemContext()` Get the unwrapped (modifiable) system context.
`protected void`	`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.
`boolean`	`isRunning()`
`boolean`	`isSingleContext()`
`void`	`resetConfiguration(History history)` Resets the history state.
`protected void`	`setErrorReporter(ErrorReporter errorReporter)` Set or re-attach the error reporter
`protected void`	`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!
`protected void`	`setInternalIOProcessor(SCXMLIOProcessor internalIOProcessor)` Sets the I/O Processor for the internal event queue
`void`	`setLastConfiguration(History history, Set<EnterableState> lc)` Set the last configuration for this history.
`protected void`	`setRootContext(Context context)` Set or replace the root context.
`protected void`	`setRunning(boolean running)` Sets the running status of the state machine
`void`	`setSingleContext(boolean singleContext)`
`protected void`	`setStateMachine(SCXML stateMachine)` Sets the state machine for this instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SCInstance
```
protected SCInstance(SCXMLIOProcessor internalIOProcessor,
          Evaluator evaluator,
          ErrorReporter errorReporter)
```
    Constructor
    
    Parameters:
    internalIOProcessor - The I/O Processor for the internal event queue
    evaluator - The evaluator
    errorReporter - The error reporter
- Method Detail
  - initialize
```
protected void initialize()
                   throws ModelException
```
    (re)Initializes the state machine instance, clearing all variable contexts, histories and current status, and clones the SCXML root datamodel into the root context.
    
    Throws:
    
    ModelException - if the state machine hasn't been setup for this instance
  - detach
```
protected void detach()
```
    Detach this state machine instance to allow external serialization.
    This clears the internal I/O processor, evaluator and errorReporter members.
  - setInternalIOProcessor
```
protected void setInternalIOProcessor(SCXMLIOProcessor internalIOProcessor)
```
    Sets the I/O Processor for the internal event queue
    
    Parameters:
    internalIOProcessor - the I/O Processor
  - setEvaluator
```
protected void setEvaluator(Evaluator evaluator,
                boolean reAttach)
                     throws ModelException
```
    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!
    
    Parameters:
    evaluator - The evaluator for this state machine instance.
    
    Throws:
    
    ModelException
  - getEvaluator
```
protected Evaluator getEvaluator()
```
    Returns:
    Return the current evaluator
  - setErrorReporter
```
protected void setErrorReporter(ErrorReporter errorReporter)
                         throws ModelException
```
    Set or re-attach the error reporter
    
    Parameters:
    errorReporter - The error reporter for this state machine instance.
    
    Throws:
    
    ModelException - if an attempt is made to set a null value for the error reporter
  - getStateMachine
```
public SCXML getStateMachine()
```
    Returns:
    Return the state machine for this instance
  - setStateMachine
```
protected void setStateMachine(SCXML stateMachine)
                        throws ModelException
```
    Sets the state machine for this instance.
    If this state machine instance has been initialized before, it will be initialized again, destroying all existing state!
    
    Parameters:
    stateMachine - The state machine for this instance
    
    Throws:
    
    ModelException - if an attempt is made to set a null value for the state machine
  - setSingleContext
```
public void setSingleContext(boolean singleContext)
                      throws ModelException
```
    Throws:
    
    ModelException
  - isSingleContext
```
public boolean isSingleContext()
```
  - cloneDatamodel
```
protected void cloneDatamodel(Datamodel datamodel,
                  Context ctx,
                  Evaluator evaluator,
                  ErrorReporter errorReporter)
```
    Clone data model.
    
    Parameters:
    ctx - The context to clone to.
    datamodel - The datamodel to clone.
    evaluator - The expression evaluator.
    errorReporter - The error reporter
  - getStateConfiguration
```
public StateConfiguration getStateConfiguration()
```
    Returns:
    Returns the state configuration for this instance
  - getCurrentStatus
```
public Status getCurrentStatus()
```
    Returns:
    Returns the current status for this instance
  - isRunning
```
public boolean isRunning()
```
    Returns:
    Returns if the state machine is running
  - setRunning
```
protected void setRunning(boolean running)
                   throws IllegalStateException
```
    Sets the running status of the state machine
    
    Parameters:
    running - flag indicating the running status of the state machine
    
    Throws:
    
    IllegalStateException - Exception thrown if trying to set the state machine running when in a Final state
  - getRootContext
```
public Context getRootContext()
```
    Get the root context.
    
    Returns:
    The root context.
  - setRootContext
```
protected void setRootContext(Context context)
```
    Set or replace the root context.
    
    Parameters:
    context - The new root context.
  - getSystemContext
```
public Context getSystemContext()
```
    Get the unwrapped (modifiable) system context.
    
    Returns:
    The unwrapped system context.
  - getGlobalContext
```
public Context getGlobalContext()
```
    Returns:
    Returns the global context, which is the top context within the state machine.
  - getContext
```
public Context getContext(EnterableState state)
```
    Get the context for an EnterableState or create one if not created before.
    
    Parameters:
    state - The EnterableState.
    
    Returns:
    The context.
  - getLastConfiguration
```
public Set<EnterableState> getLastConfiguration(History history)
```
    Get the last configuration for this history.
    
    Parameters:
    history - The history.
    
    Returns:
    Returns the lastConfiguration.
  - setLastConfiguration
```
public void setLastConfiguration(History history,
                        Set<EnterableState> lc)
```
    Set the last configuration for this history.
    
    Parameters:
    history - The history.
    lc - The lastConfiguration to set.
  - resetConfiguration
```
public void resetConfiguration(History history)
```
    Resets the history state.
    Note: used for testing purposes only
    
    Parameters:
    history - The history.

Class SCInstance

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SCInstance

Method Detail

initialize

detach

setInternalIOProcessor

setEvaluator

getEvaluator

setErrorReporter

getStateMachine

setStateMachine

setSingleContext

isSingleContext

cloneDatamodel

getStateConfiguration

getCurrentStatus

isRunning

setRunning

getRootContext

setRootContext

getSystemContext

getGlobalContext

getContext

getLastConfiguration

setLastConfiguration

resetConfiguration