JSBindings (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.env.javascript.JSBindings

All Implemented Interfaces:

Map<String,Object>, Bindings
```
public class JSBindings
extends Object
implements Bindings
```
Wrapper class for the JDK Javascript engine Bindings class that extends the wrapped Bindings to search the SCXML context for variables and predefined functions that do not exist in the wrapped Bindings.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

JSBindings(Context context, Bindings bindings)
Initialises the internal Bindings delegate and SCXML context.

Constructors
Constructor and Description
`JSBindings(Context context, Bindings bindings)` Initialises the internal Bindings delegate and SCXML context.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Delegates to the wrapped Bindings `clear` method.
`boolean`	`containsKey(Object key)` Returns `true` if the wrapped Bindings delegate or SCXML context contains a variable identified by `key`.
`boolean`	`containsValue(Object value)` Returns `true` if the wrapped Bindings delegate or SCXML context contains `value`.
`Set<Map.Entry<String,Object>>`	`entrySet()` Returns a union of the wrapped Bindings entry set and the SCXML context entry set.
`Object`	`get(Object key)` Returns the value from the wrapped Bindings delegate or SCXML context contains identified by `key`.
`protected Bindings`	`getGlobalBindings()` Return the global bindings (i.e. nashorn Global instance) set by the script engine if existing.
`protected boolean`	`hasGlobalBindings()` Return true if a global bindings (i.e. nashorn Global instance) was ever set by the script engine.
`boolean`	`isEmpty()` Returns a `true` if both the Bindings delegate and the SCXML context maps are empty.
`Set<String>`	`keySet()` Returns a union of the wrapped Bindings entry set and the SCXML context entry set.
`Object`	`put(String name, Object value)` The following delegation model is used to set values: Delegates to `Context.set(String,Object)` if the `Context` contains the key (name), else Delegates to the wrapped `Bindings.put(String, Object)` if the `Bindings` contains the key (name), else Delegates to `Context.setLocal(String, Object)`
`void`	`putAll(Map<? extends String,? extends Object> toMerge)` Delegates to the wrapped Bindings `putAll` method i.e. does not store variables in the SCXML context.
`Object`	`remove(Object key)` Removes the object from the wrapped Bindings instance or the contained SCXML context.
`int`	`size()` Returns the combined size of the wrapped Bindings entry set and the SCXML context entry set.
`Collection<Object>`	`values()` Returns a union of the wrapped Bindings value list and the SCXML context value list.

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

Methods inherited from interface java.util.Map
equals, hashCode

- Constructor Detail
  - JSBindings
```
public JSBindings(Context context,
          Bindings bindings)
```
    Initialises the internal Bindings delegate and SCXML context.
    
    Parameters:
    context - SCXML Context to use for script variables.
    bindings - Javascript engine bindings for Javascript variables.
    
    Throws:
    
    IllegalArgumentException - Thrown if either context or bindings is null.
- Method Detail
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if the wrapped Bindings delegate or SCXML context contains a variable identified by key.
    
    Specified by:
    
    containsKey in interface Map<String,Object>
    
    Specified by:
    
    containsKey in interface Bindings
  - keySet
```
public Set<String> keySet()
```
    Returns a union of the wrapped Bindings entry set and the SCXML context entry set.
    NOTE: doesn't seem to be invoked ever. Not thread-safe.
    
    Specified by:
    
    keySet in interface Map<String,Object>
  - size
```
public int size()
```
    Returns the combined size of the wrapped Bindings entry set and the SCXML context entry set.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    size in interface Map<String,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if the wrapped Bindings delegate or SCXML context contains value.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    containsValue in interface Map<String,Object>
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Returns a union of the wrapped Bindings entry set and the SCXML context entry set.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    entrySet in interface Map<String,Object>
  - values
```
public Collection<Object> values()
```
    Returns a union of the wrapped Bindings value list and the SCXML context value list.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    values in interface Map<String,Object>
  - isEmpty
```
public boolean isEmpty()
```
    Returns a true if both the Bindings delegate and the SCXML context maps are empty.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    isEmpty in interface Map<String,Object>
  - get
```
public Object get(Object key)
```
    Returns the value from the wrapped Bindings delegate or SCXML context contains identified by key.
    
    Specified by:
    
    get in interface Map<String,Object>
    
    Specified by:
    
    get in interface Bindings
  - put
```
public Object put(String name,
         Object value)
```
    The following delegation model is used to set values:
    1. Delegates to Context.set(String,Object) if the Context contains the key (name), else
    2. Delegates to the wrapped Bindings.put(String, Object) if the Bindings contains the key (name), else
    3. Delegates to Context.setLocal(String, Object)
    Specified by:
    
    put in interface Map<String,Object>
    
    Specified by:
    
    put in interface Bindings
  - putAll
```
public void putAll(Map<? extends String,? extends Object> toMerge)
```
    Delegates to the wrapped Bindings putAll method i.e. does not store variables in the SCXML context.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    putAll in interface Map<String,Object>
    
    Specified by:
    
    putAll in interface Bindings
  - remove
```
public Object remove(Object key)
```
    Removes the object from the wrapped Bindings instance or the contained SCXML context. Not entirely sure about this implementation but it follows the philosophy of using the Javascript Bindings as a child context of the SCXML context.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    remove in interface Map<String,Object>
    
    Specified by:
    
    remove in interface Bindings
  - clear
```
public void clear()
```
    Delegates to the wrapped Bindings clear method. Does not clear the SCXML context.
    NOTE: doesn't seem to be invoked ever so not sure if it works in context. Not thread-safe.
    
    Specified by:
    
    clear in interface Map<String,Object>
  - hasGlobalBindings
```
protected boolean hasGlobalBindings()
```
    Return true if a global bindings (i.e. nashorn Global instance) was ever set by the script engine.
    Note: because the global binding can be set by the script engine when evaluating a script, we should check or retrieve the global binding whenever needed instead of initialization time.
    
    Returns:
    true if a global bindings (i.e. nashorn Global instance) was ever set by the script engine
  - getGlobalBindings
```
protected Bindings getGlobalBindings()
```
    Return the global bindings (i.e. nashorn Global instance) set by the script engine if existing.
    
    Returns:
    the global bindings (i.e. nashorn Global instance) set by the script engine, or null if not existing.

Class JSBindings

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

JSBindings

Method Detail

containsKey

keySet

size

containsValue

entrySet

values

isEmpty

get

put

putAll

remove

clear

hasGlobalBindings

getGlobalBindings