public abstract class JsonElement extends Object
JsonObject
, a JsonArray
, a JsonPrimitive
or a
JsonNull
.Constructor and Description |
---|
JsonElement() |
Modifier and Type | Method and Description |
---|---|
abstract JsonElement |
deepCopy()
Returns a deep copy of this element.
|
BigDecimal |
getAsBigDecimal()
convenience method to get this element as a
BigDecimal . |
BigInteger |
getAsBigInteger()
convenience method to get this element as a
BigInteger . |
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 value.
|
float |
getAsFloat()
convenience method to get this element as a primitive float value.
|
int |
getAsInt()
convenience method to get this element as a primitive integer value.
|
JsonArray |
getAsJsonArray()
convenience method to get this element as a
JsonArray . |
JsonNull |
getAsJsonNull()
convenience method to get this element as a
JsonNull . |
JsonObject |
getAsJsonObject()
convenience method to get this element as a
JsonObject . |
JsonPrimitive |
getAsJsonPrimitive()
convenience method to get this element as a
JsonPrimitive . |
long |
getAsLong()
convenience method to get this element as a primitive long value.
|
Number |
getAsNumber()
convenience method to get this element as a
Number . |
short |
getAsShort()
convenience method to get this element as a primitive short value.
|
String |
getAsString()
convenience method to get this element as a string value.
|
boolean |
isJsonArray()
provides check for verifying if this element is an array or not.
|
boolean |
isJsonNull()
provides check for verifying if this element represents a null value or not.
|
boolean |
isJsonObject()
provides check for verifying if this element is a Json object or not.
|
boolean |
isJsonPrimitive()
provides check for verifying if this element is a primitive or not.
|
String |
toString()
Returns a String representation of this element.
|
public abstract JsonElement deepCopy()
public boolean isJsonArray()
JsonArray
, false otherwise.public boolean isJsonObject()
JsonObject
, false otherwise.public boolean isJsonPrimitive()
JsonPrimitive
, false
otherwise.public boolean isJsonNull()
JsonNull
, false otherwise.public JsonObject getAsJsonObject()
JsonObject
. If the
element is of some other type, a IllegalStateException
will result.
Hence it is best to use this method after ensuring that this element is of
the desired type by calling isJsonObject()
first.JsonObject
.IllegalStateException
- if the element is of another type.public JsonArray getAsJsonArray()
JsonArray
. If the element
is of some other type, a IllegalStateException
will result. Hence it
is best to use this method after ensuring that this element is of the desired
type by calling isJsonArray()
first.JsonArray
.IllegalStateException
- if the element is of another type.public JsonPrimitive getAsJsonPrimitive()
JsonPrimitive
. If the
element is of some other type, a IllegalStateException
will result.
Hence it is best to use this method after ensuring that this element is of
the desired type by calling isJsonPrimitive()
first.JsonPrimitive
.IllegalStateException
- if the element is of another type.public JsonNull getAsJsonNull()
JsonNull
. If the element
is of some other type, a IllegalStateException
will result. Hence it
is best to use this method after ensuring that this element is of the desired
type by calling isJsonNull()
first.JsonNull
.IllegalStateException
- if the element is of another type.public boolean getAsBoolean()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid
boolean value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public Number getAsNumber()
Number
.Number
.ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid
number.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public String getAsString()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid string
value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public double getAsDouble()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid double
value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public float getAsFloat()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid float
value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public long getAsLong()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid long
value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public int getAsInt()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid
integer value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public byte getAsByte()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid byte
value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public char getAsCharacter()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid char
value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public BigDecimal getAsBigDecimal()
BigDecimal
.BigDecimal
.ClassCastException
- if the element is of not a
JsonPrimitive
. * @throws
NumberFormatException if the element is not a
valid BigDecimal
.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public BigInteger getAsBigInteger()
BigInteger
.BigInteger
.ClassCastException
- if the element is of not a
JsonPrimitive
.NumberFormatException
- if the element is not a valid
BigInteger
.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.public short getAsShort()
ClassCastException
- if the element is of not a
JsonPrimitive
and is not a valid short
value.IllegalStateException
- if the element is of the type JsonArray
but contains more than a single element.