Index (Jakarta JSON Binding API 3.1.0-SNAPSHOT API)

A B C D E F G I J K L N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ADAPTERS - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom mapping adapters for generic types.
adaptFromJson(Adapted) - Method in interface jakarta.json.bind.adapter.JsonbAdapter: This method is used on deserialization only.
adaptToJson(Original) - Method in interface jakarta.json.bind.adapter.JsonbAdapter: This method is used on serialization only.
alias() - Element in annotation interface jakarta.json.bind.annotation.JsonbSubtype: Type alias which is used instead of a class name.
ANY - Static variable in class jakarta.json.bind.config.PropertyOrderStrategy: The order of properties is not specified and may vary across serializations.

B

BASE_64 - Static variable in class jakarta.json.bind.config.BinaryDataStrategy: Using this strategy, binary data is encoded using the Base64 encoding scheme as specified in RFC 4648 and RFC 2045.
BASE_64_URL - Static variable in class jakarta.json.bind.config.BinaryDataStrategy: Using this strategy, binary data is encoded using the "URL and Filename safe Base64 Alphabet" as specified in Table 2 of RFC 4648.
BINARY_DATA_STRATEGY - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom binary data strategy.
BinaryDataStrategy - Class in jakarta.json.bind.config: Specifies predefined binary data handling strategies.
build() - Method in interface jakarta.json.bind.JsonbBuilder: Returns a new instance of Jsonb based on the parameters and configuration specified previously in this builder.
BYTE - Static variable in class jakarta.json.bind.config.BinaryDataStrategy: Using this strategy, binary data is encoded as a byte array.

C

CASE_INSENSITIVE - Static variable in interface jakarta.json.bind.config.PropertyNamingStrategy: During serialization, the PropertyNamingStrategy.IDENTITY strategy is used; the property name is written to JSON unchanged.
create() - Static method in interface jakarta.json.bind.JsonbBuilder: Create a new Jsonb instance using the default JsonbBuilder implementation provided as returned from JsonbProvider.provider() method.
create() - Method in class jakarta.json.bind.spi.JsonbProvider: Returns a new instance of JsonbBuilder class.
create(JsonbConfig) - Static method in interface jakarta.json.bind.JsonbBuilder: Create a new Jsonb instance using the default JsonbBuilder implementation provided as returned from JsonbProvider.provider() method, configured with provided configuration.
CREATOR_PARAMETERS_REQUIRED - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify required creator parameters.

D

DATE_FORMAT - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom date format globally.
DEFAULT_FORMAT - Static variable in annotation interface jakarta.json.bind.annotation.JsonbDateFormat: Value that indicates the default format.
DEFAULT_KEY_NAME - Static variable in annotation interface jakarta.json.bind.annotation.JsonbTypeInfo: Default type information key name.
DEFAULT_LOCALE - Static variable in annotation interface jakarta.json.bind.annotation.JsonbDateFormat: Value that indicates that default Locale.
DEFAULT_LOCALE - Static variable in annotation interface jakarta.json.bind.annotation.JsonbNumberFormat: Value that indicates that default Locale.
DeserializationContext - Interface in jakarta.json.bind.serializer: Provides JSONB Mapper functionality on top of JSONP parser.
deserialize(JsonParser, DeserializationContext, Type) - Method in interface jakarta.json.bind.serializer.JsonbDeserializer: Deserialize JSON stream into object.
deserialize(Class<T>, JsonParser) - Method in interface jakarta.json.bind.serializer.DeserializationContext: Deserialize JSON stream into instance of provided class using JsonParser.
deserialize(Type, JsonParser) - Method in interface jakarta.json.bind.serializer.DeserializationContext: Deserialize JSON stream into instance of provided class using JsonParser.
DESERIALIZERS - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom deserializers.

E

ENCODING - Static variable in class jakarta.json.bind.JsonbConfig: The Jsonb serialization toJson() methods will default to this property for encoding of output JSON data.

F

FORMATTING - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify whether or not the serialized JSON data is formatted with line feeds and indentation.
fromJson(InputStream, Class<T>) - Method in interface jakarta.json.bind.Jsonb: Reads JSON data from the specified InputStream and returns the resulting content tree.
fromJson(InputStream, Type) - Method in interface jakarta.json.bind.Jsonb: Reads JSON data from the specified InputStream and returns the resulting content tree.
fromJson(Reader, Class<T>) - Method in interface jakarta.json.bind.Jsonb: Reads JSON data from the specified reader and returns the resulting content tree.
fromJson(Reader, Type) - Method in interface jakarta.json.bind.Jsonb: Reads JSON data from the specified reader and returns the resulting content tree.
fromJson(String, Class<T>) - Method in interface jakarta.json.bind.Jsonb: Reads JSON data from the specified string and returns the resulting content tree.
fromJson(String, Type) - Method in interface jakarta.json.bind.Jsonb: Reads JSON data from the specified string and returns the resulting content tree.

G

getAsMap() - Method in class jakarta.json.bind.JsonbConfig: Return all configuration properties as an unmodifiable map.
getProperty(String) - Method in class jakarta.json.bind.JsonbConfig: Return value of particular configuration property.

I

IDENTITY - Static variable in interface jakarta.json.bind.config.PropertyNamingStrategy: The identity property name is used unchanged as the JSON property name.
isVisible(Field) - Method in interface jakarta.json.bind.config.PropertyVisibilityStrategy: Responds whether the given field should be considered as the JsonbProperty.
isVisible(Method) - Method in interface jakarta.json.bind.config.PropertyVisibilityStrategy: Responds whether the given method should be considered as the JsonbProperty.

J

jakarta.json.bind - module jakarta.json.bind: Jakarta JSON Binding (JSON-B) defines a standard binding layer for converting Java objects to and from JSON documents.
jakarta.json.bind - package jakarta.json.bind: Provides the JSON Binding API, which enables binding Java objects to and from JSON documents.
jakarta.json.bind.adapter - package jakarta.json.bind.adapter: Defines adapter related classes.
jakarta.json.bind.annotation - package jakarta.json.bind.annotation: Defines annotations for customizing the mapping between Java program elements and JSON documents.
jakarta.json.bind.config - package jakarta.json.bind.config: Defines strategies and policies for customizing the mapping between Java program elements and JSON documents.
jakarta.json.bind.serializer - package jakarta.json.bind.serializer: Defines serializer depending classes.
jakarta.json.bind.spi - package jakarta.json.bind.spi: Service Provider Interface (SPI) to plug in implementations of JSON Binding API JsonbBuilder objects.
Jsonb - Interface in jakarta.json.bind: Converts Java objects to and from JSON documents.
JsonbAdapter<Original,Adapted> - Interface in jakarta.json.bind.adapter: Allows to define custom mapping for given java type.
JsonbAnnotation - Annotation Interface in jakarta.json.bind.annotation: Marks any relevant JSON Binding annotations.
JsonbBuilder - Interface in jakarta.json.bind: JsonbBuilder class provides the client's entry point to the JSON Binding API.
JsonbConfig - Class in jakarta.json.bind: Supported Properties
JsonbConfig() - Constructor for class jakarta.json.bind.JsonbConfig
JsonbCreator - Annotation Interface in jakarta.json.bind.annotation: Annotates a constructor or static factory method to use for deserialization.
JsonbDateFormat - Annotation Interface in jakarta.json.bind.annotation: Annotation provides way how to set custom date format to field or JavaBean property.
JsonbDeserializer<T> - Interface in jakarta.json.bind.serializer: Interface representing a custom deserializer for a given type.
JsonbException - Exception in jakarta.json.bind: Root class for all JSON Binding exceptions.
JsonbException(String) - Constructor for exception jakarta.json.bind.JsonbException: Constructs a new runtime exception with the specified detail message.
JsonbException(String, Throwable) - Constructor for exception jakarta.json.bind.JsonbException: Constructs a new runtime exception with the specified detail message and cause.
JsonbNillable - Annotation Interface in jakarta.json.bind.annotation: Specifies how fields having null values are serialized into JSON.
JsonbNumberFormat - Annotation Interface in jakarta.json.bind.annotation: Annotation provides way how to set custom number format to field or JavaBean property.
JsonbProperty - Annotation Interface in jakarta.json.bind.annotation: Customizes serialization and/or deserialziaton of JSON property names.
JsonbPropertyOrder - Annotation Interface in jakarta.json.bind.annotation: Customizes the order in which properties are serialized for the annotated type.
JsonbProvider - Class in jakarta.json.bind.spi: Service provider for JSON Binding implementations.
JsonbProvider() - Constructor for class jakarta.json.bind.spi.JsonbProvider: Protected constructor.
JsonbSerializer<T> - Interface in jakarta.json.bind.serializer: Interface representing a custom serializer for given type.
JsonbSubtype - Annotation Interface in jakarta.json.bind.annotation: Subtype is tightly bound to the JsonbTypeInfo.
JsonbTransient - Annotation Interface in jakarta.json.bind.annotation: Prevents serialization and/or deserialization of JSON properties.
JsonbTypeAdapter - Annotation Interface in jakarta.json.bind.annotation: Annotation provides way how to set custom JsonbAdapter to field or JavaBean property.
JsonbTypeDeserializer - Annotation Interface in jakarta.json.bind.annotation: Annotation provides way how to set custom JsonbDeserializer to field or JavaBean property.
JsonbTypeInfo - Annotation Interface in jakarta.json.bind.annotation: Configuration annotation of the type information handling.
JsonbTypeSerializer - Annotation Interface in jakarta.json.bind.annotation: Annotation provides way how to set custom JsonbSerializer to field or JavaBean property.
JsonbVisibility - Annotation Interface in jakarta.json.bind.annotation: Annotation provides way how to customize visibility strategy of the JSON Binding.

K

key() - Element in annotation interface jakarta.json.bind.annotation.JsonbTypeInfo: Key used for keeping the type information (alias).

L

LEXICOGRAPHICAL - Static variable in class jakarta.json.bind.config.PropertyOrderStrategy: Properties are serialized in ascending lexicographical order of their JSON property names.
locale() - Element in annotation interface jakarta.json.bind.annotation.JsonbDateFormat: Custom Locale to use.
locale() - Element in annotation interface jakarta.json.bind.annotation.JsonbNumberFormat: Custom Locale to use.
LOCALE - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify locale globally.
LOWER_CASE_WITH_DASHES - Static variable in interface jakarta.json.bind.config.PropertyNamingStrategy: The identity property name is transformed to lower case with dashes.
LOWER_CASE_WITH_UNDERSCORES - Static variable in interface jakarta.json.bind.config.PropertyNamingStrategy: The identity property name is transformed to lower case with underscores.

N

newBuilder() - Static method in interface jakarta.json.bind.JsonbBuilder: Create a new JsonbBuilder instance as returned by the default JsonbProvider.provider() method.
newBuilder(JsonbProvider) - Static method in interface jakarta.json.bind.JsonbBuilder: Create a new JsonbBuilder instance as returned by provider#create call.
newBuilder(String) - Static method in interface jakarta.json.bind.JsonbBuilder: Create a new JsonbBuilder instance as returned by JsonbProvider.provider(String) method.
nillable() - Element in annotation interface jakarta.json.bind.annotation.JsonbProperty: Deprecated.
Please use the JsonbNillable annotation instead. This element will be removed in the future.
NULL_VALUES - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify null values serialization behavior.

P

PROPERTY_NAMING_STRATEGY - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom naming strategy.
PROPERTY_ORDER_STRATEGY - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom order strategy.
PROPERTY_VISIBILITY_STRATEGY - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom visibility strategy.
PropertyNamingStrategy - Interface in jakarta.json.bind.config: Specifies a predefined property name conversion for serialization and deserialization.
PropertyOrderStrategy - Class in jakarta.json.bind.config: Specifies predefined property order stategy for serialization.
PropertyVisibilityStrategy - Interface in jakarta.json.bind.config: Provides mechanism how to define customized property visibility strategy.
provider() - Static method in class jakarta.json.bind.spi.JsonbProvider: Creates a JSON Binding provider object by using the ServiceLoader.load(Class) method.
provider(String) - Static method in class jakarta.json.bind.spi.JsonbProvider: Creates a JSON Binding provider object by using the ServiceLoader.load(Class) method, matching providerName.

R

REVERSE - Static variable in class jakarta.json.bind.config.PropertyOrderStrategy: Properties are serialized in descending lexicographical order of their JSON property names; the reverse of PropertyOrderStrategy.LEXICOGRAPHICAL.

S

SerializationContext - Interface in jakarta.json.bind.serializer: Provides JSONB internals for custom serializers.
serialize(String, T, JsonGenerator) - Method in interface jakarta.json.bind.serializer.SerializationContext: Serializes arbitrary object to JSON, using current JsonGenerator instance.
serialize(T, JsonGenerator) - Method in interface jakarta.json.bind.serializer.SerializationContext: Serializes arbitrary object to JSON, using current JsonGenerator instance.
serialize(T, JsonGenerator, SerializationContext) - Method in interface jakarta.json.bind.serializer.JsonbSerializer: Serializes object into JSON stream.
SERIALIZERS - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify custom serializers.
setProperty(String, Object) - Method in class jakarta.json.bind.JsonbConfig: Set the particular configuration property to a new value.
STRICT_IJSON - Static variable in class jakarta.json.bind.JsonbConfig: Property used to specify strict I-JSON serialization compliance.

T

TIME_IN_MILLIS - Static variable in annotation interface jakarta.json.bind.annotation.JsonbDateFormat: Special date format which serializes given date as milliseconds.
toJson(Object) - Method in interface jakarta.json.bind.Jsonb: Writes the Java object tree with the given root object, object, to a String instance as JSON.
toJson(Object, OutputStream) - Method in interface jakarta.json.bind.Jsonb: Writes the object content tree to the given stream.
toJson(Object, Writer) - Method in interface jakarta.json.bind.Jsonb: Writes the object content tree into a Writer character stream.
toJson(Object, Type) - Method in interface jakarta.json.bind.Jsonb: Writes the Java object tree with the given root object, object, to a String instance as JSON.
toJson(Object, Type, OutputStream) - Method in interface jakarta.json.bind.Jsonb: Writes the object content tree to the given stream.
toJson(Object, Type, Writer) - Method in interface jakarta.json.bind.Jsonb: Writes the object content tree into a Writer character stream.
translateName(String) - Method in interface jakarta.json.bind.config.PropertyNamingStrategy: Translates an identity property name into its JSON property name representation according to this strategy.
type() - Element in annotation interface jakarta.json.bind.annotation.JsonbSubtype: An actual type bound to the alias.

U

UPPER_CAMEL_CASE - Static variable in interface jakarta.json.bind.config.PropertyNamingStrategy: The first character of the identity property name is capitalized; the remainder is unchanged.
UPPER_CAMEL_CASE_WITH_SPACES - Static variable in interface jakarta.json.bind.config.PropertyNamingStrategy: The first character of the property name is capitalized and camel-case word boundaries are replaced with spaces.

V

value() - Element in annotation interface jakarta.json.bind.annotation.JsonbDateFormat: Specifies the date pattern to use.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbNillable: Switches on/off serialization of properties with null value.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbNumberFormat: Specifies the number pattern to use.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbProperty: Customized JSON property name for the annotated element.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbPropertyOrder: The order in which properties are serialized.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbTypeAdapter: Custom JsonbAdapter which provides custom mapping for given field or JavaBean property.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbTypeDeserializer: Custom JsonbDeserializer which provides custom mapping for given field or JavaBean property.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbTypeInfo: Allowed aliases of the handled type.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbTypeSerializer: Custom JsonbSerializer which provides custom mapping for given field or JavaBean property.
value() - Element in annotation interface jakarta.json.bind.annotation.JsonbVisibility: Custom property visibility strategy used to resolve visibility of the members.

W

withAdapters(JsonbAdapter...) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom mapping adapters.
withBinaryDataStrategy(String) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom binary data strategy.
withConfig(JsonbConfig) - Method in interface jakarta.json.bind.JsonbBuilder: Set configuration which will be set to the newly created Jsonb instance.
withCreatorParametersRequired(boolean) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify whether all creator parameters should be treated as required.
withDateFormat(String, Locale) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom date format.
withDeserializers(JsonbDeserializer...) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom deserializers.
withEncoding(String) - Method in class jakarta.json.bind.JsonbConfig: The binding operations will default to this property for encoding of JSON data.
withFormatting(Boolean) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify whether or not the serialized JSON data is formatted with linefeeds and indentation.
withLocale(Locale) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom locale.
withNullValues(Boolean) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify whether null values should be serialized to JSON document or skipped.
withPropertyNamingStrategy(PropertyNamingStrategy) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom naming strategy.
withPropertyNamingStrategy(String) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom naming strategy.
withPropertyOrderStrategy(String) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify property order strategy.
withPropertyVisibilityStrategy(PropertyVisibilityStrategy) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom property visibility strategy.
withProvider(JsonProvider) - Method in interface jakarta.json.bind.JsonbBuilder: Provides a JSON-P provider to be used for all JSON-P related operations.
withSerializers(JsonbSerializer...) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify custom serializers.
withStrictIJSON(Boolean) - Method in class jakarta.json.bind.JsonbConfig: Property used to specify whether strict I-JSON serialization compliance should be enforced.

A B C D E F G I J K L N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form