SCXMLTestHelper (Apache Commons SCXML 2.0-SNAPSHOT Test API)

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

public class SCXMLTestHelper
extends Object

Helper methods for running SCXML unit tests.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZATION_DIR` Serialized Commons SCXML object model temporary store.
`static String`	`SERIALIZATION_FILE_PREFIX`
`static String`	`SERIALIZATION_FILE_SUFFIX`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`assertPostTriggerState(SCXMLExecutor exec, String triggerEventName, Object payload, String expectedStateId)`
`static void`	`assertPostTriggerState(SCXMLExecutor exec, String triggerEventName, String expectedStateId)`
`static void`	`assertPostTriggerState(SCXMLExecutor exec, TriggerEvent triggerEvent, String expectedStateId)`
`static void`	`assertPostTriggerStates(SCXMLExecutor exec, String triggerEventName, Object payload, String[] expectedStateIds)`
`static void`	`assertPostTriggerStates(SCXMLExecutor exec, String triggerEventName, String[] expectedStateIds)`
`static void`	`assertPostTriggerStates(SCXMLExecutor exec, TriggerEvent triggerEvent, String[] expectedStateIds)`
`static void`	`assertState(SCXMLExecutor exec, String expectedStateId)`
`static Set<EnterableState>`	`fireEvent(SCXMLExecutor exec, String name)`
`static Set<EnterableState>`	`fireEvent(SCXMLExecutor exec, String name, Object payload)`
`static Set<EnterableState>`	`fireEvent(SCXMLExecutor exec, TriggerEvent te)`
`static Set<EnterableState>`	`fireEvents(SCXMLExecutor exec, TriggerEvent[] evts)`
`static SCXMLExecutor`	`getExecutor(SCXML scxml)`
`static SCXMLExecutor`	`getExecutor(SCXML scxml, Evaluator evaluator)`
`static SCXMLExecutor`	`getExecutor(SCXML scxml, Evaluator evaluator, EventDispatcher eventDispatcher)`
`static SCXMLExecutor`	`getExecutor(String scxmlResource)`
`static SCXMLExecutor`	`getExecutor(URL url)`
`static SCXMLExecutor`	`getExecutor(URL url, Evaluator evaluator)`
`static URL`	`getResource(String name)`
`static Context`	`lookupContext(SCXMLExecutor exec, String id)`
`static TransitionTarget`	`lookupTransitionTarget(SCXMLExecutor exec, String id)`
`static SCXML`	`parse(Reader scxmlReader, List<CustomAction> customActions)`
`static SCXML`	`parse(String scxmlResource)`
`static SCXML`	`parse(String scxmlResource, List<CustomAction> customActions)`
`static SCXML`	`parse(URL url)`
`static SCXML`	`parse(URL url, List<CustomAction> customActions)`
`static Document`	`stringToXMLDocument(String xml)` Parses a String containing XML source into a `Document`.
`static SCXMLExecutor`	`testInstanceSerializability(SCXMLExecutor exec)`
`static SCXML`	`testModelSerializability(SCXML scxml)`

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

Field Detail
- SERIALIZATION_DIR
```
public static final String SERIALIZATION_DIR
```
  Serialized Commons SCXML object model temporary store. Assumes the default build artifacts are generated in the "target" directory (so it can be removed via a clean build).
  
  See Also:
  Constant Field Values
- SERIALIZATION_FILE_PREFIX
```
public static final String SERIALIZATION_FILE_PREFIX
```
  See Also:
  Constant Field Values
- SERIALIZATION_FILE_SUFFIX
```
public static final String SERIALIZATION_FILE_SUFFIX
```
  See Also:
  Constant Field Values

Method Detail

getResource

public static URL getResource(String name)

parse

public static SCXML parse(String scxmlResource)
                   throws Exception

Throws:: Exception

parse

public static SCXML parse(URL url)
                   throws Exception

Throws:: Exception

parse

public static SCXML parse(String scxmlResource,
          List<CustomAction> customActions)
                   throws Exception

Throws:: Exception

parse

public static SCXML parse(URL url,
          List<CustomAction> customActions)
                   throws Exception

Throws:: Exception

parse

public static SCXML parse(Reader scxmlReader,
          List<CustomAction> customActions)
                   throws Exception

Throws:: Exception

getExecutor

public static SCXMLExecutor getExecutor(URL url)
                                 throws Exception

Throws:: Exception

getExecutor

public static SCXMLExecutor getExecutor(String scxmlResource)
                                 throws Exception

Throws:: Exception

getExecutor

public static SCXMLExecutor getExecutor(SCXML scxml)
                                 throws Exception

Throws:: Exception

getExecutor

public static SCXMLExecutor getExecutor(URL url,
                        Evaluator evaluator)
                                 throws Exception

Throws:: Exception

getExecutor

public static SCXMLExecutor getExecutor(SCXML scxml,
                        Evaluator evaluator)
                                 throws Exception

Throws:: Exception

getExecutor

public static SCXMLExecutor getExecutor(SCXML scxml,
                        Evaluator evaluator,
                        EventDispatcher eventDispatcher)
                                 throws Exception

Throws:: Exception

lookupTransitionTarget

public static TransitionTarget lookupTransitionTarget(SCXMLExecutor exec,
                                      String id)

lookupContext

public static Context lookupContext(SCXMLExecutor exec,
                    String id)

assertState

public static void assertState(SCXMLExecutor exec,
               String expectedStateId)
                        throws Exception

Throws:: Exception

fireEvent

public static Set<EnterableState> fireEvent(SCXMLExecutor exec,
                            String name)
                                     throws Exception

Throws:: Exception

fireEvent

public static Set<EnterableState> fireEvent(SCXMLExecutor exec,
                            String name,
                            Object payload)
                                     throws Exception

Throws:: Exception

fireEvent

public static Set<EnterableState> fireEvent(SCXMLExecutor exec,
                            TriggerEvent te)
                                     throws Exception

Throws:: Exception

fireEvents

public static Set<EnterableState> fireEvents(SCXMLExecutor exec,
                             TriggerEvent[] evts)
                                      throws Exception

Throws:: Exception

assertPostTriggerState

public static void assertPostTriggerState(SCXMLExecutor exec,
                          String triggerEventName,
                          String expectedStateId)
                                   throws Exception

Throws:: Exception

assertPostTriggerState

public static void assertPostTriggerState(SCXMLExecutor exec,
                          String triggerEventName,
                          Object payload,
                          String expectedStateId)
                                   throws Exception

Throws:: Exception

assertPostTriggerStates

public static void assertPostTriggerStates(SCXMLExecutor exec,
                           String triggerEventName,
                           String[] expectedStateIds)
                                    throws Exception

Throws:: Exception

assertPostTriggerStates

public static void assertPostTriggerStates(SCXMLExecutor exec,
                           String triggerEventName,
                           Object payload,
                           String[] expectedStateIds)
                                    throws Exception

Throws:: Exception

assertPostTriggerState

public static void assertPostTriggerState(SCXMLExecutor exec,
                          TriggerEvent triggerEvent,
                          String expectedStateId)
                                   throws Exception

Throws:: Exception

assertPostTriggerStates

public static void assertPostTriggerStates(SCXMLExecutor exec,
                           TriggerEvent triggerEvent,
                           String[] expectedStateIds)
                                    throws Exception

Throws:: Exception

testModelSerializability

public static SCXML testModelSerializability(SCXML scxml)
                                      throws Exception

Throws:: Exception

testInstanceSerializability

public static SCXMLExecutor testInstanceSerializability(SCXMLExecutor exec)
                                                 throws Exception

Throws:: Exception

stringToXMLDocument
```
public static Document stringToXMLDocument(String xml)
```
Parses a String containing XML source into a Document.

Parameters:
xml - The XML source as a String.

Returns:
The parsed Document.

Class SCXMLTestHelper

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZATION_DIR

SERIALIZATION_FILE_PREFIX

SERIALIZATION_FILE_SUFFIX

Method Detail

getResource

parse

parse

parse

parse

parse

getExecutor

getExecutor

getExecutor

getExecutor

getExecutor

getExecutor

lookupTransitionTarget

lookupContext

assertState

fireEvent

fireEvent

fireEvent

fireEvents

assertPostTriggerState

assertPostTriggerState

assertPostTriggerStates

assertPostTriggerStates

assertPostTriggerState

assertPostTriggerStates

testModelSerializability

testInstanceSerializability

stringToXMLDocument