Package com.google.gson
Class JsonPrimitive
java.lang.Object
com.google.gson.JsonElement
com.google.gson.JsonPrimitive
A class representing a Json primitive value. A primitive value
is either a String, a Java primitive, or a Java primitive
wrapper type.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionJsonPrimitive
(Boolean bool) Create a primitive containing a boolean value.Create a primitive containing a character.JsonPrimitive
(Number number) Create a primitive containing aNumber
.JsonPrimitive
(String string) Create a primitive containing a String value. -
Method Summary
Modifier and TypeMethodDescriptiondeepCopy()
Returns the same value as primitives are immutable.boolean
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
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.double
convenience method to get this element as a primitive double.float
convenience method to get this element as a float.int
getAsInt()
convenience method to get this element as a primitive integer.long
convenience method to get this element as a primitive long.convenience method to get this element as a Number.short
convenience method to get this element as a primitive short.convenience method to get this element as a String.int
hashCode()
boolean
Check whether this primitive contains a boolean value.private static boolean
isIntegral
(JsonPrimitive primitive) Returns true if the specified number is an integral type (Long, Integer, Short, Byte, BigInteger)boolean
isNumber()
Check whether this primitive contains a Number.boolean
isString()
Check whether this primitive contains a String value.Methods inherited from class com.google.gson.JsonElement
getAsJsonArray, getAsJsonNull, getAsJsonObject, getAsJsonPrimitive, isJsonArray, isJsonNull, isJsonObject, isJsonPrimitive, toString
-
Field Details
-
value
-
-
Constructor Details
-
JsonPrimitive
Create a primitive containing a boolean value.- Parameters:
bool
- the value to create the primitive with.
-
JsonPrimitive
Create a primitive containing aNumber
.- Parameters:
number
- the value to create the primitive with.
-
JsonPrimitive
Create a primitive containing a String value.- Parameters:
string
- the value to create the primitive with.
-
JsonPrimitive
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 Details
-
deepCopy
Returns the same value as primitives are immutable.- Specified by:
deepCopy
in classJsonElement
- Since:
- 2.8.2
-
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 classJsonElement
- 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
convenience method to get this element as a Number.- Overrides:
getAsNumber
in classJsonElement
- Returns:
- get this element as a Number.
- Throws:
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
convenience method to get this element as a String.- Overrides:
getAsString
in classJsonElement
- Returns:
- get this element as a String.
-
getAsDouble
public double getAsDouble()convenience method to get this element as a primitive double.- Overrides:
getAsDouble
in classJsonElement
- Returns:
- get this element as a primitive double.
- Throws:
NumberFormatException
- if the value contained is not a valid double.
-
getAsBigDecimal
convenience method to get this element as aBigDecimal
.- Overrides:
getAsBigDecimal
in classJsonElement
- Returns:
- get this element as a
BigDecimal
. - Throws:
NumberFormatException
- if the value contained is not a validBigDecimal
.
-
getAsBigInteger
convenience method to get this element as aBigInteger
.- Overrides:
getAsBigInteger
in classJsonElement
- Returns:
- get this element as a
BigInteger
. - Throws:
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 classJsonElement
- Returns:
- get this element as a float.
- Throws:
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 classJsonElement
- Returns:
- get this element as a primitive long.
- Throws:
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 classJsonElement
- Returns:
- get this element as a primitive short.
- Throws:
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 classJsonElement
- Returns:
- get this element as a primitive integer.
- Throws:
NumberFormatException
- if the value contained is not a valid integer.
-
getAsByte
public byte getAsByte()Description copied from class:JsonElement
convenience method to get this element as a primitive byte value.- Overrides:
getAsByte
in classJsonElement
- Returns:
- get this element as a primitive byte value.
-
getAsCharacter
public char getAsCharacter()Description copied from class:JsonElement
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.- Overrides:
getAsCharacter
in classJsonElement
- Returns:
- the first character of the string.
-
hashCode
public int hashCode() -
equals
-
isIntegral
Returns true if the specified number is an integral type (Long, Integer, Short, Byte, BigInteger)
-