Package jakarta.json

Interface JsonBuilderFactory

public interface JsonBuilderFactory
Factory to create JsonObjectBuilder and JsonArrayBuilder instances. If a factory instance is configured with some configuration, that would be used to configure the created builder instances.

JsonObjectBuilder and JsonArrayBuilder can also be created using Json's methods. If multiple builder instances are created, then creating them using a builder factory is preferred.

For 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.

  • Method Details

    • createObjectBuilder

      JsonObjectBuilder createObjectBuilder()
      Creates a JsonObjectBuilder instance that is used to build JsonObject.
      Returns:
      a JSON object builder

    • createObjectBuilder

      default JsonObjectBuilder createObjectBuilder(JsonObject object)
      Creates a JsonObjectBuilder instance, initialized with an object.
      Parameters:
      object - the initial object in the builder
      Returns:
      a JSON object builder
      Throws:
      NullPointerException - if specified object is null
      Since:
      1.1

    • createObjectBuilder

      default JsonObjectBuilder createObjectBuilder(Map<String,Object> object)
      Creates a JsonObjectBuilder instance, initialized with the specified object.
      Parameters:
      object - the initial object in the builder
      Returns:
      a JSON object builder
      Throws:
      NullPointerException - if specified object is null
      Since:
      1.1

    • createArrayBuilder

      JsonArrayBuilder createArrayBuilder()
      Creates a JsonArrayBuilder instance that is used to build JsonArray
      Returns:
      a JSON array builder

    • createArrayBuilder

      default JsonArrayBuilder createArrayBuilder(JsonArray array)
      Creates a JsonArrayBuilder instance, initialized with an array.
      Parameters:
      array - the initial array in the builder
      Returns:
      a JSON array builder
      Throws:
      NullPointerException - if specified array is null
      Since:
      1.1

    • createArrayBuilder

      default JsonArrayBuilder createArrayBuilder(Collection<?> collection)
      Creates a JsonArrayBuilder instance, initialized with the content of specified collection.
      Parameters:
      collection - the initial data for the builder
      Returns:
      a JSON array builder
      Throws:
      NullPointerException - if specified collection is null
      Since:
      1.1

    • getConfigInUse

      Map<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.