javax.json

Class JsonArrayBuilder

java.lang.Object

javax.json.JsonArrayBuilder

public class JsonArrayBuilder
extends Object

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

For example, for the following JSON array

 
 [
     { "type": "home", "number": "212 555-1234" },
     { "type": "fax", "number": "646 555-4567" }
 ]
 
 

a JsonArray instance can be built using:

 
 JsonArray value = 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:

JsonObjectBuilder

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
JsonArrayBuilder	add(BigDecimal value) Adds the specified value as a JSON number value to the array that is being built.
JsonArrayBuilder	add(BigInteger value) Adds the specified value as a JSON number value to the array that is being built.
JsonArrayBuilder	add(boolean value) Adds a JSON true or false value to the array that is being built.
JsonArrayBuilder	add(double value) Adds the specified value as a JSON number value to the array that is being built.
JsonArrayBuilder	add(int value) Adds the specified value as a JSON number value to the array that is being built.
JsonArrayBuilder	add(JsonArrayBuilder builder) Adds a JsonArray from the specified builder to the array that is being built.
JsonArrayBuilder	add(JsonObjectBuilder builder) Adds a JsonObject from the specified builder to the array that is being built.
JsonArrayBuilder	add(JsonValue value) Adds the specified value to the array that is being built.
JsonArrayBuilder	add(long value) Adds the specified value as a JSON number value to the array that is being built.
JsonArrayBuilder	add(String value) Adds the specified value as a JSON string value to the array that is being built.
JsonArrayBuilder	addNull() Adds a JSON null value to the array that is being built.
JsonArray	build() Returns the array that is being built

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonArrayBuilder

public JsonArrayBuilder()

Constructs a JsonArrayBuilder that initializes an empty JSON array that is being built.

Method Detail

add

public JsonArrayBuilder add(JsonValue value)

Adds the specified value to the array that is being built.

Parameters:

value - a JSON value

Returns:

this array builder

add

public JsonArrayBuilder add(String value)

Adds the specified value as a JSON string value to the array that is being built.

Parameters:

value - string

Returns:

this array builder

add

public JsonArrayBuilder add(BigDecimal value)

Adds the specified value as a JSON number value to the array that is being built.

Parameters:

value - a number

Returns:

this array builder

See Also:

JsonNumber

add

public JsonArrayBuilder add(BigInteger value)

Adds the specified value as a JSON number value to the array that is being built.

Parameters:

value - a number

Returns:

this array builder

See Also:

JsonNumber

add

public JsonArrayBuilder add(int value)

Adds the specified value as a JSON number value to the array that is being built.

Parameters:

value - a number

Returns:

this array builder

See Also:

JsonNumber

add

public JsonArrayBuilder add(long value)

Adds the specified value as a JSON number value to the array that is being built.

Parameters:

value - a number

Returns:

this array builder

See Also:

JsonNumber

add

public JsonArrayBuilder add(double value)

Adds the specified value as a JSON number value to the array that is being built.

Parameters:

value - a number

Returns:

this array builder

Throws:

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

See Also:

JsonNumber

add

public JsonArrayBuilder add(boolean value)

Adds a JSON true or false value to the array that is being built.

Parameters:

value - a boolean

Returns:

this array builder

addNull

public JsonArrayBuilder addNull()

Adds a JSON null value to the array that is being built.

Returns:

this array builder

add

public JsonArrayBuilder add(JsonObjectBuilder builder)

Adds a JsonObject from the specified builder to the array that is being built.

Returns:

this array builder

add

public JsonArrayBuilder add(JsonArrayBuilder builder)

Adds a JsonArray from the specified builder to the array that is being built.

Returns:

this array builder

build

public JsonArray build()

Returns the array that is being built

Returns:

JSON array that is being built