public interface JsonObject extends JsonStructure, java.util.Map<java.lang.String,JsonValue>
JsonObject
class represents an immutable JSON object value
(an unordered collection of zero or more name/value pairs).
It also provides unmodifiable map view to the JSON object
name/value mappings.
A JsonObject instance can be created from an input source using
JsonReader.readObject()
. For example:
JsonReader jsonReader = Json.createReader(...);
JsonObject object = jsonReader.readObject();
jsonReader.close();
It can also be built from scratch using a JsonObjectBuilder
.
For example 1: An empty JSON object can be built as follows:
JsonObject object = Json.createObjectBuilder().build();
For example 2: The following JSON
{
"firstName": "John", "lastName": "Smith", "age": 25,
"address" : {
"streetAddress": "21 2nd Street",
"city": "New York",
"state": "NY",
"postalCode": "10021"
},
"phoneNumber": [
{ "type": "home", "number": "212 555-1234" },
{ "type": "fax", "number": "646 555-4567" }
]
}
can be built using :
JsonObject value = Json.createObjectBuilder()
.add("firstName", "John")
.add("lastName", "Smith")
.add("age", 25)
.add("address", Json.createObjectBuilder()
.add("streetAddress", "21 2nd Street")
.add("city", "New York")
.add("state", "NY")
.add("postalCode", "10021"))
.add("phoneNumber", Json.createArrayBuilder()
.add(Json.createObjectBuilder()
.add("type", "home")
.add("number", "212 555-1234"))
.add(Json.createObjectBuilder()
.add("type", "fax")
.add("number", "646 555-4567")))
.build();
JsonObject
can be written to JSON as follows:
JsonWriter writer = ...
JsonObject obj = ...;
writer.writeObject(obj);
JsonObject
values can be JsonObject
, JsonArray
,
JsonString
, JsonNumber
, JsonValue.TRUE
,
JsonValue.FALSE
, JsonValue.NULL
. These values can be
accessed using various accessor methods.
In the above example 2, "John" can be got using
String firstName = object.getString("firstName");
This map object provides read-only access to the JSON object data,
and attempts to modify the map, whether direct or via its collection
views, result in an UnsupportedOperationException
.
The map object's iteration ordering is based on the order in which name/value pairs are added to the corresponding builder or the order in which name/value pairs appear in the corresponding stream.
JsonValue.ValueType
EMPTY_JSON_ARRAY, EMPTY_JSON_OBJECT, FALSE, NULL, TRUE
Modifier and Type | Method and Description |
---|---|
boolean |
getBoolean(java.lang.String name)
Returns the boolean value of the associated mapping for the specified
name.
|
boolean |
getBoolean(java.lang.String name,
boolean defaultValue)
Returns the boolean value of the associated mapping for the specified
name.
|
int |
getInt(java.lang.String name)
A convenience method for
getJsonNumber(name).intValue() |
int |
getInt(java.lang.String name,
int defaultValue)
Returns the int value of the associated
JsonNumber mapping
for the specified name. |
JsonArray |
getJsonArray(java.lang.String name)
Returns the array value to which the specified name is mapped.
|
JsonNumber |
getJsonNumber(java.lang.String name)
Returns the number value to which the specified name is mapped.
|
JsonObject |
getJsonObject(java.lang.String name)
Returns the object value to which the specified name is mapped.
|
JsonString |
getJsonString(java.lang.String name)
Returns the string value to which the specified name is mapped.
|
java.lang.String |
getString(java.lang.String name)
A convenience method for
getJsonString(name).getString() |
java.lang.String |
getString(java.lang.String name,
java.lang.String defaultValue)
Returns the string value of the associated
JsonString mapping
for the specified name. |
boolean |
isNull(java.lang.String name)
Returns
true if the associated value for the specified name is
JsonValue.NULL . |
getValue
asJsonArray, asJsonObject, getValueType, toString
JsonArray getJsonArray(java.lang.String name)
(JsonArray)get(name)
to
get the value.name
- the name whose associated value is to be returnednull
if this object contains no mapping for the namejava.lang.ClassCastException
- if the value to which the specified name
is mapped is not assignable to JsonArray typeJsonObject getJsonObject(java.lang.String name)
(JsonObject)get(name)
to
get the value.name
- the name whose associated value is to be returnednull
if this object contains no mapping for the namejava.lang.ClassCastException
- if the value to which the specified name
is mapped is not assignable to JsonObject typeJsonNumber getJsonNumber(java.lang.String name)
(JsonNumber)get(name)
to
get the value.name
- the name whose associated value is to be returnednull
if this object contains no mapping for the namejava.lang.ClassCastException
- if the value to which the specified name
is mapped is not assignable to JsonNumber typeJsonString getJsonString(java.lang.String name)
(JsonString)get(name)
to
get the value.name
- the name whose associated value is to be returnednull
if this object contains no mapping for the namejava.lang.ClassCastException
- if the value to which the specified name
is mapped is not assignable to JsonString typejava.lang.String getString(java.lang.String name)
getJsonString(name).getString()
name
- whose associated value is to be returned as Stringjava.lang.NullPointerException
- if the specified name doesn't have any
mappingjava.lang.ClassCastException
- if the value for specified name mapping
is not assignable to JsonStringjava.lang.String getString(java.lang.String name, java.lang.String defaultValue)
JsonString
mapping
for the specified name. If JsonString
is found, then its
JsonString.getString()
is returned. Otherwise,
the specified default value is returned.name
- whose associated value is to be returned as StringdefaultValue
- a default value to be returnedint getInt(java.lang.String name)
getJsonNumber(name).intValue()
name
- whose associated value is to be returned as intjava.lang.NullPointerException
- if the specified name doesn't have any
mappingjava.lang.ClassCastException
- if the value for specified name mapping
is not assignable to JsonNumberint getInt(java.lang.String name, int defaultValue)
JsonNumber
mapping
for the specified name. If JsonNumber
is found, then its
JsonNumber.intValue()
is returned. Otherwise,
the specified default value is returned.name
- whose associated value is to be returned as intdefaultValue
- a default value to be returnedboolean getBoolean(java.lang.String name)
name
- whose associated value is to be returned as booleanjava.lang.NullPointerException
- if the specified name doesn't have any
mappingjava.lang.ClassCastException
- if the value for specified name mapping
is not assignable to JsonValue.TRUE or JsonValue.FALSEboolean getBoolean(java.lang.String name, boolean defaultValue)
name
- whose associated value is to be returned as intdefaultValue
- a default value to be returnedboolean isNull(java.lang.String name)
true
if the associated value for the specified name is
JsonValue.NULL
.name
- name whose associated value is checkedJsonValue.NULL
,
otherwise falsejava.lang.NullPointerException
- if the specified name doesn't have any
mapping