- java.lang.Object
-
- com.google.gson.JsonElement
-
- com.google.gson.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 ofJsonElement. This allows for a creating a tree of JsonElements. The member elements of this object are maintained in order they were added.- Author:
- Inderjeet Singh, Joel Leitch
-
-
Constructor Summary
Constructors Constructor Description JsonObject()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(String property, JsonElement value)Adds a member, which is a name-value pair, to self.voidaddProperty(String property, Boolean value)Convenience method to add a boolean member.voidaddProperty(String property, Character value)Convenience method to add a char member.voidaddProperty(String property, Number value)Convenience method to add a primitive member.voidaddProperty(String property, String value)Convenience method to add a primitive member.JsonObjectdeepCopy()Creates a deep copy of this element and all its childrenSet<Map.Entry<String,JsonElement>>entrySet()Returns a set of members of this object.booleanequals(Object o)JsonElementget(String memberName)Returns the member with the specified name.JsonArraygetAsJsonArray(String memberName)Convenience method to get the specified member as a JsonArray.JsonObjectgetAsJsonObject(String memberName)Convenience method to get the specified member as a JsonObject.JsonPrimitivegetAsJsonPrimitive(String memberName)Convenience method to get the specified member as a JsonPrimitive element.booleanhas(String memberName)Convenience method to check if a member with the specified name is present in this object.inthashCode()Set<String>keySet()Returns a set of members key values.JsonElementremove(String property)Removes thepropertyfrom thisJsonObject.intsize()Returns the number of key/value pairs in the object.-
Methods inherited from class com.google.gson.JsonElement
getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsByte, getAsCharacter, getAsDouble, getAsFloat, getAsInt, getAsJsonArray, getAsJsonNull, getAsJsonObject, getAsJsonPrimitive, getAsLong, getAsNumber, getAsShort, getAsString, isJsonArray, isJsonNull, isJsonObject, isJsonPrimitive, toString
-
-
-
-
Method Detail
-
deepCopy
public JsonObject deepCopy()
Creates a deep copy of this element and all its children- Specified by:
deepCopyin classJsonElement- Since:
- 2.8.2
-
add
public void add(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(String property)
Removes thepropertyfrom thisJsonObject.- Parameters:
property- name of the member that should be removed.- Returns:
- the
JsonElementobject that is being removed. - Since:
- 1.3
-
addProperty
public void addProperty(String property, 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(String property, 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(String property, 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(String property, 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 Set<Map.Entry<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 Set<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(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(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(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(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(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.
-
-