Class JsonObject
- All Implemented Interfaces:
Serializable
,Iterable<JsonObject.Member>
Members can be added using the add(String, ...)
methods which accept instances of JsonValue
,
strings, primitive numbers, and boolean values. To modify certain values of an object, use the
set(String, ...)
methods. Please note that the add
methods are faster than set
as they do not search for existing members. On the other hand, the add
methods do not prevent adding
multiple members with the same name. Duplicate names are discouraged but not prohibited by JSON.
Members can be accessed by their name using get(String)
. A list of all names can be obtained from the method
names()
. This class also supports iterating over the members in document order using an iterator()
or an enhanced for loop:
for (Member member : jsonObject) { String name = member.getName(); JsonValue value = member.getValue(); ... }
Even though JSON objects are unordered by definition, instances of this class preserve the order of members to allow processing in document order and to guarantee a predictable output.
Note that this class is not thread-safe. If multiple threads access a JsonObject
instance concurrently, while at least one of these threads modifies the contents of this object, access to the
instance must be synchronized externally. Failure to do so may lead to an inconsistent state.
This class is not supposed to be extended by clients.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Represents a member of a JSON object, a pair of a name and a value. -
Field Summary
Fields inherited from class com.restfb.json.JsonValue
ARRAY_IS_NULL, NAME_IS_NULL, OBJECT_IS_NULL, STRING_IS_NULL, VALUE_IS_NULL
-
Constructor Summary
ConstructorDescriptionCreates a new empty JsonObject.JsonObject
(JsonObject object) Creates a new JsonObject, initialized with the contents of the specified JSON object. -
Method Summary
Modifier and TypeMethodDescriptionAppends a new member to the end of this object, with the specified name and the JSON representation of the specifiedboolean
value.Appends a new member to the end of this object, with the specified name and the JSON representation of the specifieddouble
value.Appends a new member to the end of this object, with the specified name and the JSON representation of the specifiedfloat
value.Appends a new member to the end of this object, with the specified name and the JSON representation of the specifiedint
value.Appends a new member to the end of this object, with the specified name and the JSON representation of the specifiedlong
value.Appends a new member to the end of this object, with the specified name and the specified JSON value.Appends a new member to the end of this object, with the specified name and the JSON representation of the specified string.asObject()
Returns this JSON value asJsonObject
, assuming that this value represents a JSON object.boolean
Checks if a specified member is present as a child of this object.boolean
Indicates whether some other object is "equal to" this one according to the contract specified inObject.equals(Object)
.Returns the value of the member with the specified name in this object.boolean
getBoolean
(String name, boolean defaultValue) Returns theboolean
value of the member with the specified name in this object.double
Returns thedouble
value of the member with the specified name in this object.float
Returns thefloat
value of the member with the specified name in this object.int
Returns theint
value of the member with the specified name in this object.long
Returns thelong
value of the member with the specified name in this object.Returns theString
value of the member with the specified name in this object.int
hashCode()
boolean
isEmpty()
Returnstrue
if this object contains no members.boolean
isObject()
Detects whether this value represents a JSON object.iterator()
Returns an iterator over the members of this object in document order.merge
(JsonObject object) Copies all members of the specified object into this object.names()
Returns a list of the names in this object in document order.Removes a member with the specified name from this object.Sets the value of the member with the specified name to the JSON representation of the specifiedboolean
value.Sets the value of the member with the specified name to the JSON representation of the specifieddouble
value.Sets the value of the member with the specified name to the JSON representation of the specifiedfloat
value.Sets the value of the member with the specified name to the JSON representation of the specifiedint
value.Sets the value of the member with the specified name to the JSON representation of the specifiedlong
value.Sets the value of the member with the specified name to the specified JSON value.Sets the value of the member with the specified name to the JSON representation of the specified string.int
size()
Returns the number of members (name/value pairs) in this object.static JsonObject
unmodifiableObject
(JsonObject object) Returns an unmodifiable JsonObject for the specified one.Methods inherited from class com.restfb.json.JsonValue
asArray, asBoolean, asDouble, asFloat, asInt, asLong, asString, isArray, isBoolean, isFalse, isNull, isNumber, isString, isTrue, toString, toString, writeTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
JsonObject
public JsonObject()Creates a new empty JsonObject. -
JsonObject
Creates a new JsonObject, initialized with the contents of the specified JSON object.- Parameters:
object
- the JSON object to get the initial contents from, must not benull
-
-
Method Details
-
unmodifiableObject
Returns an unmodifiable JsonObject for the specified one. This method allows to provide read-only access to a JsonObject.The returned JsonObject is backed by the given object and reflect changes that happen to it. Attempts to modify the returned JsonObject result in an
UnsupportedOperationException
.- Parameters:
object
- the JsonObject for which an unmodifiable JsonObject is to be returned- Returns:
- an unmodifiable view of the specified JsonObject
-
add
Appends a new member to the end of this object, with the specified name and the JSON representation of the specifiedint
value.This method does not prevent duplicate names. Calling this method with a name that already exists in the object will append another member with the same name. In order to replace existing members, use the method
set(name, value)
instead. However, add is much faster than set (because it does not need to search for existing members). Therefore add should be preferred when constructing new objects.- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
add
Appends a new member to the end of this object, with the specified name and the JSON representation of the specifiedlong
value.This method does not prevent duplicate names. Calling this method with a name that already exists in the object will append another member with the same name. In order to replace existing members, use the method
set(name, value)
instead. However, add is much faster than set (because it does not need to search for existing members). Therefore add should be preferred when constructing new objects.- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
add
Appends a new member to the end of this object, with the specified name and the JSON representation of the specifiedfloat
value.This method does not prevent duplicate names. Calling this method with a name that already exists in the object will append another member with the same name. In order to replace existing members, use the method
set(name, value)
instead. However, add is much faster than set (because it does not need to search for existing members). Therefore add should be preferred when constructing new objects.- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
add
Appends a new member to the end of this object, with the specified name and the JSON representation of the specifieddouble
value.This method does not prevent duplicate names. Calling this method with a name that already exists in the object will append another member with the same name. In order to replace existing members, use the method
set(name, value)
instead. However, add is much faster than set (because it does not need to search for existing members). Therefore add should be preferred when constructing new objects.- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
add
Appends a new member to the end of this object, with the specified name and the JSON representation of the specifiedboolean
value.This method does not prevent duplicate names. Calling this method with a name that already exists in the object will append another member with the same name. In order to replace existing members, use the method
set(name, value)
instead. However, add is much faster than set (because it does not need to search for existing members). Therefore add should be preferred when constructing new objects.- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
add
Appends a new member to the end of this object, with the specified name and the JSON representation of the specified string.This method does not prevent duplicate names. Calling this method with a name that already exists in the object will append another member with the same name. In order to replace existing members, use the method
set(name, value)
instead. However, add is much faster than set (because it does not need to search for existing members). Therefore add should be preferred when constructing new objects.- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
add
Appends a new member to the end of this object, with the specified name and the specified JSON value.This method does not prevent duplicate names. Calling this method with a name that already exists in the object will append another member with the same name. In order to replace existing members, use the method
set(name, value)
instead. However, add is much faster than set (because it does not need to search for existing members). Therefore add should be preferred when constructing new objects.- Parameters:
name
- the name of the member to addvalue
- the value of the member to add, must not benull
- Returns:
- the object itself, to enable method chaining
-
set
Sets the value of the member with the specified name to the JSON representation of the specifiedint
value. If this object does not contain a member with this name, a new member is added at the end of the object. If this object contains multiple members with this name, only the last one is changed.This method should only be used to modify existing objects. To fill a new object with members, the method
add(name, value)
should be preferred which is much faster (as it does not need to search for existing members).- Parameters:
name
- the name of the member to replacevalue
- the value to set to the member- Returns:
- the object itself, to enable method chaining
-
set
Sets the value of the member with the specified name to the JSON representation of the specifiedlong
value. If this object does not contain a member with this name, a new member is added at the end of the object. If this object contains multiple members with this name, only the last one is changed.This method should only be used to modify existing objects. To fill a new object with members, the method
add(name, value)
should be preferred which is much faster (as it does not need to search for existing members).- Parameters:
name
- the name of the member to replacevalue
- the value to set to the member- Returns:
- the object itself, to enable method chaining
-
set
Sets the value of the member with the specified name to the JSON representation of the specifiedfloat
value. If this object does not contain a member with this name, a new member is added at the end of the object. If this object contains multiple members with this name, only the last one is changed.This method should only be used to modify existing objects. To fill a new object with members, the method
add(name, value)
should be preferred which is much faster (as it does not need to search for existing members).- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
set
Sets the value of the member with the specified name to the JSON representation of the specifieddouble
value. If this object does not contain a member with this name, a new member is added at the end of the object. If this object contains multiple members with this name, only the last one is changed.This method should only be used to modify existing objects. To fill a new object with members, the method
add(name, value)
should be preferred which is much faster (as it does not need to search for existing members).- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
set
Sets the value of the member with the specified name to the JSON representation of the specifiedboolean
value. If this object does not contain a member with this name, a new member is added at the end of the object. If this object contains multiple members with this name, only the last one is changed.This method should only be used to modify existing objects. To fill a new object with members, the method
add(name, value)
should be preferred which is much faster (as it does not need to search for existing members).- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
set
Sets the value of the member with the specified name to the JSON representation of the specified string. If this object does not contain a member with this name, a new member is added at the end of the object. If this object contains multiple members with this name, only the last one is changed.This method should only be used to modify existing objects. To fill a new object with members, the method
add(name, value)
should be preferred which is much faster (as it does not need to search for existing members).- Parameters:
name
- the name of the member to addvalue
- the value of the member to add- Returns:
- the object itself, to enable method chaining
-
set
Sets the value of the member with the specified name to the specified JSON value. If this object does not contain a member with this name, a new member is added at the end of the object. If this object contains multiple members with this name, only the last one is changed.This method should only be used to modify existing objects. To fill a new object with members, the method
add(name, value)
should be preferred which is much faster (as it does not need to search for existing members).- Parameters:
name
- the name of the member to addvalue
- the value of the member to add, must not benull
- Returns:
- the object itself, to enable method chaining
-
remove
Removes a member with the specified name from this object. If this object contains multiple members with the given name, only the last one is removed. If this object does not contain a member with the specified name, the object is not modified.- Parameters:
name
- the name of the member to remove- Returns:
- the object itself, to enable method chaining
-
contains
Checks if a specified member is present as a child of this object. This will not test if this object contains the literalnull
,JsonValue.isNull()
should be used for this purpose.- Parameters:
name
- the name of the member to check for- Returns:
- whether or not the member is present
-
merge
Copies all members of the specified object into this object. When the specified object contains members with names that also exist in this object, the existing values in this object will be replaced by the corresponding values in the specified object.- Parameters:
object
- the object to merge- Returns:
- the object itself, to enable method chaining
-
get
Returns the value of the member with the specified name in this object. If this object contains multiple members with the given name, this method will return the last one.- Parameters:
name
- the name of the member whose value is to be returned- Returns:
- the value of the last member with the specified name, or
null
if this object does not contain a member with that name
-
getInt
Returns theint
value of the member with the specified name in this object. If this object does not contain a member with this name, the given default value is returned. If this object contains multiple members with the given name, the last one will be picked. If this member's value does not represent a JSON number or if it cannot be interpreted as Javaint
, an exception is thrown.- Parameters:
name
- the name of the member whose value is to be returneddefaultValue
- the value to be returned if the requested member is missing- Returns:
- the value of the last member with the specified name, or the given default value if this object does not contain a member with that name
-
getLong
Returns thelong
value of the member with the specified name in this object. If this object does not contain a member with this name, the given default value is returned. If this object contains multiple members with the given name, the last one will be picked. If this member's value does not represent a JSON number or if it cannot be interpreted as Javalong
, an exception is thrown.- Parameters:
name
- the name of the member whose value is to be returneddefaultValue
- the value to be returned if the requested member is missing- Returns:
- the value of the last member with the specified name, or the given default value if this object does not contain a member with that name
-
getFloat
Returns thefloat
value of the member with the specified name in this object. If this object does not contain a member with this name, the given default value is returned. If this object contains multiple members with the given name, the last one will be picked. If this member's value does not represent a JSON number or if it cannot be interpreted as Javafloat
, an exception is thrown.- Parameters:
name
- the name of the member whose value is to be returneddefaultValue
- the value to be returned if the requested member is missing- Returns:
- the value of the last member with the specified name, or the given default value if this object does not contain a member with that name
-
getDouble
Returns thedouble
value of the member with the specified name in this object. If this object does not contain a member with this name, the given default value is returned. If this object contains multiple members with the given name, the last one will be picked. If this member's value does not represent a JSON number or if it cannot be interpreted as Javadouble
, an exception is thrown.- Parameters:
name
- the name of the member whose value is to be returneddefaultValue
- the value to be returned if the requested member is missing- Returns:
- the value of the last member with the specified name, or the given default value if this object does not contain a member with that name
-
getBoolean
Returns theboolean
value of the member with the specified name in this object. If this object does not contain a member with this name, the given default value is returned. If this object contains multiple members with the given name, the last one will be picked. If this member's value does not represent a JSONtrue
orfalse
value, an exception is thrown.- Parameters:
name
- the name of the member whose value is to be returneddefaultValue
- the value to be returned if the requested member is missing- Returns:
- the value of the last member with the specified name, or the given default value if this object does not contain a member with that name
-
getString
Returns theString
value of the member with the specified name in this object. If this object does not contain a member with this name, the given default value is returned. If this object contains multiple members with the given name, the last one is picked. If this member's value does not represent a JSON string, an exception is thrown.- Parameters:
name
- the name of the member whose value is to be returneddefaultValue
- the value to be returned if the requested member is missing- Returns:
- the value of the last member with the specified name, or the given default value if this object does not contain a member with that name
-
size
Returns the number of members (name/value pairs) in this object.- Returns:
- the number of members in this object
-
isEmpty
Returnstrue
if this object contains no members.- Returns:
true
if this object contains no members
-
names
Returns a list of the names in this object in document order. The returned list is backed by this object and will reflect subsequent changes. It cannot be used to modify this object. Attempts to modify the returned list will result in an exception.- Returns:
- a list of the names in this object
-
iterator
Returns an iterator over the members of this object in document order. The returned iterator cannot be used to modify this object.- Specified by:
iterator
in interfaceIterable<JsonObject.Member>
- Returns:
- an iterator over the members of this object
-
isObject
Description copied from class:JsonValue
Detects whether this value represents a JSON object. If this is the case, this value is an instance ofJsonObject
. -
asObject
Description copied from class:JsonValue
Returns this JSON value asJsonObject
, assuming that this value represents a JSON object. If this is not the case, an exception is thrown. -
hashCode
-
equals
Description copied from class:JsonValue
Indicates whether some other object is "equal to" this one according to the contract specified inObject.equals(Object)
.Two JsonValues are considered equal if and only if they represent the same JSON text. As a consequence, two given JsonObjects may be different even though they contain the same set of names with the same values, but in a different order.
-