javax.json

Class JsonObjectBuilder

java.lang.Object

javax.json.JsonObjectBuilder

public class JsonObjectBuilder
extends Object

Builds a JsonObject from scratch. It uses builder pattern to build the object model and the builder methods can be chained while building the JSON Object.

For example, for 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" }
     ]
 }
 
 

a JsonObject instance 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();
 
 

See Also:

JsonArrayBuilder

Constructor Summary

Constructors

Constructor and Description
JsonObjectBuilder() Constructs a JsonObjectBuilder that initializes an empty JSON object that is being built.

Method Summary

Methods

Modifier and Type	Method and Description
JsonObjectBuilder	add(String name, BigDecimal value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, BigInteger value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, boolean value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, double value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, int value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, JsonArrayBuilder builder) Associates the JSON array from the specified builder with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, JsonObjectBuilder builder) Associates the JsonObject from the specified builder with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, JsonValue value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, long value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	add(String name, String value) Associates the specified value with the specified name in the JSON object that is being built.
JsonObjectBuilder	addNull(String name) Associates the specified value with the specified name in the JSON object that is being built.
JsonObject	build() Returns the JSON object that is being built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonObjectBuilder

public JsonObjectBuilder()

Constructs a JsonObjectBuilder that initializes an empty JSON object that is being built.

Method Detail

add

public JsonObjectBuilder add(String name,
                    JsonValue value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

add

public JsonObjectBuilder add(String name,
                    String value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

add

public JsonObjectBuilder add(String name,
                    BigInteger value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

See Also:

JsonNumber

add

public JsonObjectBuilder add(String name,
                    BigDecimal value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

See Also:

JsonNumber

add

public JsonObjectBuilder add(String name,
                    int value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

See Also:

JsonNumber

add

public JsonObjectBuilder add(String name,
                    long value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

See Also:

JsonNumber

add

public JsonObjectBuilder add(String name,
                    double value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

Throws:

NumberFormatException - if value is Not-a-Number(NaN) or infinity

See Also:

JsonNumber

add

public JsonObjectBuilder add(String name,
                    boolean value)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this object builder

addNull

public JsonObjectBuilder addNull(String name)

Associates the specified value with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the specified value.

Parameters:

name - name with which the specified value is to be associated

Returns:

this object builder

add

public JsonObjectBuilder add(String name,
                    JsonObjectBuilder builder)

Associates the JsonObject from the specified builder with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the JsonObject from the specified builder.

Parameters:

name - name with which the specified value is to be associated

Returns:

this object builder

add

public JsonObjectBuilder add(String name,
                    JsonArrayBuilder builder)

Associates the JSON array from the specified builder with the specified name in the JSON object that is being built. If the JSON object that is being built previously contained a mapping for the name, the old value is replaced by the JsonArray from the specified builder.

Parameters:

name - name with which the specified value is to be associated

Returns:

this object builder

build

public JsonObject build()

Returns the JSON object that is being built. The returned JsonObject's iteration ordering is based on the order in which name/value pairs are added in this builder.

Returns:

JSON object that is being built