public interface JsonArrayBuilder
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
JsonObjectBuilder
Modifier and Type | Method and Description |
---|---|
JsonArrayBuilder |
add(BigDecimal value)
Adds a value to the array as a
JsonNumber . |
JsonArrayBuilder |
add(BigInteger value)
Adds a value to the array as a
JsonNumber . |
JsonArrayBuilder |
add(boolean value)
Adds a
JsonValue.TRUE or JsonValue.FALSE value to the
array. |
JsonArrayBuilder |
add(double value)
Adds a value to the array as a
JsonNumber . |
JsonArrayBuilder |
add(int value)
Adds a value to the array as a
JsonNumber . |
JsonArrayBuilder |
add(JsonArrayBuilder builder)
Adds a
JsonArray from an array builder to the array. |
JsonArrayBuilder |
add(JsonObjectBuilder builder)
Adds a
JsonObject from an object builder to the array. |
JsonArrayBuilder |
add(JsonValue value)
Adds a value to the array.
|
JsonArrayBuilder |
add(long value)
Adds a value to the array as a
JsonNumber . |
JsonArrayBuilder |
add(String value)
Adds a value to the array as a
JsonString . |
JsonArrayBuilder |
addNull()
Adds a
JsonValue.NULL value to the array. |
JsonArray |
build()
Returns the current array.
|
JsonArrayBuilder add(JsonValue value)
value
- the JSON valueNullPointerException
- if the specified value is nullJsonArrayBuilder add(String value)
JsonString
.value
- the string valueNullPointerException
- if the specified value is nullJsonArrayBuilder add(BigDecimal value)
JsonNumber
.value
- the number valueNullPointerException
- if the specified value is nullJsonNumber
JsonArrayBuilder add(BigInteger value)
JsonNumber
.value
- the number valueNullPointerException
- if the specified value is nullJsonNumber
JsonArrayBuilder add(int value)
JsonNumber
.value
- the number valueJsonNumber
JsonArrayBuilder add(long value)
JsonNumber
.value
- the number valueJsonNumber
JsonArrayBuilder add(double value)
JsonNumber
.value
- the number valueNumberFormatException
- if the value is Not-a-Number(NaN) or
infinityJsonNumber
JsonArrayBuilder add(boolean value)
JsonValue.TRUE
or JsonValue.FALSE
value to the
array.value
- the boolean valueJsonArrayBuilder addNull()
JsonValue.NULL
value to the array.JsonArrayBuilder add(JsonObjectBuilder builder)
JsonObject
from an object builder to the array.builder
- the object builderNullPointerException
- if the specified builder is nullJsonArrayBuilder add(JsonArrayBuilder builder)
JsonArray
from an array builder to the array.builder
- the array builderNullPointerException
- if the specified builder is nullJsonArray build()
Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.