Package org.openjdk.jmc.common.util

Class StateToolkit

java.lang.Object
org.openjdk.jmc.common.util.StateToolkit
public class StateToolkit extends Object
Toolkit for working with the state interfaces IState, IStateful, and IWritableState.

  • Constructor Details

    • StateToolkit

      public StateToolkit()

  • Method Details

    • saveXMLDocumentTo

      public static void saveXMLDocumentTo(Reader reader, IWritableState state) throws SAXException, IOException, ParserConfigurationException
      Read an XML document from a reader and write its structure to a writable state.
      Parameters:
      reader - reader to read XML from
      state - writable state to write data to
      Throws:
      SAXException
      IOException
      ParserConfigurationException

    • fromXMLString

      public static IState fromXMLString(String document) throws SAXException
      Read an XML document from a string and return its structure as a state.
      Parameters:
      document - string to read XML from
      Returns:
      state reflecting the XML document
      Throws:
      SAXException

    • statefulFromXMLString

      public static IStateful statefulFromXMLString(String document)
      Read an XML document from a string and return its structure as a stateful object.
      Parameters:
      document - string to read XML from
      Returns:
      stateful object reflecting the XML document

    • statefulFromXMLFile

      public static IStateful statefulFromXMLFile(File document, Charset charset)
      Read an XML document from a file and return its structure as a stateful object.
      Parameters:
      document - file to read XML from
      Returns:
      stateful object reflecting the XML document

    • fromXMLFile

      public static IState fromXMLFile(File document) throws SAXException, IOException
      Read an XML document from a file and return its structure as a state.
      Parameters:
      document - file to read XML from
      Returns:
      state reflecting the XML document
      Throws:
      SAXException
      IOException

    • createWriter

      public static IWritableState createWriter(String rootName) throws IOException
      Create a new writable state.
      Parameters:
      rootName - root name of the writable state
      Returns:
      a new writable state
      Throws:
      IOException

    • toXMLString

      public static String toXMLString(IStateful state)
      Write a stateful state as an XML string.
      Parameters:
      state - state to write as XML
      Returns:
      an XML string reflecting the state

    • writeAsXml

      public static void writeAsXml(IStateful state, Writer writer) throws IOException
      Write a stateful state to a reader as an XML string.
      Parameters:
      state - state to write as XML
      writer - write to write the XML to
      Throws:
      IOException

    • writeBoolean

      public static void writeBoolean(IWritableState state, String attribute, Boolean value)
      Write a boolean value to a state.
      Parameters:
      state - state to write to
      attribute - attribute name
      value - attribute value
      See Also:

    • readBoolean

      public static Boolean readBoolean(IState state, String attribute, Boolean defaultValue)
      Read a boolean value from a state.
      Parameters:
      state - state to read from
      attribute - attribute name
      defaultValue - default attribute value
      Returns:
      attribute value if it is set in the state, defaultValue if not
      See Also:

    • writeFloat

      public static void writeFloat(IWritableState state, String attribute, Float value)
      Write a float value to a state.
      Parameters:
      state - state to write to
      attribute - attribute name
      value - attribute value
      See Also:

    • readFloat

      public static Float readFloat(IState state, String attribute, Float defaultValue)
      Read a float value from a state.
      Parameters:
      state - state to read from
      attribute - attribute name
      defaultValue - default attribute value
      Returns:
      attribute value if it is set in the state, defaultValue if not
      See Also:

    • writeInt

      public static void writeInt(IWritableState state, String attribute, Integer value)
      Write an integer value to a state.
      Parameters:
      state - state to write to
      attribute - attribute name
      value - attribute value
      See Also:

    • readInt

      public static Integer readInt(IState state, String attribute, Integer defaultValue)
      Read an integer value from a state.
      Parameters:
      state - state to read from
      attribute - attribute name
      defaultValue - default attribute value
      Returns:
      attribute value if it is set in the state, defaultValue if not
      See Also:

    • writeEnum

      public static <T extends Enum<T>> void writeEnum(IWritableState state, String attribute, T value)
      Write an enum value to a state.
      Parameters:
      state - state to write to
      attribute - attribute name
      value - attribute value
      See Also:

    • readEnum

      public static <T extends Enum<T>> T readEnum(IState state, String attribute, T defaultValue, Class<T> klass)
      Read an enum value from a state.
      Parameters:
      state - state to read from
      attribute - attribute name
      defaultValue - default attribute value
      klass - enum class of the attribute value
      Returns:
      attribute value if it is set in the state, defaultValue if not
      See Also: