Package com.inductiveautomation.ignition.common.document

Class Document

java.lang.Object
com.inductiveautomation.ignition.common.document.DocumentElement
com.inductiveautomation.ignition.common.document.Document
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ExtendedDocument
public class Document extends DocumentElement
A class representing an object type in Json. An object consists of name-value pairs where names are strings, and values are any other type of DocumentElement. This allows for a creating a tree of DocumentElements. The member elements of this object are maintained in order they were added.
See Also:

  • Field Details

  • Constructor Details

    • Document

      public Document()

    • Document

      public Document(int size)

    • Document

      public Document(com.inductiveautomation.ignition.common.gson.JsonObject json)

  • Method Details

    • deepCopy

      public Document deepCopy()
      Creates a deep copy of this element and all its children
      Specified by:
      deepCopy in class DocumentElement

    • toJsonElement

      public com.inductiveautomation.ignition.common.gson.JsonObject toJsonElement()
      Specified by:
      toJsonElement in class DocumentElement

    • add

      public void add(String property, DocumentElement value)
      Adds a member, which is a name-value pair, to self. The name must be a String, but the value can be an arbitrary DocumentElement, thereby allowing you to build a full tree of DocumentElements rooted at this node.
      Parameters:
      property - name of the member.
      value - the member object.

    • remove

      public DocumentElement remove(String property)
      Removes the property from this Document.
      Parameters:
      property - name of the member that should be removed.
      Returns:
      the DocumentElement object that is being removed.

    • add

      public void add(String property, String value)
      Convenience method to add a primitive member. The specified value is converted to a JsonPrimitive of String.
      Parameters:
      property - name of the member.
      value - the string value associated with the member.

    • add

      public void add(String property, Number value)
      Convenience method to add a primitive member. The specified value is converted to a JsonPrimitive of Number.
      Parameters:
      property - name of the member.
      value - the number value associated with the member.

    • add

      public void add(String property, Boolean value)
      Convenience method to add a boolean member. The specified value is converted to a JsonPrimitive of Boolean.
      Parameters:
      property - name of the member.
      value - the number value associated with the member.

    • add

      public void add(String property, Character value)
      Convenience method to add a char member. The specified value is converted to a JsonPrimitive of Character.
      Parameters:
      property - name of the member.
      value - the number value associated with the member.

    • addProperty

      public void addProperty(String property, Object value)

    • createDocumentElement

      public static DocumentElement createDocumentElement(Object value)
      Creates the proper DocumentElement object from the given value object. Supports arrays of primatives or DocumentElement, or scalar primatives.
      Parameters:
      value - the object to generate the DocumentElement for
      Returns:
      a DocumentElement if the value is not null, otherwise a JsonNull

    • unsafeEntrySet

      protected Set<Map.Entry<String,DocumentElement>> unsafeEntrySet()

    • entrySet

      public Set<Map.Entry<String,DocumentElement>> entrySet()
      Returns a set of members of this object. The set is ordered, and the order is in which the elements were added.
      Returns:
      a set of members of this object.

    • keySet

      public Set<String> keySet()
      Returns a set of members key values.
      Returns:
      a set of member keys as Strings

    • size

      public int size()
      Returns the number of key/value pairs in the object.
      Returns:
      the number of key/value pairs in the object.

    • has

      public boolean has(String memberName)
      Convenience method to check if a member with the specified name is present in this object.
      Parameters:
      memberName - name of the member that is being checked for presence.
      Returns:
      true if there is a member with the specified name, false otherwise.

    • get

      public DocumentElement get(String memberName)
      Returns the member with the specified name.
      Parameters:
      memberName - name of the member that is being requested.
      Returns:
      the member matching the name. Null if no such member exists.

    • getAsDocumentPrimitive

      public DocumentPrimitive getAsDocumentPrimitive(String memberName)
      Convenience method to get the specified member as a JsonPrimitive element.
      Parameters:
      memberName - name of the member being requested.
      Returns:
      the JsonPrimitive corresponding to the specified member.

    • getAsDocumentArray

      public DocumentArray getAsDocumentArray(String memberName)
      Convenience method to get the specified member as a JsonArray.
      Parameters:
      memberName - name of the member being requested.
      Returns:
      the JsonArray corresponding to the specified member.

    • getAsDocument

      public Document getAsDocument(String memberName)
      Convenience method to get the specified member as a Document.
      Parameters:
      memberName - name of the member being requested.
      Returns:
      the Document corresponding to the specified member.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object