{@code 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 {@link JsonReader#readObject()}. For example:
JsonReader jsonReader = new JsonReader(...); JsonObject object = jsonReader.readObject(); jsonReader.close();
It can also be built from scratch using a {@link JsonObjectBuilder}.
For example 1: An empty JSON object can be built as follows:
JsonObject object = new JsonObjectBuilder().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 = new JsonObjectBuilder() .add("firstName", "John") .add("lastName", "Smith") .add("age", 25) .add("address", new JsonObjectBuilder() .add("streetAddress", "21 2nd Street") .add("city", "New York") .add("state", "NY") .add("postalCode", "10021")) .add("phoneNumber", new JsonArrayBuilder() .add(new JsonObjectBuilder() .add("type", "home") .add("number", "212 555-1234")) .add(new JsonObjectBuilder() .add("type", "fax") .add("number", "646 555-4567"))) .build();
{@code JsonObject} can be written to JSON as follows:
JsonWriter writer = ... JsonObject obj = ...; writer.writeobject(obj);
{@code JsonObject} values can be {@link JsonObject}, {@link JsonArray}, {@link JsonString}, {@link JsonNumber}, {@link JsonValue#TRUE}, {@link JsonValue#FALSE}, {@link JsonValue#NULL}. These values can be accessed using various accessor methods.
In the above example 2, "John" can be got using
String firstName = object.getStringValue("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 {@code 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.
@author Jitendra Kotamraju