Package javax.json
Interface JsonBuilderFactory
-
public interface JsonBuilderFactory
Factory to createJsonObjectBuilder
andJsonArrayBuilder
instances. If a factory instance is configured with some configuration, that would be used to configure the created builder instances.
This is a near-exact copy of the same-titled Java EE 8 Class:javax.json.JsonBuilderFactory
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.
JsonObjectBuilder
andJsonArrayBuilder
can also be created usingJson
's methods. If multiple builder instances are created, then creating them using a builder factory is preferred.
Example:
JsonBuilderFactory factory = Json.createBuilderFactory(...); 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();
All the methods in this class are safe for use by multiple concurrent threads.
Hi-Lited Source-Code:This File's Source Code:
- View Here: javax/json/JsonBuilderFactory.java
- Open New Browser-Tab: javax/json/JsonBuilderFactory.java
File Size: 5,774 Bytes Line Count: 157 '\n' Characters Found
Glass Fish Implementation Class:
- View Here: org/glassfish/json/JsonBuilderFactoryImpl.java
- Open New Browser-Tab: org/glassfish/json/JsonBuilderFactoryImpl.java
File Size: 3,561 Bytes Line Count: 100 '\n' Characters Found
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description JsonArrayBuilder
createArrayBuilder()
Creates aJsonArrayBuilder
instance that is used to buildJsonArray
default JsonArrayBuilder
createArrayBuilder(Collection<?> collection)
Creates aJsonArrayBuilder
instance, initialized with the content of specified collection.default JsonArrayBuilder
createArrayBuilder(JsonArray array)
Creates aJsonArrayBuilder
instance, initialized with an array.JsonObjectBuilder
createObjectBuilder()
Creates aJsonObjectBuilder
instance that is used to buildJsonObject
.default JsonObjectBuilder
createObjectBuilder(Map<String,Object> object)
Creates aJsonObjectBuilder
instance, initialized with the specified object.default JsonObjectBuilder
createObjectBuilder(JsonObject object)
Creates aJsonObjectBuilder
instance, initialized with an object.Map<String,?>
getConfigInUse()
Returns read-only map of supported provider specific configuration properties that are used to configure the created JSON builders.
-
-
-
Method Detail
-
createObjectBuilder
JsonObjectBuilder createObjectBuilder()
Creates aJsonObjectBuilder
instance that is used to buildJsonObject
.- Returns:
- a JSON object builder
-
createObjectBuilder
default JsonObjectBuilder createObjectBuilder(JsonObject object)
Creates aJsonObjectBuilder
instance, initialized with an object.- Parameters:
object
- the initial object in the builder- Returns:
- a JSON object builder
- Throws:
java.lang.NullPointerException
- if specified object isnull
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
createObjectBuilder
default JsonObjectBuilder createObjectBuilder (java.util.Map<java.lang.String,java.lang.Object> object)
Creates aJsonObjectBuilder
instance, initialized with the specified object.- Parameters:
object
- the initial object in the builder- Returns:
- a JSON object builder
- Throws:
java.lang.NullPointerException
- if specified object isnull
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
createArrayBuilder
JsonArrayBuilder createArrayBuilder()
Creates aJsonArrayBuilder
instance that is used to buildJsonArray
- Returns:
- a JSON array builder
-
createArrayBuilder
default JsonArrayBuilder createArrayBuilder(JsonArray array)
Creates aJsonArrayBuilder
instance, initialized with an array.- Parameters:
array
- the initial array in the builder- Returns:
- a JSON array builder
- Throws:
java.lang.NullPointerException
- if specified array isnull
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
createArrayBuilder
default JsonArrayBuilder createArrayBuilder (java.util.Collection<?> collection)
Creates aJsonArrayBuilder
instance, initialized with the content of specified collection.- Parameters:
collection
- the initial data for the builder- Returns:
- a JSON array builder
- Throws:
java.lang.NullPointerException
- if specified collection isnull
- Since:
- 1.1
- Code:
- Exact Method Body:
throw new UnsupportedOperationException();
-
getConfigInUse
java.util.Map<java.lang.String,?> getConfigInUse()
Returns read-only map of supported provider specific configuration properties that are used to configure the created JSON builders. If there are any specified configuration properties that are not supported by the provider, they won't be part of the returned map.- Returns:
- a map of supported provider specific properties that are used to configure the builders. The map be empty but not null.
-
-