Package com.inductiveautomation.rm.archiver

Class RMJSONArchiver

  • public class RMJSONArchiver
extends java.lang.Object
    An archiver to read/write objects from/to JSON.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  RMJSONArchiver.GetClass
      An interface so objects can provide archival class to archiver.
      static interface  RMJSONArchiver.GetKeys
      An interface so objects can provide archival attributes to archiver.
      static interface  RMJSONArchiver.GetValue
      An interface so objects can provide archival values to archiver.
      static interface  RMJSONArchiver.SetValue
      An interface so objects can set archival values from archiver.

    • Constructor Summary

      Constructors 
      Constructor Description
      RMJSONArchiver()
      Creates a new archiver.
      RMJSONArchiver​(java.lang.String... theImports)
      Creates a new archiver for given import(s).

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      RMJSONArchiver addImport​(java.lang.String... theImports)
      Adds an import.
      protected java.lang.Class getClassForName​(java.lang.String aClassName)
      Returns a class for name.
      protected java.lang.Class getClassForNameImpl​(java.lang.String aClassName)
      Returns a class for name.
      java.lang.String getClassId()
      Returns the class string.
      protected java.lang.String getClassPath​(java.lang.Object anObj)
      Returns a class path for an object (shortend if in imports).
      protected java.lang.String getClassPathImpl​(java.lang.String classPath)
      Returns a class path for an object (shortend if in imports).
      protected java.lang.Object getValue​(java.lang.Object anObj, java.lang.String aKey)
      Returns a value for a key.
      java.lang.Object readObject​(RMJSONNode aNode)
      Read an object from JSON.
      java.lang.Object readObject​(RMJSONNode aNode, java.lang.Object intoObj)
      Read an object from JSON.
      java.lang.Object readObject​(java.lang.Object aSource)
      Read an object from JSON.
      java.lang.Object readObject​(java.lang.Object aSource, java.lang.Object intoObject)
      Read an object from JSON.
      protected void setValue​(java.lang.Object anObj, java.lang.String aKey, java.lang.Object aValue)
      Set a value for a key.
      RMJSONNode writeObject​(java.lang.Object anObj)
      Write an object to JSON.
      RMJSONNode writeObject​(java.lang.Object anObj, RMJSONNode aNode)
      Write an object to JSON.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RMJSONArchiver

        public RMJSONArchiver()
        Creates a new archiver.

      • RMJSONArchiver

        public RMJSONArchiver​(java.lang.String... theImports)
        Creates a new archiver for given import(s).

    • Method Detail

      • getClassId

        public java.lang.String getClassId()
        Returns the class string.

      • readObject

        public java.lang.Object readObject​(RMJSONNode aNode)
        Read an object from JSON.

      • readObject

        public java.lang.Object readObject​(RMJSONNode aNode,
                                   java.lang.Object intoObj)
        Read an object from JSON.

      • writeObject

        public RMJSONNode writeObject​(java.lang.Object anObj)
        Write an object to JSON.

      • writeObject

        public RMJSONNode writeObject​(java.lang.Object anObj,
                              RMJSONNode aNode)
        Write an object to JSON.

      • getValue

        protected java.lang.Object getValue​(java.lang.Object anObj,
                                    java.lang.String aKey)
        Returns a value for a key.

      • setValue

        protected void setValue​(java.lang.Object anObj,
                        java.lang.String aKey,
                        java.lang.Object aValue)
        Set a value for a key.

      • addImport

        public RMJSONArchiver addImport​(java.lang.String... theImports)
        Adds an import.

      • getClassPath

        protected java.lang.String getClassPath​(java.lang.Object anObj)
        Returns a class path for an object (shortend if in imports).

      • getClassPathImpl

        protected java.lang.String getClassPathImpl​(java.lang.String classPath)
        Returns a class path for an object (shortend if in imports).

      • getClassForName

        protected java.lang.Class getClassForName​(java.lang.String aClassName)
        Returns a class for name.

      • getClassForNameImpl

        protected java.lang.Class getClassForNameImpl​(java.lang.String aClassName)
        Returns a class for name.