Package com.google.gson

Class JsonObject

  • public final class JsonObject
extends JsonElement
    A class representing an object type in Json. An object consists of name-value pairs where names are strings, and values are any other type of JsonElement. This allows for a creating a tree of JsonElements. The member elements of this object are maintained in order they were added.

    • Constructor Detail

      • JsonObject

        public JsonObject()

    • Method Detail

      • deepCopy

        public JsonObject deepCopy()
        Creates a deep copy of this element and all its children
        Specified by:
        deepCopy in class JsonElement
        Since:
        2.8.2

      • add

        public void add​(java.lang.String property,
                JsonElement value)
        Adds a member, which is a name-value pair, to self. The name must be a String, but the value can be an arbitrary JsonElement, thereby allowing you to build a full tree of JsonElements rooted at this node.
        Parameters:
        property - name of the member.
        value - the member object.

      • remove

        public JsonElement remove​(java.lang.String property)
        Removes the property from this JsonObject.
        Parameters:
        property - name of the member that should be removed.
        Returns:
        the JsonElement object that is being removed.
        Since:
        1.3

      • addProperty

        public void addProperty​(java.lang.String property,
                        java.lang.String value)
        Convenience method to add a primitive member. The specified value is converted to a JsonPrimitive of String.
        Parameters:
        property - name of the member.
        value - the string value associated with the member.

      • addProperty

        public void addProperty​(java.lang.String property,
                        java.lang.Number value)
        Convenience method to add a primitive member. The specified value is converted to a JsonPrimitive of Number.
        Parameters:
        property - name of the member.
        value - the number value associated with the member.

      • addProperty

        public void addProperty​(java.lang.String property,
                        java.lang.Boolean value)
        Convenience method to add a boolean member. The specified value is converted to a JsonPrimitive of Boolean.
        Parameters:
        property - name of the member.
        value - the number value associated with the member.

      • addProperty

        public void addProperty​(java.lang.String property,
                        java.lang.Character value)
        Convenience method to add a char member. The specified value is converted to a JsonPrimitive of Character.
        Parameters:
        property - name of the member.
        value - the number value associated with the member.

      • entrySet

        public java.util.Set<java.util.Map.Entry<java.lang.String,​JsonElement>> entrySet()
        Returns a set of members of this object. The set is ordered, and the order is in which the elements were added.
        Returns:
        a set of members of this object.

      • keySet

        public java.util.Set<java.lang.String> keySet()
        Returns a set of members key values.
        Returns:
        a set of member keys as Strings
        Since:
        2.8.1

      • size

        public int size()
        Returns the number of key/value pairs in the object.
        Returns:
        the number of key/value pairs in the object.

      • has

        public boolean has​(java.lang.String memberName)
        Convenience method to check if a member with the specified name is present in this object.
        Parameters:
        memberName - name of the member that is being checked for presence.
        Returns:
        true if there is a member with the specified name, false otherwise.

      • get

        public JsonElement get​(java.lang.String memberName)
        Returns the member with the specified name.
        Parameters:
        memberName - name of the member that is being requested.
        Returns:
        the member matching the name. Null if no such member exists.

      • getAsJsonPrimitive

        public JsonPrimitive getAsJsonPrimitive​(java.lang.String memberName)
        Convenience method to get the specified member as a JsonPrimitive element.
        Parameters:
        memberName - name of the member being requested.
        Returns:
        the JsonPrimitive corresponding to the specified member.

      • getAsJsonArray

        public JsonArray getAsJsonArray​(java.lang.String memberName)
        Convenience method to get the specified member as a JsonArray.
        Parameters:
        memberName - name of the member being requested.
        Returns:
        the JsonArray corresponding to the specified member.

      • getAsJsonObject

        public JsonObject getAsJsonObject​(java.lang.String memberName)
        Convenience method to get the specified member as a JsonObject.
        Parameters:
        memberName - name of the member being requested.
        Returns:
        the JsonObject corresponding to the specified member.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object