public class StateToolkit
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
private static class |
StateToolkit.StateHandler
An SAX event handler that saves elements to a
writable state . |
Constructor and Description |
---|
StateToolkit() |
Modifier and Type | Method and Description |
---|---|
static IWritableState |
createWriter(java.lang.String rootName)
Create a new writable state.
|
static IState |
fromXMLFile(java.io.File document)
Read an XML document from a file and return its structure as a
state . |
static IState |
fromXMLString(java.lang.String document)
Read an XML document from a string and return its structure as a
state . |
static java.lang.Boolean |
readBoolean(IState state,
java.lang.String attribute,
java.lang.Boolean defaultValue)
Read a boolean value from a state.
|
static <T extends java.lang.Enum<T>> |
readEnum(IState state,
java.lang.String attribute,
T defaultValue,
java.lang.Class<T> klass)
Read an enum value from a state.
|
static java.lang.Float |
readFloat(IState state,
java.lang.String attribute,
java.lang.Float defaultValue)
Read a float value from a state.
|
static java.lang.Integer |
readInt(IState state,
java.lang.String attribute,
java.lang.Integer defaultValue)
Read an integer value from a state.
|
static void |
saveXMLDocumentTo(java.io.Reader reader,
IWritableState state)
Read an XML document from a reader and write its structure to a
writable state . |
static IStateful |
statefulFromXMLFile(java.io.File document,
java.nio.charset.Charset charset)
Read an XML document from a file and return its structure as a
stateful
object . |
static IStateful |
statefulFromXMLString(java.lang.String document)
Read an XML document from a string and return its structure as a
stateful
object . |
static java.lang.String |
toXMLString(IStateful state)
Write a stateful state as an XML string.
|
static void |
writeAsXml(IStateful state,
java.io.Writer writer)
Write a stateful state to a reader as an XML string.
|
static void |
writeBoolean(IWritableState state,
java.lang.String attribute,
java.lang.Boolean value)
Write a boolean value to a state.
|
static <T extends java.lang.Enum<T>> |
writeEnum(IWritableState state,
java.lang.String attribute,
T value)
Write an enum value to a state.
|
static void |
writeFloat(IWritableState state,
java.lang.String attribute,
java.lang.Float value)
Write a float value to a state.
|
static void |
writeInt(IWritableState state,
java.lang.String attribute,
java.lang.Integer value)
Write an integer value to a state.
|
public static void saveXMLDocumentTo(java.io.Reader reader, IWritableState state) throws org.xml.sax.SAXException, java.io.IOException, javax.xml.parsers.ParserConfigurationException
writable state
.reader
- reader to read XML fromstate
- writable state to write data toorg.xml.sax.SAXException
java.io.IOException
javax.xml.parsers.ParserConfigurationException
public static IState fromXMLString(java.lang.String document) throws org.xml.sax.SAXException
state
.document
- string to read XML fromorg.xml.sax.SAXException
public static IStateful statefulFromXMLString(java.lang.String document)
stateful
object
.document
- string to read XML frompublic static IStateful statefulFromXMLFile(java.io.File document, java.nio.charset.Charset charset)
stateful
object
.document
- file to read XML frompublic static IState fromXMLFile(java.io.File document) throws org.xml.sax.SAXException, java.io.IOException
state
.document
- file to read XML fromorg.xml.sax.SAXException
java.io.IOException
public static IWritableState createWriter(java.lang.String rootName) throws java.io.IOException
rootName
- root name of the writable statejava.io.IOException
public static java.lang.String toXMLString(IStateful state)
state
- state to write as XMLpublic static void writeAsXml(IStateful state, java.io.Writer writer) throws java.io.IOException
state
- state to write as XMLwriter
- write to write the XML tojava.io.IOException
public static void writeBoolean(IWritableState state, java.lang.String attribute, java.lang.Boolean value)
state
- state to write toattribute
- attribute namevalue
- attribute valuereadBoolean(IState, String, Boolean)
public static java.lang.Boolean readBoolean(IState state, java.lang.String attribute, java.lang.Boolean defaultValue)
state
- state to read fromattribute
- attribute namedefaultValue
- default attribute valuedefaultValue
if notwriteBoolean(IWritableState, String, Boolean)
public static void writeFloat(IWritableState state, java.lang.String attribute, java.lang.Float value)
state
- state to write toattribute
- attribute namevalue
- attribute valuereadFloat(IState, String, Float)
public static java.lang.Float readFloat(IState state, java.lang.String attribute, java.lang.Float defaultValue)
state
- state to read fromattribute
- attribute namedefaultValue
- default attribute valuedefaultValue
if notwriteFloat(IWritableState, String, Float)
public static void writeInt(IWritableState state, java.lang.String attribute, java.lang.Integer value)
state
- state to write toattribute
- attribute namevalue
- attribute valuereadInt(IState, String, Integer)
public static java.lang.Integer readInt(IState state, java.lang.String attribute, java.lang.Integer defaultValue)
state
- state to read fromattribute
- attribute namedefaultValue
- default attribute valuedefaultValue
if notwriteInt(IWritableState, String, Integer)
public static <T extends java.lang.Enum<T>> void writeEnum(IWritableState state, java.lang.String attribute, T value)
state
- state to write toattribute
- attribute namevalue
- attribute valuereadEnum(IState, String, Enum, Class)
public static <T extends java.lang.Enum<T>> T readEnum(IState state, java.lang.String attribute, T defaultValue, java.lang.Class<T> klass)
state
- state to read fromattribute
- attribute namedefaultValue
- default attribute valueklass
- enum class of the attribute valuedefaultValue
if notwriteEnum(IWritableState, String, Enum)