Class DocumentPrimitive

  • All Implemented Interfaces:
    java.io.Serializable

    public final class DocumentPrimitive
    extends DocumentElement
    A class representing a Json primitive value. A primitive value is either a String, a Java primitive, or a Java primitive wrapper type.
    See Also:
    Serialized Form
    • Constructor Detail

      • DocumentPrimitive

        public DocumentPrimitive​(java.lang.Boolean bool)
        Create a primitive containing a boolean value.
        Parameters:
        bool - the value to create the primitive with.
      • DocumentPrimitive

        public DocumentPrimitive​(java.lang.Number number)
        Create a primitive containing a Number.
        Parameters:
        number - the value to create the primitive with.
      • DocumentPrimitive

        public DocumentPrimitive​(java.lang.String string)
        Create a primitive containing a String value.
        Parameters:
        string - the value to create the primitive with.
      • DocumentPrimitive

        public DocumentPrimitive​(java.lang.Character c)
        Create a primitive containing a character. The character is turned into a one character String since Json only supports String.
        Parameters:
        c - the value to create the primitive with.
    • Method Detail

      • toJsonElement

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

        public boolean isBoolean()
        Check whether this primitive contains a boolean value.
        Returns:
        true if this primitive contains a boolean value, false otherwise.
      • getAsBoolean

        public boolean getAsBoolean()
        convenience method to get this element as a boolean value.
        Overrides:
        getAsBoolean in class DocumentElement
        Returns:
        get this element as a primitive boolean value.
      • isNumber

        public boolean isNumber()
        Check whether this primitive contains a Number.
        Returns:
        true if this primitive contains a Number, false otherwise.
      • getAsNumber

        public java.lang.Number getAsNumber()
        convenience method to get this element as a Number.
        Overrides:
        getAsNumber in class DocumentElement
        Returns:
        get this element as a Number.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid Number.
      • isString

        public boolean isString()
        Check whether this primitive contains a String value.
        Returns:
        true if this primitive contains a String value, false otherwise.
      • getAsString

        public java.lang.String getAsString()
        convenience method to get this element as a String.
        Overrides:
        getAsString in class DocumentElement
        Returns:
        get this element as a String.
      • getAsDouble

        public double getAsDouble()
        convenience method to get this element as a primitive double.
        Overrides:
        getAsDouble in class DocumentElement
        Returns:
        get this element as a primitive double.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid double.
      • getAsBigDecimal

        public java.math.BigDecimal getAsBigDecimal()
        convenience method to get this element as a BigDecimal.
        Overrides:
        getAsBigDecimal in class DocumentElement
        Returns:
        get this element as a BigDecimal.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid BigDecimal.
      • getAsBigInteger

        public java.math.BigInteger getAsBigInteger()
        convenience method to get this element as a BigInteger.
        Overrides:
        getAsBigInteger in class DocumentElement
        Returns:
        get this element as a BigInteger.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid BigInteger.
      • getAsFloat

        public float getAsFloat()
        convenience method to get this element as a float.
        Overrides:
        getAsFloat in class DocumentElement
        Returns:
        get this element as a float.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid float.
      • getAsLong

        public long getAsLong()
        convenience method to get this element as a primitive long.
        Overrides:
        getAsLong in class DocumentElement
        Returns:
        get this element as a primitive long.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid long.
      • getAsShort

        public short getAsShort()
        convenience method to get this element as a primitive short.
        Overrides:
        getAsShort in class DocumentElement
        Returns:
        get this element as a primitive short.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid short value.
      • getAsInt

        public int getAsInt()
        convenience method to get this element as a primitive integer.
        Overrides:
        getAsInt in class DocumentElement
        Returns:
        get this element as a primitive integer.
        Throws:
        java.lang.NumberFormatException - if the value contained is not a valid integer.
      • getAsByte

        public byte getAsByte()
        Description copied from class: DocumentElement
        convenience method to get this element as a primitive byte value.
        Overrides:
        getAsByte in class DocumentElement
        Returns:
        get this element as a primitive byte value.
      • getAsCharacter

        public char getAsCharacter()
        Description copied from class: DocumentElement
        convenience method to get this element as a primitive character value.
        Overrides:
        getAsCharacter in class DocumentElement
        Returns:
        get this element as a primitive char value.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object