Module jakarta.json

Package jakarta.json

package jakarta.json

Provides an object model API to process JSON.

The object model API is a high-level API that provides immutable object models for JSON object and array structures. These JSON structures are represented as object models using the Java types JsonObject and JsonArray. The interface jakarta.json.JsonObject provides a Map view to access the unordered collection of zero or more name/value pairs from the model. Similarly, the interface JsonArray provides a List view to access the ordered sequence of zero or more values from the model.

The object model API uses builder patterns to create and modify these object models. The classes JsonObjectBuilder and JsonArrayBuilder provide methods to create and modify models of type JsonObject and JsonArray respectively.

These object models can also be created from an input source using the class JsonReader. Similarly, these object models can be written to an output source using the class JsonWriter.

This package includes several classes that implement other JSON related standards: JSON Pointer, JSON Patch, and JSON Merge Patch. They can be used to retrieve, transform or manipulate values in an object model.

Related Packages

Module	Package	Description
jakarta.json.bind	jakarta.json.bind	Provides JSON Binding API, which enables binding Java objects from and to JSON documents.
jakarta.json	jakarta.json.spi	Service Provider Interface (SPI) to plug in implementations for JSON processing objects.
jakarta.json	jakarta.json.stream	Provides a streaming API to parse and generate JSON.

Class	Description
Json	Factory class for creating JSON processing objects.
JsonArray	JsonArray represents an immutable JSON array (an ordered sequence of zero or more values).
JsonArrayBuilder	A builder for creating JsonArray models from scratch, and for modifying a existing JsonArray.
JsonBuilderFactory	Factory to create JsonObjectBuilder and JsonArrayBuilder instances.
JsonConfig	This class contains the Json properties and values.
JsonConfig.KeyStrategy	Contains the different values allowed for JsonConfig.KEY_STRATEGY.
JsonException	JsonException indicates that some exception happened during JSON processing.
JsonMergePatch	This interface represents an implementation of a JSON Merge Patch as defined by RFC 7396.
JsonNumber	An immutable JSON number value.
JsonObject	JsonObject class represents an immutable JSON object value (an unordered collection of zero or more name/value pairs).
JsonObjectBuilder	A builder for creating JsonObject models from scratch.
JsonPatch	This interface represents an immutable implementation of a JSON Patch as defined by RFC 6902.
JsonPatch.Operation	This enum represents the list of valid JSON Patch operations as defined by RFC 6902.
JsonPatchBuilder	A builder for constructing a JSON Patch as defined by RFC 6902 by adding JSON Patch operations incrementally.
JsonPointer	This interface represents an immutable implementation of a JSON Pointer as defined by RFC 6901.
JsonReader	Reads a JSON object or an array structure from an input source.
JsonReaderFactory	Factory to create JsonReader instances.
JsonString	An immutable JSON string value.
JsonStructure	Super type for the two structured types in JSON (objects and arrays).
JsonValue	JsonValue represents an immutable JSON value.
JsonValue.ValueType	Indicates the type of a JsonValue object.
JsonWriter	Writes a JSON object or array structure to an output source.
JsonWriterFactory	Factory to create JsonWriter instances.