Module com.google.gson
Package com.google.gson

Class JsonPrimitive

  • public final class JsonPrimitive
extends JsonElement
    A class representing a JSON primitive value. A primitive value is either a String, a Java primitive, or a Java primitive wrapper type.

    See the JsonElement documentation for details on how to convert JsonPrimitive and generally any JsonElement from and to JSON.

    Author:
    Inderjeet Singh, Joel Leitch

    • Constructor Detail

      • JsonPrimitive

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

      • JsonPrimitive

        public JsonPrimitive​(Number number)
        Create a primitive containing a Number.
        Parameters:
        number - the value to create the primitive with.

      • JsonPrimitive

        public JsonPrimitive​(String string)
        Create a primitive containing a String value.
        Parameters:
        string - the value to create the primitive with.

      • JsonPrimitive

        public JsonPrimitive​(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

      • 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. If this primitive is not a boolean, the string value is parsed using Boolean.parseBoolean(String). This means "true" (ignoring case) is considered true and any other value is considered false.
        Overrides:
        getAsBoolean in class JsonElement
        Returns:
        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.

      • 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 String getAsString()
        Description copied from class: JsonElement
        Convenience method to get this element as a string value.
        Overrides:
        getAsString in class JsonElement
        Returns:
        this element as a string value.

      • getAsDouble

        public double getAsDouble()
        Description copied from class: JsonElement
        Convenience method to get this element as a primitive double value.
        Overrides:
        getAsDouble in class JsonElement
        Returns:
        this element as a primitive double value.
        Throws:
        NumberFormatException - if the value contained is not a valid double.

      • getAsFloat

        public float getAsFloat()
        Description copied from class: JsonElement
        Convenience method to get this element as a primitive float value.
        Overrides:
        getAsFloat in class JsonElement
        Returns:
        this element as a primitive float value.
        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 class JsonElement
        Returns:
        this element as a primitive long.
        Throws:
        NumberFormatException - if the value contained is not a valid long.

      • getAsShort

        public short getAsShort()
        Description copied from class: JsonElement
        Convenience method to get this element as a primitive short value.
        Overrides:
        getAsShort in class JsonElement
        Returns:
        this element as a primitive short value.
        Throws:
        NumberFormatException - if the value contained is not a valid short.

      • getAsInt

        public int getAsInt()
        Description copied from class: JsonElement
        Convenience method to get this element as a primitive integer value.
        Overrides:
        getAsInt in class JsonElement
        Returns:
        this element as a primitive integer value.
        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 class JsonElement
        Returns:
        this element as a primitive byte value.
        Throws:
        NumberFormatException - if the value contained is not a valid byte.

      • getAsCharacter

        @Deprecated
public char getAsCharacter()
        Deprecated.
        This method is misleading, as it does not get this element as a char but rather as a string's first character.
        Description copied from class: JsonElement
        Convenience method to get the first character of the string value of this element.
        Overrides:
        getAsCharacter in class JsonElement
        Returns:
        the first character of the string value.
        Throws:
        UnsupportedOperationException - if the string value of this primitive is empty.

      • hashCode

        public int hashCode()
        Returns the hash code of this object.
        Overrides:
        hashCode in class Object

      • equals

        public boolean equals​(Object obj)
        Returns whether the other object is equal to this. This method only considers the other object to be equal if it is an instance of JsonPrimitive and has an equal value.
        Overrides:
        equals in class Object