Package javax.json
Interface JsonArrayBuilder
-
public interface JsonArrayBuilder
A builder for creatingJsonArray
models from scratch, and for modifying a existingJsonArray
.
This is a near-exact copy of the same-titled Java EE 8 Class:javax.json.JsonArrayBuilder
Commenting has been slightly modified to accompany HiLiting the Code Examples.
Java Source Code remains identical to the Sun-Oracle & 'GlassFish' Released Distributions.
Read included License:HERE
, and theCDDL+GPL-1.1
Alljavax.json.*
Code Obtained From:GitHub JavaEE jsonp
Public Archive.
AJsonArrayBuilder
can start with an empty or a non-empty JSON array model. This interface provides methods to add, insert, remove and replace values in the JSON array model.
Methods in this class can be chained to perform multiple values to the array.
The classJson
contains methods to create the builder object. The example code below shows how to build an emptyJsonArray
instance.
JsonArray array = Json.createArrayBuilder().build();
The classJsonBuilderFactory
also contains methods to createJsonArrayBuilder
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 aJsonArray
object that represents the following JSON array:
Java Script Object Notation (JSON):
[ { "type": "home", "number": "212 555-1234" }, { "type": "fax", "number": "646 555-4567" } ]
The following code creates the JSON array above:
Example:
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 allownull
to be used as a value while building the JSON array- See Also:
JsonObjectBuilder
Hi-Lited Source-Code:This File's Source Code:
- View Here: javax/json/JsonArrayBuilder.java
- Open New Browser-Tab: javax/json/JsonArrayBuilder.java
File Size: 22,105 Bytes Line Count: 647 '\n' Characters Found
Glass Fish Implementation Class:
- View Here: org/glassfish/json/JsonArrayBuilderImpl.java
- Open New Browser-Tab: org/glassfish/json/JsonArrayBuilderImpl.java
File Size: 14,751 Bytes Line Count: 503 '\n' Characters Found
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description JsonArrayBuilder
add(boolean value)
Adds aJsonValue.TRUE
orJsonValue.FALSE
value to the array.JsonArrayBuilder
add(double value)
Adds a value to the array as aJsonNumber
.JsonArrayBuilder
add(int value)
Adds a value to the array as aJsonNumber
.default JsonArrayBuilder
add(int index, boolean value)
Adds aJsonValue.TRUE
orJsonValue.FALSE
value to the array at the specified position.default JsonArrayBuilder
add(int index, double value)
Adds a value to the array as aJsonNumber
at the specified position.default JsonArrayBuilder
add(int index, int value)
Adds a value to the array as aJsonNumber
at the specified position.default JsonArrayBuilder
add(int index, long value)
Adds a value to the array as aJsonNumber
at the specified position.default JsonArrayBuilder
add(int index, String value)
Adds a value to the array as aJsonString
at the specified position.default JsonArrayBuilder
add(int index, BigDecimal value)
Adds a value to the array as aJsonNumber
at the specified position.default JsonArrayBuilder
add(int index, BigInteger value)
Adds a value to the array as aJsonNumber
at the specified position.default JsonArrayBuilder
add(int index, JsonArrayBuilder builder)
Adds aJsonArray
from an array builder to the array at the specified position.default JsonArrayBuilder
add(int index, JsonObjectBuilder builder)
Adds aJsonObject
from an object builder to the array at the specified position.default JsonArrayBuilder
add(int index, JsonValue value)
Inserts a value to the array at the specified position.JsonArrayBuilder
add(long value)
Adds a value to the array as aJsonNumber
.JsonArrayBuilder
add(String value)
Adds a value to the array as aJsonString
.JsonArrayBuilder
add(BigDecimal value)
Adds a value to the array as aJsonNumber
.JsonArrayBuilder
add(BigInteger value)
Adds a value to the array as aJsonNumber
.JsonArrayBuilder
add(JsonArrayBuilder builder)
Adds aJsonArray
from an array builder to the array.JsonArrayBuilder
add(JsonObjectBuilder builder)
Adds aJsonObject
from an object builder to the array.JsonArrayBuilder
add(JsonValue value)
Adds a value to the array.default JsonArrayBuilder
addAll(JsonArrayBuilder builder)
Adds all elements of the array in the specified array builder to the array.JsonArrayBuilder
addNull()
Adds aJsonValue.NULL
value to the array.default JsonArrayBuilder
addNull(int index)
Adds aJsonValue.NULL
value to the array at the specified position.JsonArray
build()
Returns the current array.default JsonArrayBuilder
remove(int index)
Remove the value in the array at the specified position.default JsonArrayBuilder
set(int index, boolean value)
Replaces a value in the array with aJsonValue.TRUE
orJsonValue.FALSE
value at the specified position.default JsonArrayBuilder
set(int index, double value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.default JsonArrayBuilder
set(int index, int value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.default JsonArrayBuilder
set(int index, long value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.default JsonArrayBuilder
set(int index, String value)
Replaces a value in the array with the specified value as aJsonString
at the specified position.default JsonArrayBuilder
set(int index, BigDecimal value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.default JsonArrayBuilder
set(int index, BigInteger value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.default JsonArrayBuilder
set(int index, JsonArrayBuilder builder)
Replaces a value in the array with the specified value as aJsonArray
from an array builder at the specified position.default JsonArrayBuilder
set(int index, JsonObjectBuilder builder)
Replaces a value in the array with the specified value as aJsonObject
from an object builder at the specified position.default JsonArrayBuilder
set(int index, JsonValue value)
Replaces a value in the array with the specified value at the specified position.default JsonArrayBuilder
setNull(int index)
Replaces a value in the array with aJsonValue.NULL
value at the specified position.
-
-
-
Method Detail
-
add
JsonArrayBuilder add(JsonValue value)
Adds a value to the array.- Parameters:
value
- the JSON value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is null
-
add
JsonArrayBuilder add(java.lang.String value)
Adds a value to the array as aJsonString
.- Parameters:
value
- the string value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is null
-
add
JsonArrayBuilder add(java.math.BigDecimal value)
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is null- See Also:
JsonNumber
-
add
JsonArrayBuilder add(java.math.BigInteger value)
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is null- See Also:
JsonNumber
-
add
JsonArrayBuilder add(int value)
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- See Also:
JsonNumber
-
add
JsonArrayBuilder add(long value)
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- See Also:
JsonNumber
-
add
JsonArrayBuilder add(double value)
Adds a value to the array as aJsonNumber
.- Parameters:
value
- the number value- Returns:
- this array builder
- Throws:
java.lang.NumberFormatException
- if the value is Not-a-Number (NaN) or infinity- See Also:
JsonNumber
-
add
JsonArrayBuilder add(boolean value)
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
JsonArrayBuilder add(JsonObjectBuilder builder)
Adds aJsonObject
from an object builder to the array.- Parameters:
builder
- the object builder- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified builder is null
-
add
JsonArrayBuilder add(JsonArrayBuilder builder)
Adds aJsonArray
from an array builder to the array.- Parameters:
builder
- the array builder- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified builder is null
-
addAll
default JsonArrayBuilder addAll(JsonArrayBuilder builder)
Adds all elements of the array in the specified array builder to the array.- Parameters:
builder
- the array builder- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified builder is null- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, JsonValue value)
Inserts a value to the array at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the JSON value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, java.lang.String value)
Adds a value to the array as aJsonString
at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the string value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, java.math.BigDecimal value)
Adds a value to the array as aJsonNumber
at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, java.math.BigInteger value)
Adds a value to the array as aJsonNumber
at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, int value)
Adds a value to the array as aJsonNumber
at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, long value)
Adds a value to the array as aJsonNumber
at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, double value)
Adds a value to the array as aJsonNumber
at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.NumberFormatException
- if the value is Not-a-Number (NaN) or infinityjava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, boolean value)
Adds aJsonValue.TRUE
orJsonValue.FALSE
value to the array at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arrayvalue
- the boolean value- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
addNull
default JsonArrayBuilder addNull(int index)
Adds aJsonValue.NULL
value to the array at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the array- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
return add(index, JsonValue.NULL);
-
add
default JsonArrayBuilder add(int index, JsonObjectBuilder builder)
Adds aJsonObject
from an object builder to the array at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arraybuilder
- the object builder- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified builder is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
add
default JsonArrayBuilder add(int index, JsonArrayBuilder builder)
Adds aJsonArray
from an array builder to the array at the specified position. Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices). Index starts with 0.- Parameters:
index
- the position in the arraybuilder
- the array builder- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified builder is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index > array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, JsonValue value)
Replaces a value in the array with the specified value at the specified position.- Parameters:
index
- the position in the arrayvalue
- the JSON value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, java.lang.String value)
Replaces a value in the array with the specified value as aJsonString
at the specified position.- Parameters:
index
- the position in the arrayvalue
- the string value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, java.math.BigDecimal value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, java.math.BigInteger value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified value is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, int value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, long value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, double value)
Replaces a value in the array with the specified value as aJsonNumber
at the specified position.- Parameters:
index
- the position in the arrayvalue
- the number value- Returns:
- this array builder
- Throws:
java.lang.NumberFormatException
- if the value is Not-a-Number (NaN) or infinityjava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- See Also:
JsonNumber
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, boolean value)
Replaces a value in the array with aJsonValue.TRUE
orJsonValue.FALSE
value at the specified position.- Parameters:
index
- the position in the arrayvalue
- the boolean value- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
setNull
default JsonArrayBuilder setNull(int index)
Replaces a value in the array with aJsonValue.NULL
value at the specified position.- Parameters:
index
- the position in the array- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
return set(index, JsonValue.NULL);
-
set
default JsonArrayBuilder set(int index, JsonObjectBuilder builder)
Replaces a value in the array with the specified value as aJsonObject
from an object builder at the specified position.- Parameters:
index
- the position in the arraybuilder
- the object builder- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified builder is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
set
default JsonArrayBuilder set(int index, JsonArrayBuilder builder)
Replaces a value in the array with the specified value as aJsonArray
from an array builder at the specified position.- Parameters:
index
- the position in the arraybuilder
- the array builder- Returns:
- this array builder
- Throws:
java.lang.NullPointerException
- if the specified builder is nulljava.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
remove
default JsonArrayBuilder remove(int index)
Remove the value in the array at the specified position. Shift any subsequent values to the left (subtracts one from their indices.- Parameters:
index
- the position in the array- Returns:
- this array builder
- Throws:
java.lang.IndexOutOfBoundsException
- if the index is out of range(index < 0 || index >= array size)
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
build
-
-