Package com.google.gson
Class JsonElement
java.lang.Object
com.google.gson.JsonElement
- Direct Known Subclasses:
JsonArray
,JsonNull
,JsonObject
,JsonPrimitive
A class representing an element of Json. It could either be a
JsonObject
, a
JsonArray
, a JsonPrimitive
or a JsonNull
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract JsonElement
deepCopy()
Returns a deep copy of this element.convenience method to get this element as aBigDecimal
.convenience method to get this element as aBigInteger
.boolean
convenience method to get this element as a boolean value.byte
convenience method to get this element as a primitive byte value.char
Deprecated.This method is misleading, as it does not get this element as a char but rather as a string's first character.double
convenience method to get this element as a primitive double value.float
convenience method to get this element as a primitive float value.int
getAsInt()
convenience method to get this element as a primitive integer value.convenience method to get this element as aJsonArray
.convenience method to get this element as aJsonNull
.convenience method to get this element as aJsonObject
.convenience method to get this element as aJsonPrimitive
.long
convenience method to get this element as a primitive long value.convenience method to get this element as aNumber
.short
convenience method to get this element as a primitive short value.convenience method to get this element as a string value.boolean
provides check for verifying if this element is an array or not.boolean
provides check for verifying if this element represents a null value or not.boolean
provides check for verifying if this element is a Json object or not.boolean
provides check for verifying if this element is a primitive or not.toString()
Returns a String representation of this element.
-
Constructor Details
-
JsonElement
public JsonElement()
-
-
Method Details
-
deepCopy
Returns a deep copy of this element. Immutable elements like primitives and nulls are not copied.- Since:
- 2.8.2
-
isJsonArray
public boolean isJsonArray()provides check for verifying if this element is an array or not.- Returns:
- true if this element is of type
JsonArray
, false otherwise.
-
isJsonObject
public boolean isJsonObject()provides check for verifying if this element is a Json object or not.- Returns:
- true if this element is of type
JsonObject
, false otherwise.
-
isJsonPrimitive
public boolean isJsonPrimitive()provides check for verifying if this element is a primitive or not.- Returns:
- true if this element is of type
JsonPrimitive
, false otherwise.
-
isJsonNull
public boolean isJsonNull()provides check for verifying if this element represents a null value or not.- Returns:
- true if this element is of type
JsonNull
, false otherwise. - Since:
- 1.2
-
getAsJsonObject
convenience method to get this element as aJsonObject
. If the element is of some other type, aIllegalStateException
will result. Hence it is best to use this method after ensuring that this element is of the desired type by callingisJsonObject()
first.- Returns:
- get this element as a
JsonObject
. - Throws:
IllegalStateException
- if the element is of another type.
-
getAsJsonArray
convenience method to get this element as aJsonArray
. If the element is of some other type, aIllegalStateException
will result. Hence it is best to use this method after ensuring that this element is of the desired type by callingisJsonArray()
first.- Returns:
- get this element as a
JsonArray
. - Throws:
IllegalStateException
- if the element is of another type.
-
getAsJsonPrimitive
convenience method to get this element as aJsonPrimitive
. If the element is of some other type, aIllegalStateException
will result. Hence it is best to use this method after ensuring that this element is of the desired type by callingisJsonPrimitive()
first.- Returns:
- get this element as a
JsonPrimitive
. - Throws:
IllegalStateException
- if the element is of another type.
-
getAsJsonNull
convenience method to get this element as aJsonNull
. If the element is of some other type, aIllegalStateException
will result. Hence it is best to use this method after ensuring that this element is of the desired type by callingisJsonNull()
first.- Returns:
- get this element as a
JsonNull
. - Throws:
IllegalStateException
- if the element is of another type.- Since:
- 1.2
-
getAsBoolean
public boolean getAsBoolean()convenience method to get this element as a boolean value.- Returns:
- get this element as a primitive boolean value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid boolean value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
getAsNumber
convenience method to get this element as aNumber
.- Returns:
- get this element as a
Number
. - Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid number.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
getAsString
convenience method to get this element as a string value.- Returns:
- get this element as a string value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid string value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
getAsDouble
public double getAsDouble()convenience method to get this element as a primitive double value.- Returns:
- get this element as a primitive double value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid double value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
getAsFloat
public float getAsFloat()convenience method to get this element as a primitive float value.- Returns:
- get this element as a primitive float value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid float value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
getAsLong
public long getAsLong()convenience method to get this element as a primitive long value.- Returns:
- get this element as a primitive long value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid long value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
getAsInt
public int getAsInt()convenience method to get this element as a primitive integer value.- Returns:
- get this element as a primitive integer value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid integer value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
getAsByte
public byte getAsByte()convenience method to get this element as a primitive byte value.- Returns:
- get this element as a primitive byte value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid byte value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.- Since:
- 1.3
-
getAsCharacter
Deprecated.This method is misleading, as it does not get this element as a char but rather as a string's first character.convenience method to get the first character of this element as a string or the first character of this array's first element as a string.- Returns:
- the first character of the string.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid string value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.- Since:
- 1.3
-
getAsBigDecimal
convenience method to get this element as aBigDecimal
.- Returns:
- get this element as a
BigDecimal
. - Throws:
ClassCastException
- if the element is of not aJsonPrimitive
. * @throws NumberFormatException if the element is not a validBigDecimal
.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.- Since:
- 1.2
-
getAsBigInteger
convenience method to get this element as aBigInteger
.- Returns:
- get this element as a
BigInteger
. - Throws:
ClassCastException
- if the element is of not aJsonPrimitive
.NumberFormatException
- if the element is not a validBigInteger
.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.- Since:
- 1.2
-
getAsShort
public short getAsShort()convenience method to get this element as a primitive short value.- Returns:
- get this element as a primitive short value.
- Throws:
ClassCastException
- if the element is of not aJsonPrimitive
and is not a valid short value.IllegalStateException
- if the element is of the typeJsonArray
but contains more than a single element.
-
toString
Returns a String representation of this element.
-