SCXMLReader (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.io.SCXMLReader

```
public final class SCXMLReader
extends Object
```
The SCXMLReader provides the ability to read a SCXML document into the Java object model provided in the model package.

See latest version of the SCXML Working Draft for more details.

NOTE: The SCXMLReader assumes that the SCXML document to be parsed is well-formed and correct. If that assumption does not hold, any subsequent behavior is undefined.

Since:

1.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SCXMLReader.Configuration
Configuration for the SCXMLReader.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SCXMLReader.Configuration` Configuration for the `SCXMLReader`.

Method Summary

Methods
Modifier and Type	Method and Description
`static SCXML`	`read(InputStream scxmlStream)` Parse the SCXML document supplied by the given `InputStream`.
`static SCXML`	`read(InputStream scxmlStream, SCXMLReader.Configuration configuration)` Parse the SCXML document supplied by the given `InputStream` with the given `SCXMLReader.Configuration`.
`static SCXML`	`read(Reader scxmlReader)` Parse the SCXML document supplied by the given `Reader`.
`static SCXML`	`read(Reader scxmlReader, SCXMLReader.Configuration configuration)` Parse the SCXML document supplied by the given `Reader` with the given `SCXMLReader.Configuration`.
`static SCXML`	`read(Source scxmlSource)` Parse the SCXML document supplied by the given `Source`.
`static SCXML`	`read(Source scxmlSource, SCXMLReader.Configuration configuration)` Parse the SCXML document supplied by the given `Source` with the given `SCXMLReader.Configuration`.
`static SCXML`	`read(String scxmlPath)` Parse the SCXML document at the supplied path.
`static SCXML`	`read(String scxmlPath, SCXMLReader.Configuration configuration)` Parse the SCXML document at the supplied path with the given `SCXMLReader.Configuration`.
`static SCXML`	`read(URL scxmlURL)` Parse the SCXML document at the supplied `URL`.
`static SCXML`	`read(URL scxmlURL, SCXMLReader.Configuration configuration)` Parse the SCXML document at the supplied `URL` with the given `SCXMLReader.Configuration`.

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

- Method Detail
  - read
```
public static SCXML read(String scxmlPath)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document at the supplied path.
    
    Parameters:
    scxmlPath - The real path to the SCXML document.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(String scxmlPath,
         SCXMLReader.Configuration configuration)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document at the supplied path with the given SCXMLReader.Configuration.
    
    Parameters:
    scxmlPath - The real path to the SCXML document.
    configuration - The SCXMLReader.Configuration to use when parsing the SCXML document.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(URL scxmlURL)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document at the supplied URL.
    
    Parameters:
    scxmlURL - The SCXML document URL to parse.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(URL scxmlURL,
         SCXMLReader.Configuration configuration)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document at the supplied URL with the given SCXMLReader.Configuration.
    
    Parameters:
    scxmlURL - The SCXML document URL to parse.
    configuration - The SCXMLReader.Configuration to use when parsing the SCXML document.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(InputStream scxmlStream)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document supplied by the given InputStream.
    
    Parameters:
    scxmlStream - The InputStream supplying the SCXML document to parse.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(InputStream scxmlStream,
         SCXMLReader.Configuration configuration)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document supplied by the given InputStream with the given SCXMLReader.Configuration.
    
    Parameters:
    scxmlStream - The InputStream supplying the SCXML document to parse.
    configuration - The SCXMLReader.Configuration to use when parsing the SCXML document.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(Reader scxmlReader)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document supplied by the given Reader.
    
    Parameters:
    scxmlReader - The Reader supplying the SCXML document to parse.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(Reader scxmlReader,
         SCXMLReader.Configuration configuration)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document supplied by the given Reader with the given SCXMLReader.Configuration.
    
    Parameters:
    scxmlReader - The Reader supplying the SCXML document to parse.
    configuration - The SCXMLReader.Configuration to use when parsing the SCXML document.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(Source scxmlSource)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document supplied by the given Source.
    
    Parameters:
    scxmlSource - The Source supplying the SCXML document to parse.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.
  - read
```
public static SCXML read(Source scxmlSource,
         SCXMLReader.Configuration configuration)
                  throws IOException,
                         ModelException,
                         XMLStreamException
```
    Parse the SCXML document supplied by the given Source with the given SCXMLReader.Configuration.
    
    Parameters:
    scxmlSource - The Source supplying the SCXML document to parse.
    configuration - The SCXMLReader.Configuration to use when parsing the SCXML document.
    
    Returns:
    The parsed output, the Commons SCXML object model corresponding to the SCXML document.
    
    Throws:
    
    IOException - An IO error during parsing.
    
    ModelException - The Commons SCXML object model is incomplete or inconsistent (includes errors in the SCXML document that may not be identified by the schema).
    
    XMLStreamException - An exception processing the underlying XMLStreamReader.

Class SCXMLReader

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

read

read

read

read

read

read

read

read

read

read