Package javax.json
Interface JsonArrayBuilder
public interface JsonArrayBuilder
A builder for creating
JsonArray
models from scratch. This
interface initializes an empty JSON array model and provides methods to add
values to the array model and to return the resulting array. The methods
in this class can be chained to add multiple values to the array.
The class Json
contains methods to create the builder
object. The example code below shows how to build an empty JsonArray
instance.
JsonArray array = Json.createArrayBuilder().build();
The class JsonBuilderFactory
also contains methods to create
JsonArrayBuilder
instances. A factory instance can be used to create
multiple builder instances with the same configuration. This the preferred
way to create multiple instances.
The example code below shows how to build a JsonArray
object
that represents the following JSON array:
[
{ "type": "home", "number": "212 555-1234" },
{ "type": "fax", "number": "646 555-4567" }
]
The following code creates the JSON array above:
JsonBuilderFactory factory = Json.createBuilderFactory(config);
JsonArray value = factory.createArrayBuilder()
.add(factory.createObjectBuilder()
.add("type", "home")
.add("number", "212 555-1234"))
.add(factory.createObjectBuilder()
.add("type", "fax")
.add("number", "646 555-4567"))
.build();
This class does not allow null to be used as a value while building the JSON array
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionadd
(boolean value) Adds aJsonValue.TRUE
orJsonValue.FALSE
value to the array.add
(double value) Adds a value to the array as aJsonNumber
.add
(int value) Adds a value to the array as aJsonNumber
.add
(long value) Adds a value to the array as aJsonNumber
.Adds a value to the array as aJsonString
.add
(BigDecimal value) Adds a value to the array as aJsonNumber
.add
(BigInteger value) Adds a value to the array as aJsonNumber
.add
(JsonArrayBuilder builder) Adds aJsonArray
from an array builder to the array.add
(JsonObjectBuilder builder) Adds aJsonObject
from an object builder to the array.Adds a value to the array.addNull()
Adds aJsonValue.NULL
value to the array.build()
Returns the current array.
-
Method Details
-
add
Adds a value to the array.- Parameters:
value
- the JSON value- Returns:
- this array builder
- Throws:
NullPointerException
- if the specified value is null
-
add
Adds a value to the array as aJsonString
.- Parameters:
value
- the string value- Returns:
- this array builder
- Throws:
NullPointerException
- if the specified value is null
-
add
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- Throws:
NullPointerException
- if the specified value is null- See Also:
-
add
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- Throws:
NullPointerException
- if the specified value is null- See Also:
-
add
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- See Also:
-
add
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- See Also:
-
add
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- Throws:
NumberFormatException
- if the value is Not-a-Number(NaN) or infinity- See Also:
-
add
Adds aJsonValue.TRUE
orJsonValue.FALSE
value to the array.- Parameters:
value
- the boolean value- Returns:
- this array builder
-
addNull
JsonArrayBuilder addNull()Adds aJsonValue.NULL
value to the array.- Returns:
- this array builder
-
add
Adds aJsonObject
from an object builder to the array.- Parameters:
builder
- the object builder- Returns:
- this array builder
- Throws:
NullPointerException
- if the specified builder is null
-
add
Adds aJsonArray
from an array builder to the array.- Parameters:
builder
- the array builder- Returns:
- this array builder
- Throws:
NullPointerException
- if the specified builder is null
-
build
JsonArray build()Returns the current array.- Returns:
- the current JSON array
-