Class DocumentPrimitive
- java.lang.Object
-
- com.inductiveautomation.ignition.common.document.DocumentElement
-
- com.inductiveautomation.ignition.common.document.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 Summary
Constructors Constructor Description DocumentPrimitive(java.lang.Boolean bool)
Create a primitive containing a boolean value.DocumentPrimitive(java.lang.Character c)
Create a primitive containing a character.DocumentPrimitive(java.lang.Number number)
Create a primitive containing aNumber
.DocumentPrimitive(java.lang.String string)
Create a primitive containing a String value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentPrimitive
deepCopy()
Returns the same value, as primitives are immutable.boolean
equals(java.lang.Object obj)
java.math.BigDecimal
getAsBigDecimal()
convenience method to get this element as aBigDecimal
.java.math.BigInteger
getAsBigInteger()
convenience method to get this element as aBigInteger
.boolean
getAsBoolean()
convenience method to get this element as a boolean value.byte
getAsByte()
convenience method to get this element as a primitive byte value.char
getAsCharacter()
convenience method to get this element as a primitive character value.double
getAsDouble()
convenience method to get this element as a primitive double.float
getAsFloat()
convenience method to get this element as a float.int
getAsInt()
convenience method to get this element as a primitive integer.long
getAsLong()
convenience method to get this element as a primitive long.java.lang.Number
getAsNumber()
convenience method to get this element as a Number.short
getAsShort()
convenience method to get this element as a primitive short.java.lang.String
getAsString()
convenience method to get this element as a String.int
hashCode()
boolean
isBoolean()
Check whether this primitive contains a boolean value.boolean
isNumber()
Check whether this primitive contains a Number.boolean
isString()
Check whether this primitive contains a String value.com.inductiveautomation.ignition.common.gson.JsonPrimitive
toJsonElement()
-
Methods inherited from class com.inductiveautomation.ignition.common.document.DocumentElement
fromJson, getAsDocument, getAsDocumentArray, getAsDocumentNull, getAsDocumentPrimitive, isDocument, isDocumentArray, isDocumentNull, isDocumentPrimitive, toString
-
-
-
-
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 aNumber
.- 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 classDocumentElement
-
deepCopy
public DocumentPrimitive deepCopy()
Returns the same value, as primitives are immutable.- Specified by:
deepCopy
in classDocumentElement
-
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 classDocumentElement
- 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 classDocumentElement
- 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 classDocumentElement
- Returns:
- get this element as a String.
-
getAsDouble
public double getAsDouble()
convenience method to get this element as a primitive double.- Overrides:
getAsDouble
in classDocumentElement
- 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 aBigDecimal
.- Overrides:
getAsBigDecimal
in classDocumentElement
- Returns:
- get this element as a
BigDecimal
. - Throws:
java.lang.NumberFormatException
- if the value contained is not a validBigDecimal
.
-
getAsBigInteger
public java.math.BigInteger getAsBigInteger()
convenience method to get this element as aBigInteger
.- Overrides:
getAsBigInteger
in classDocumentElement
- Returns:
- get this element as a
BigInteger
. - Throws:
java.lang.NumberFormatException
- if the value contained is not a validBigInteger
.
-
getAsFloat
public float getAsFloat()
convenience method to get this element as a float.- Overrides:
getAsFloat
in classDocumentElement
- 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 classDocumentElement
- 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 classDocumentElement
- 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 classDocumentElement
- 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 classDocumentElement
- 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 classDocumentElement
- Returns:
- get this element as a primitive char value.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-