SCXMLSystemContext (Apache Commons SCXML 2.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Context
```
public class SCXMLSystemContext
extends Object
implements Context, Serializable
```
The SCXMLSystemContext is used as a read only Context wrapper and provides the SCXML (read only) system variables which are injected via the unwrapped getContext().

See Also:
http://www.w3.org/TR/scxml/#SystemVariables, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EVENT_KEY` The protected system variables names as defined in the SCXML specification
`static String`	`IOPROCESSORS_KEY`
`static String`	`SCXML_NAME_KEY`
`static String`	`SESSIONID_KEY`
`static String`	`STATUS_KEY` The Commons SCXML internal `platform variable key` holding the current SCXML status instance
`static String`	`X_KEY`

Fields inherited from interface org.apache.commons.scxml2.Context
NAMESPACES_KEY

Constructor Summary

Constructors
Constructor and Description

SCXMLSystemContext(Context systemContext)

Constructors
Constructor and Description
`SCXMLSystemContext(Context systemContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`generateSessionId()`
`Object`	`get(String name)` Get the value of this variable; delegating to parent.
`Context`	`getParent()` Get the parent Context, may be null.
`Map<String,Object>`	`getPlatformVariables()`
`SCXMLSystemContext`	`getSystemContext()` Get the SCXMLSystemContext for this Context, should not be null unless this is the root Context
`Map<String,Object>`	`getVars()` Get the Map of all variables in this Context.
`boolean`	`has(String name)` Check if this variable exists, delegating to parent.
`boolean`	`hasLocal(String name)` Check if this variable exists, only checking this Context
`void`	`reset()` Clear this Context.
`void`	`set(String name, Object value)` Assigns a new value to an existing variable or creates a new one.
`void`	`setLocal(String name, Object value)` Assigns a new value to an existing variable or creates a new one.

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

- Field Detail
  - EVENT_KEY
```
public static final String EVENT_KEY
```
    The protected system variables names as defined in the SCXML specification
    
    See Also:
    http://www.w3.org/TR/scxml/#SystemVariables, Constant Field Values
  - SESSIONID_KEY
```
public static final String SESSIONID_KEY
```
    See Also:
    Constant Field Values
  - SCXML_NAME_KEY
```
public static final String SCXML_NAME_KEY
```
    See Also:
    Constant Field Values
  - IOPROCESSORS_KEY
```
public static final String IOPROCESSORS_KEY
```
    See Also:
    Constant Field Values
  - X_KEY
```
public static final String X_KEY
```
    See Also:
    Constant Field Values
  - STATUS_KEY
```
public static final String STATUS_KEY
```
    The Commons SCXML internal platform variable key holding the current SCXML status instance
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SCXMLSystemContext
```
public SCXMLSystemContext(Context systemContext)
```
- Method Detail
  - generateSessionId
```
public String generateSessionId()
```
  - set
```
public void set(String name,
       Object value)
```
    Description copied from interface: Context
    
    Assigns a new value to an existing variable or creates a new one. The method searches the chain of parent Contexts for variable existence.
    
    Specified by:
    
    set in interface Context
    
    Parameters:
    name - The variable name
    value - The variable value
  - setLocal
```
public void setLocal(String name,
            Object value)
```
    Description copied from interface: Context
    
    Assigns a new value to an existing variable or creates a new one. The method allows to shaddow a variable of the same name up the Context chain.
    
    Specified by:
    
    setLocal in interface Context
    
    Parameters:
    name - The variable name
    value - The variable value
  - get
```
public Object get(String name)
```
    Description copied from interface: Context
    
    Get the value of this variable; delegating to parent.
    
    Specified by:
    
    get in interface Context
    
    Parameters:
    name - The name of the variable
    
    Returns:
    The value (or null)
  - has
```
public boolean has(String name)
```
    Description copied from interface: Context
    
    Check if this variable exists, delegating to parent.
    
    Specified by:
    
    has in interface Context
    
    Parameters:
    name - The name of the variable
    
    Returns:
    Whether a variable with the name exists in this Context
  - hasLocal
```
public boolean hasLocal(String name)
```
    Description copied from interface: Context
    
    Check if this variable exists, only checking this Context
    
    Specified by:
    
    hasLocal in interface Context
    
    Parameters:
    name - The name of the variable
    
    Returns:
    Whether a variable with the name exists in this Context
  - getVars
```
public Map<String,Object> getVars()
```
    Description copied from interface: Context
    
    Get the Map of all variables in this Context.
    
    Specified by:
    
    getVars in interface Context
    
    Returns:
    Local variable entries Map To get variables in parent Context, call getParent().getVars().
    See Also:
    Context.getParent()
  - reset
```
public void reset()
```
    Description copied from interface: Context
    
    Clear this Context.
    
    Specified by:
    
    reset in interface Context
  - getParent
```
public Context getParent()
```
    Description copied from interface: Context
    
    Get the parent Context, may be null.
    
    Specified by:
    
    getParent in interface Context
    
    Returns:
    The parent Context in a chained Context environment
  - getSystemContext
```
public SCXMLSystemContext getSystemContext()
```
    Description copied from interface: Context
    
    Get the SCXMLSystemContext for this Context, should not be null unless this is the root Context
    
    Specified by:
    
    getSystemContext in interface Context
    
    Returns:
    The SCXMLSystemContext in a chained Context environment
  - getPlatformVariables
```
public Map<String,Object> getPlatformVariables()
```
    Returns:
    The Platform specific system variables map stored under the _x root system variable

Class SCXMLSystemContext

Field Summary

Fields inherited from interface org.apache.commons.scxml2.Context

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EVENT_KEY

SESSIONID_KEY

SCXML_NAME_KEY

IOPROCESSORS_KEY

X_KEY

STATUS_KEY

Constructor Detail

SCXMLSystemContext

Method Detail

generateSessionId

set

setLocal

get

has

hasLocal

getVars

reset

getParent

getSystemContext

getPlatformVariables