Package org.eclipse.ditto.json
@AllParametersAndReturnValuesAreNonnullByDefault
package org.eclipse.ditto.json
Ditto JSON is a general purpose JSON library. This package provides the corresponding interfaces as well as
implementations. There is one central place for obtaining instances of the various interfaces:
JsonFactory
. JsonFactory provides only static
methods which means that they
can be imported statically and by thus make calls concise to assist the readability of your code.
Please note that Ditto JSON is designed for immutability. Therefore each object returned by JsonFactory - apart from builders - is immutable and thus thread safe. If interfaces provide methods for altering an object then invoking this method does not change the state of that object but a new object with the altered state is returned instead. This is the same behavior like it is shown by java.lang.String for example.
-
ClassDescriptionAbstractJsonExceptionBuilder<T extends JsonException>Abstract base implementation for builders which create objects of subtypes of
JsonRuntimeException
.This interface abstracts serialization/deserialization via CBOR.Represents a JSON array.A mutable builder with a fluent API for aJsonArray
.This class provides implementations ofCollector
that implement various useful reduction operations, such as accumulating JSON fields into JSON objects etc.The methods of this interface are common for all JSON related exceptions.JsonExceptionBuilder<T extends JsonException>A mutable builder for aJsonException
.The main entry point for the Eclipse Ditto JSON API.Represents a single JSON field.AJsonFieldDefinition
is a formal description of a singleJsonField
.Marker interface to provide a common type for markers of JSON fields.AJsonFieldSelector
is basically a set ofJsonPointer
s.A mutable builder with a fluent API for aJsonFieldSelector
.Thrown if a field selector at was in an invalid format.A mutable builder for aJsonPointerInvalidException
.Represents a JSON key.Thrown if aJsonKey
was in an invalid format.A mutable builder for aJsonKeyInvalidException
.This class is responsible to compute or apply a JSON merge patch according to RFC 7386 forjson values
.Thrown if an expected JSON field is not in the JSON.A mutable builder for aJsonMissingFieldException
.This interface represents a JSON number.Represents a JSON object.A mutable builder for aJsonObject
.Thrown if JSON could not be parsed because it was in an invalid format.A mutable builder for aJsonParseException
.Holding options about how to parse a Json type (JsonObject, JsonPointer, ...) from a String.A mutable builder for aJsonParseOptions
.Defines a JSON Patch which can be used to specify modifications on JSON Objects.An enumeration of the knownJsonField
s of a Thing.Enumeration defining the supported JSON Patch operation types.A JSON pointer defines a path within a JSON object.Thrown if aJsonPointer
was in an invalid format.A mutable builder for aJsonPointerInvalidException
.Common base type of all unchecked JSON exceptions.A mutable builder for aJsonRuntimeException
.Represents a JSON value.Abstract representation of a data structure which somehow holds JSON values.Bundles state and configuration for serialization.