diff --git a/tck-docs/assertions/JSONBJavadocAssertions.html b/tck-docs/assertions/JSONBJavadocAssertions.html new file mode 100644 index 00000000..9af6567b --- /dev/null +++ b/tck-docs/assertions/JSONBJavadocAssertions.html @@ -0,0 +1,1181 @@ + + + + + + JavaDoc Assertion Detail + + +
+
+

+ JSONB 3.0 +
+ Jakarta JSON Binding 3.0 +
+ JavaDoc Assertion Detail + +

+
+ + + + + + + + + + + +
TotalsTotalActiveDeprecatedRemoved
+ # of Assertions + 10810017
+ # of Required Assertions + 10810017
+ # of Optional Assertions + 0000
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IDReturnMethod/FieldDescriptionRequiredDeprecatedTestable
JSONB:JAVADOC:1Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + String + , +
+ Class + ) +
Reads in a JSON data from the specified string and return the resulting content tree.true +
+
true
JSONB:JAVADOC:2Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + String + , +
+ Class + ) + +
+ throws + JsonbException +
+
If any unexpected error(s) occur(s) during deserialization.true +
+
false
JSONB:JAVADOC:3Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + String + , +
+ Type + ) +
Reads in a JSON data from the specified string and return the resulting content tree.true +
+
true
JSONB:JAVADOC:4Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + String + , +
+ Type + ) + +
+ throws + JsonbException +
+
If any unexpected error(s) occur(s) during deserialization.true +
+
false
JSONB:JAVADOC:5Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + Reader + , +
+ Class + ) +
Reads in a JSON data from the specified Reader and return the resulting content tree.true +
+
true
JSONB:JAVADOC:6Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + Reader + , +
+ Class + ) + +
+ throws + JsonbException +
+
If any unexpected error(s) occur(s) during deserialization.true +
+
false
JSONB:JAVADOC:7Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + Reader + , +
+ Type + ) +
Reads in a JSON data from the specified Reader and return the resulting content tree.true +
+
true
JSONB:JAVADOC:8Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + Reader + , +
+ Type + ) + +
+ throws + JsonbException +
+
If any unexpected error(s) occur(s) during deserialization.true +
+
false
JSONB:JAVADOC:9Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + InputStream + , +
+ Class + ) +
Reads in a JSON data from the specified InputStream and return the resulting content tree.true +
+
true
JSONB:JAVADOC:10Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + InputStream + , +
+ Class + ) + +
+ throws + JsonbException +
+
If any unexpected error(s) occur(s) during deserialization.true +
+
false
JSONB:JAVADOC:11Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + InputStream + , +
+ Type + ) +
Reads in a JSON data from the specified InputStream and return the resulting content tree.true +
+
true
JSONB:JAVADOC:12Objectjakarta.json.bind.Jsonb.fromJson +
+ ( + InputStream + , +
+ Type + ) + +
+ throws + JsonbException +
+
If any unexpected error(s) occur(s) during deserialization.true +
+
false
JSONB:JAVADOC:13Stringjakarta.json.bind.Jsonb.toJson +
+ ( + Object + ) +
Writes the Java object tree with root object object to a String instance as JSON.true +
+
true
JSONB:JAVADOC:14Stringjakarta.json.bind.Jsonb.toJson +
+ ( + Object + ) + +
+ throws + JsonbException +
+
If any unexpected problem occurs during the serialization, such as I/O error.true +
+
false
JSONB:JAVADOC:15Stringjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Type + ) +
Writes the Java object tree with root object object to a String instance as JSON.true +
+
true
JSONB:JAVADOC:16Stringjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Type + ) + +
+ throws + JsonbException +
+
If any unexpected problem occurs during the serialization, such as I/O error.true +
+
false
JSONB:JAVADOC:17voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Writer + ) +
Writes the object content tree into a Writer character stream.true +
+
true
JSONB:JAVADOC:18voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Writer + ) + +
+ throws + JsonbException +
+
If any unexpected problem occurs during the serialization.true +
+
false
JSONB:JAVADOC:19voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Type + , +
+ Writer + ) +
Writes the object content tree into a Writer character stream.true +
+
true
JSONB:JAVADOC:20voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Type + , +
+ Writer + ) + +
+ throws + JsonbException +
+
If any unexpected problem occurs during the serialization.true +
+
false
JSONB:JAVADOC:21voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ OutputStream + ) +
Writes the object content tree into output stream.true +
+
true
JSONB:JAVADOC:22voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ OutputStream + ) + +
+ throws + JsonbException +
+
If any unexpected problem occurs during the serialization.true +
+
false
JSONB:JAVADOC:23voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Type + , +
+ OutputStream + ) +
Writes the object content tree into output stream.true +
+
true
JSONB:JAVADOC:24voidjakarta.json.bind.Jsonb.toJson +
+ ( + Object + , +
+ Type + , +
+ OutputStream + ) + +
+ throws + JsonbException +
+
If any unexpected problem occurs during the serialization.true +
+
false
JSONB:JAVADOC:25Jsonbjakarta.json.bind.JsonbBuilder.build +
+
Returns a new instance of jakarta.json.bind.Jsonb Jsonb based on the parameters and configuration specified previously in this builder.true +
+
true
JSONB:JAVADOC:26Jsonbjakarta.json.bind.JsonbBuilder.create +
+
Create a new jakarta.json.bind.Jsonb instance using the default JsonbBuilder implementation provided as returned from jakarta.json.bind.spi.JsonbProvider#provider() method.true +
+
true
JSONB:JAVADOC:27Jsonbjakarta.json.bind.JsonbBuilder.create +
+ ( + JsonbConfig + ) +
Create a new jakarta.json.bind.Jsonb instance using the default JsonbBuilder implementation provided as returned from jakarta.json.bind.spi.JsonbProvider#provider() method, configured with provided configuration.true +
+
true
JSONB:JAVADOC:28JsonbBuilderjakarta.json.bind.JsonbBuilder.newBuilder +
+
Create a new JsonbBuilder instance as returned by the default jakarta.json.bind.spi.JsonbProvider#provider() method.true +
+
true
JSONB:JAVADOC:29JsonbBuilderjakarta.json.bind.JsonbBuilder.newBuilder +
+ ( + String + ) +
Create a new JsonbBuilder instance as returned by jakarta.json.bind.spi.JsonbProvider#provider(String) method.true +
+
true
JSONB:JAVADOC:30JsonbBuilderjakarta.json.bind.JsonbBuilder.newBuilder +
+ ( + JsonbProvider + ) +
Create a new JsonbBuilder instance as returned by provider#create call.true +
+
true
JSONB:JAVADOC:31JsonbBuilderjakarta.json.bind.JsonbBuilder.withConfig +
+ ( + JsonbConfig + ) +
Set configuration which will be set to the newly created jakarta.json.bind.Jsonb Jsonb instance.true +
+
true
JSONB:JAVADOC:33Mapjakarta.json.bind.JsonbConfig.getAsMap +
+
Return all configuration properties as an unmodifiable map.true +
+
true
JSONB:JAVADOC:34Optionaljakarta.json.bind.JsonbConfig.getProperty +
+ ( + String + ) +
Return value of particular configuration property. The method can only be used to retrieve one of the standard JSON Binding properties defined in this class or a provider specific property. Attempting to get an undefined property will result in an empty Optional value. See Supported Properties.true +
+
true
JSONB:JAVADOC:35JsonbConfigjakarta.json.bind.JsonbConfig.JsonbConfig +
+
+
+
true +
+
true
JSONB:JAVADOC:36JsonbConfigjakarta.json.bind.JsonbConfig.setProperty +
+ ( + String + , +
+ Object + ) +
Set the particular configuration property to a new value. The method can only be used to set one of the standard JSON Binding properties defined in this class or a provider specific property.true +
+
true
JSONB:JAVADOC:51JsonbExceptionjakarta.json.bind.JsonbException.JsonbException +
+ ( + String + ) +
Constructs a new runtime exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to #initCause.true +
+
true
JSONB:JAVADOC:52JsonbExceptionjakarta.json.bind.JsonbException.JsonbException +
+ ( + String + , +
+ Throwable + ) +
Constructs a new runtime exception with the specified detail message and cause. Note that the detail message associated with cause is not automatically incorporated in this runtime exception's detail message.true +
+
true
JSONB:JAVADOC:53Objectjakarta.json.bind.adapter.JsonbAdapter.adaptFromJson +
+ ( + Object + ) +
This method is used on deserialization only. It contains a conversion logic from type Adapted to type Original.true +
+
true
JSONB:JAVADOC:54Objectjakarta.json.bind.adapter.JsonbAdapter.adaptFromJson +
+ ( + Object + ) + +
+ throws + Exception +
+
if there is an error during the conversion.true +
+
false
JSONB:JAVADOC:55Objectjakarta.json.bind.adapter.JsonbAdapter.adaptToJson +
+ ( + Object + ) +
This method is used on serialization only. It contains a conversion logic from type Original to type Adapted. After conversion Adapted type will be mapped to JSON the standard way.true +
+
true
JSONB:JAVADOC:56Objectjakarta.json.bind.adapter.JsonbAdapter.adaptToJson +
+ ( + Object + ) + +
+ throws + Exception +
+
if there is an error during the conversion.true +
+
false
JSONB:JAVADOC:57Stringjakarta.json.bind.annotation.JsonbDateFormat.locale +
+
Custom java.util.Locale to use.true +
+
true
JSONB:JAVADOC:58Stringjakarta.json.bind.annotation.JsonbDateFormat.value +
+
Specifies the date pattern to use.true +
+
true
JSONB:JAVADOC:60Stringjakarta.json.bind.annotation.JsonbNumberFormat.locale +
+
Custom java.util.Locale to use.true +
+
true
JSONB:JAVADOC:61Stringjakarta.json.bind.annotation.JsonbNumberFormat.value +
+
Specifies the number pattern to use.true +
+
true
JSONB:JAVADOC:63Stringjakarta.json.bind.annotation.JsonbProperty.value +
+
Customized name of the field (or JavaBean property).true +
+
true
JSONB:JAVADOC:64String[]jakarta.json.bind.annotation.JsonbPropertyOrder.value +
+
Order in which properties are serialized. Names must correspond to original names defined in Java class before any customization applied.true +
+
true
JSONB:JAVADOC:65Classjakarta.json.bind.annotation.JsonbTypeAdapter.value +
+
Custom JsonbAdapter which provides custom mapping for given field or JavaBean property.true +
+
true
JSONB:JAVADOC:66Classjakarta.json.bind.annotation.JsonbTypeDeserializer.value +
+
Custom JsonbDeserializer which provides custom mapping for given field or JavaBean property.true +
+
true
JSONB:JAVADOC:67Classjakarta.json.bind.annotation.JsonbTypeSerializer.value +
+
Custom JsonbSerializer which provides custom mapping for given field or JavaBean property.true +
+
true
JSONB:JAVADOC:68Classjakarta.json.bind.annotation.JsonbVisibility.value +
+
Custom property visibility strategy used to resolve visibility of the members.true +
+
true
JSONB:JAVADOC:69Stringjakarta.json.bind.config.PropertyNamingStrategy.translateName +
+ ( + String + ) +
Translates the property name into its JSON field name representation.true +
+
true
JSONB:JAVADOC:70booleanjakarta.json.bind.config.PropertyVisibilityStrategy.isVisible +
+ ( + Field + ) +
Responds whether the given field should be considered as the JsonbProperty.true +
+
true
JSONB:JAVADOC:71booleanjakarta.json.bind.config.PropertyVisibilityStrategy.isVisible +
+ ( + Method + ) +
Responds whether the given method should be considered as the JsonbProperty.true +
+
true
JSONB:JAVADOC:78JsonbBuilderjakarta.json.bind.spi.JsonbProvider.create +
+
Returns a new instance of jakarta.json.bind.JsonbBuilder JsonbBuilder class. jakarta.json.bind.JsonbBuilder JsonbBuilder provides necessary getter methods to access required parameters.true +
+
true
JSONB:JAVADOC:80JsonbProviderjakarta.json.bind.spi.JsonbProvider.provider +
+
Creates a JSON Binding provider object by using the java.util.ServiceLoader#load(Class) method. The first provider of JsonbProvider class from list of providers returned by ServiceLoader.load call is returned. If there are no available service providers, this method tries to load the default service provider using Class#forName(String) method.true +
+
true
JSONB:JAVADOC:81JsonbProviderjakarta.json.bind.spi.JsonbProvider.provider +
+ ( + String + ) +
Creates a JSON Binding provider object by using the java.util.ServiceLoader#load(Class) method, matching providerName. The first provider of JsonbProvider class from list of providers returned by ServiceLoader.load call, matching providerName is returned. If no such provider is found, JsonbException is thrown.true +
+
true
JSONB:JAVADOC:37__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withAdapters +
+ ( + JsonbAdapter[] + ) +
Property used to specify custom mapping adapters. Configures value of ADAPTERS property. Calling withAdapters more than once will merge the adapters with previous value.true +
+
true
JSONB:JAVADOC:37JsonbConfigjakarta.json.bind.JsonbConfig.withAdapters +
+ ( + JsonbAdapter[] + ) +
Property used to specify custom mapping adapters. Configures value of #ADAPTERS property. Calling withAdapters more than once will merge the adapters with previous value.true +
+
true
JSONB:JAVADOC:38__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withBinaryDataStrategy +
+ ( + String + ) +
Property used to specify custom binary data strategy. Configures value of BINARY_DATA_STRATEGY property.true +
+
true
JSONB:JAVADOC:38JsonbConfigjakarta.json.bind.JsonbConfig.withBinaryDataStrategy +
+ ( + String + ) +
Property used to specify custom binary data strategy. Configures value of #BINARY_DATA_STRATEGY property.true +
+
true
JSONB:JAVADOC:39__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withDateFormat +
+ ( + String + , +
+ Locale + ) +
Property used to specify custom date format. This format will be used by default for all date classes serialization and deserialization.true +
+
true
JSONB:JAVADOC:39JsonbConfigjakarta.json.bind.JsonbConfig.withDateFormat +
+ ( + String + , +
+ Locale + ) +
Property used to specify custom date format. This format will be used by default for all date classes serialization and deserialization. Configures values of #DATE_FORMAT and #LOCALE properties.true +
+
true
JSONB:JAVADOC:40__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withDeserializers +
+ ( + JsonbDeserializer[] + ) +
Property used to specify custom deserializers. Configures value of DESERIALIZERS property. Calling withDeserializers more than once will merge the deserializers with previous value.true +
+
true
JSONB:JAVADOC:40JsonbConfigjakarta.json.bind.JsonbConfig.withDeserializers +
+ ( + JsonbDeserializer[] + ) +
Property used to specify custom deserializers. Configures value of #DESERIALIZERS property. Calling withDeserializers more than once will merge the deserializers with previous value.true +
+
true
JSONB:JAVADOC:41__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withEncoding +
+ ( + String + ) +
The binding operations will default to this property for encoding of JSON data. For input data (fromJson), selected encoding is used if the encoding cannot be detected automatically. Default value is 'UTF-8'. Configures value of ENCODING property.true +
+
true
JSONB:JAVADOC:41JsonbConfigjakarta.json.bind.JsonbConfig.withEncoding +
+ ( + String + ) +
The binding operations will default to this property for encoding of JSON data. For input data (fromJson), selected encoding is used if the encoding cannot be detected automatically. Default value is 'UTF-8'. Configures value of #ENCODING property.true +
+
true
JSONB:JAVADOC:42__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withFormatting +
+ ( + Boolean + ) +
Property used to specify whether or not the serialized JSON data is formatted with linefeeds and indentation. Configures value of FORMATTING property.true +
+
true
JSONB:JAVADOC:42JsonbConfigjakarta.json.bind.JsonbConfig.withFormatting +
+ ( + Boolean + ) +
Property used to specify whether or not the serialized JSON data is formatted with linefeeds and indentation. Configures value of #FORMATTING property.true +
+
true
JSONB:JAVADOC:43__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withLocale +
+ ( + Locale + ) +
Property used to specify custom locale.true +
+
true
JSONB:JAVADOC:43JsonbConfigjakarta.json.bind.JsonbConfig.withLocale +
+ ( + Locale + ) +
Property used to specify custom locale. Configures value of #LOCALE property.true +
+
true
JSONB:JAVADOC:44__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withNullValues +
+ ( + Boolean + ) +
Property used to specify whether null values should be serialized to JSON document or skipped. Configures value of NULL_VALUES property.true +
+
true
JSONB:JAVADOC:44JsonbConfigjakarta.json.bind.JsonbConfig.withNullValues +
+ ( + Boolean + ) +
Property used to specify whether null values should be serialized to JSON document or skipped. Configures value of #NULL_VALUES property.true +
+
true
JSONB:JAVADOC:45__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withPropertyNamingStrategy +
+ ( + PropertyNamingStrategy + ) +
Property used to specify custom naming strategy. Configures value of JSONB_PROPERTY_NAMING_STRATEGY property.true +
+
true
JSONB:JAVADOC:45JsonbConfigjakarta.json.bind.JsonbConfig.withPropertyNamingStrategy +
+ ( + PropertyNamingStrategy + ) +
Property used to specify custom naming strategy. Configures value of #PROPERTY_NAMING_STRATEGY property.true +
+
true
JSONB:JAVADOC:46__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withPropertyNamingStrategy +
+ ( + String + ) +
Property used to specify custom naming strategy. Configures value of JSONB_PROPERTY_NAMING_STRATEGY property.true +
+
true
JSONB:JAVADOC:46JsonbConfigjakarta.json.bind.JsonbConfig.withPropertyNamingStrategy +
+ ( + String + ) +
Property used to specify custom naming strategy. Configures value of #PROPERTY_NAMING_STRATEGY property.true +
+
true
JSONB:JAVADOC:47__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withPropertyOrderStrategy +
+ ( + String + ) +
Property used to specify property order strategy. Configures values of JSONB_PROPERTY_ORDER_STRATEGY property.true +
+
true
JSONB:JAVADOC:47JsonbConfigjakarta.json.bind.JsonbConfig.withPropertyOrderStrategy +
+ ( + String + ) +
Property used to specify property order strategy. Configures values of #PROPERTY_ORDER_STRATEGY property.true +
+
true
JSONB:JAVADOC:48__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withPropertyVisibilityStrategy +
+ ( + PropertyVisibilityStrategy + ) +
Property used to specify custom property visibility strategy. Configures value of PROPERTY_VISIBILITY_STRATEGY property.true +
+
true
JSONB:JAVADOC:48JsonbConfigjakarta.json.bind.JsonbConfig.withPropertyVisibilityStrategy +
+ ( + PropertyVisibilityStrategy + ) +
Property used to specify custom property visibility strategy. Configures value of #PROPERTY_VISIBILITY_STRATEGY property.true +
+
true
JSONB:JAVADOC:49__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withSerializers +
+ ( + JsonbSerializer[] + ) +
Property used to specify custom serializers. Configures value of SERIALIZERS property. Calling withSerializers more than once will merge the serializers with previous value.true +
+
true
JSONB:JAVADOC:49JsonbConfigjakarta.json.bind.JsonbConfig.withSerializers +
+ ( + JsonbSerializer[] + ) +
Property used to specify custom serializers. Configures value of #SERIALIZERS property. Calling withSerializers more than once will merge the serializers with previous value.true +
+
true
JSONB:JAVADOC:50__OLDJsonbConfigjakarta.json.bind.JsonbConfig.withStrictIJSON +
+ ( + Boolean + ) +
Property used to specify whether strict I-JSON serialization compliance should be enforced. Configures value of STRICT_IJSON property.true +
+
true
JSONB:JAVADOC:50JsonbConfigjakarta.json.bind.JsonbConfig.withStrictIJSON +
+ ( + Boolean + ) +
Property used to specify whether strict I-JSON serialization compliance should be enforced. Configures value of #STRICT_IJSON property.true +
+
true
JSONB:JAVADOC:59__OLDbooleanjakarta.json.bind.annotation.JsonbNillable.value +
+
True if field with null value should be serialized as key/value pair into JSON with null value.true +
+
true
JSONB:JAVADOC:59booleanjakarta.json.bind.annotation.JsonbNillable.value +
+
Switches on/off serialization of properties with null value.true +
+
true
JSONB:JAVADOC:62__OLDbooleanjakarta.json.bind.annotation.JsonbProperty.nillable +
+
True if field with null value should be serialized as key/value pair into JSON with null value.true +
+
true
JSONB:JAVADOC:62booleanjakarta.json.bind.annotation.JsonbProperty.nillable +
+
Switches on/off serialization of null values.truetruetrue
JSONB:JAVADOC:82JsonbBuilderjakarta.json.bind.JsonbBuilder.withProvider +
+ ( + JsonProvider + ) +
Provides a JSON-P provider to be used for all JSON-P related operations.true +
+
true
JSONB:JAVADOC:83JsonbConfigjakarta.json.bind.JsonbConfig.withCreatorParametersRequired +
+ ( + boolean + ) +
Property used to specify whether all creator parameters should be treated as required. Default value is false.true +
+
true
JSONB:JAVADOC:84Stringjakarta.json.bind.annotation.JsonbSubtype.alias +
+
Type alias which is used instead of a class name.true +
+
true
JSONB:JAVADOC:85Classjakarta.json.bind.annotation.JsonbSubtype.type +
+
An actual type bound to the alias.true +
+
true
JSONB:JAVADOC:86Stringjakarta.json.bind.annotation.JsonbTypeInfo.key +
+
Key used for keeping the type information (alias). Default value is @type.true +
+
true
JSONB:JAVADOC:87JsonbSubtype[]jakarta.json.bind.annotation.JsonbTypeInfo.value +
+
Allowed aliases of the handled type.true +
+
true
JSONB:JAVADOC:88Objectjakarta.json.bind.serializer.DeserializationContext.deserialize +
+ ( + Class + , +
+ JsonParser + ) +
Deserialize JSON stream into instance of provided class using jakarta.json.stream.JsonParser. JsonParser cursor have to be at KEY_NAME before START_OBJECT / START_ARRAY, or at START_OBJECT / START_ARRAY to call this method. After deserialization is complete JsonParser will be at END_OBJECT / END_ARRAY for deserialized JSON structure. If method is called for the same type, which is deserializer bound to, deserializer recursion is suppressed. Otherwise deserializers are reentrant during deserialization process started by this method. JsonParser instance of JSONB runtime is shared with custom deserializer.true +
+
true
JSONB:JAVADOC:89Objectjakarta.json.bind.serializer.DeserializationContext.deserialize +
+ ( + Type + , +
+ JsonParser + ) +
Deserialize JSON stream into instance of provided class using jakarta.json.stream.JsonParser. JsonParser cursor have to be at KEY_NAME before START_OBJECT / START_ARRAY, or at START_OBJECT / START_ARRAY to call this method. After deserialization is complete JsonParser will be at END_OBJECT / END_ARRAY for deserialized JSON structure. If method is called for the same type, which is deserializer bound to, deserializer recursion is suppressed. Otherwise deserializers are reentrant during deserialization process started by this method. JsonParser instance of JSONB runtime is shared with custom deserializer.true +
+
true
JSONB:JAVADOC:90Objectjakarta.json.bind.serializer.JsonbDeserializer.deserialize +
+ ( + JsonParser + , +
+ DeserializationContext + , +
+ Type + ) +
Deserialize JSON stream into object.true +
+
true
JSONB:JAVADOC:91voidjakarta.json.bind.serializer.JsonbSerializer.serialize +
+ ( + Object + , +
+ JsonGenerator + , +
+ SerializationContext + ) +
Serializes object into JSON stream.true +
+
true
JSONB:JAVADOC:92voidjakarta.json.bind.serializer.SerializationContext.serialize +
+ ( + String + , +
+ Object + , +
+ JsonGenerator + ) +
Serializes arbitrary object to JSON, using current jakarta.json.stream.JsonGenerator instance. Serialization is ran as serialization of a root type from user JsonbSerializer. JsonGenerator instance is shared with JSONB and user serializer.true +
+
true
JSONB:JAVADOC:93voidjakarta.json.bind.serializer.SerializationContext.serialize +
+ ( + Object + , +
+ JsonGenerator + ) +
Serializes arbitrary object to JSON, using current jakarta.json.stream.JsonGenerator instance. Serialization is ran as serialization of a root type from user JsonbSerializer. JsonGenerator instance is shared with JSONB and user serializer. Method without key parameter is intended to serialize inside JSON_ARRAYs.true +
+
true
+ + diff --git a/tck-docs/assertions/JSONBJavadocAssertions.xml b/tck-docs/assertions/JSONBJavadocAssertions.xml new file mode 100644 index 00000000..78e689f3 --- /dev/null +++ b/tck-docs/assertions/JSONBJavadocAssertions.xml @@ -0,0 +1,1267 @@ + + + + + + 94 + 82 + JSONB + JSONB 3.0 + Jakarta JSON Binding 3.0 + 3.0 + + + + + + 1 + Reads in a JSON data from the specified string and return the resulting content tree. + jakarta.json.bind + Jsonb + + + java.lang.String + java.lang.Class + + + + + 2 + If any unexpected error(s) occur(s) during deserialization. + jakarta.json.bind + Jsonb + + + java.lang.String + java.lang.Class + + jakarta.json.bind.JsonbException + + + + 3 + Reads in a JSON data from the specified string and return the resulting content tree. + jakarta.json.bind + Jsonb + + + java.lang.String + java.lang.reflect.Type + + + + + 4 + If any unexpected error(s) occur(s) during deserialization. + jakarta.json.bind + Jsonb + + + java.lang.String + java.lang.reflect.Type + + jakarta.json.bind.JsonbException + + + + 5 + Reads in a JSON data from the specified Reader and return the resulting content tree. + jakarta.json.bind + Jsonb + + + java.io.Reader + java.lang.Class + + + + + 6 + If any unexpected error(s) occur(s) during deserialization. + jakarta.json.bind + Jsonb + + + java.io.Reader + java.lang.Class + + jakarta.json.bind.JsonbException + + + + 7 + Reads in a JSON data from the specified Reader and return the resulting content tree. + jakarta.json.bind + Jsonb + + + java.io.Reader + java.lang.reflect.Type + + + + + 8 + If any unexpected error(s) occur(s) during deserialization. + jakarta.json.bind + Jsonb + + + java.io.Reader + java.lang.reflect.Type + + jakarta.json.bind.JsonbException + + + + 9 + Reads in a JSON data from the specified InputStream and return the resulting content tree. + jakarta.json.bind + Jsonb + + + java.io.InputStream + java.lang.Class + + + + + 10 + If any unexpected error(s) occur(s) during deserialization. + jakarta.json.bind + Jsonb + + + java.io.InputStream + java.lang.Class + + jakarta.json.bind.JsonbException + + + + 11 + Reads in a JSON data from the specified InputStream and return the resulting content tree. + jakarta.json.bind + Jsonb + + + java.io.InputStream + java.lang.reflect.Type + + + + + 12 + If any unexpected error(s) occur(s) during deserialization. + jakarta.json.bind + Jsonb + + + java.io.InputStream + java.lang.reflect.Type + + jakarta.json.bind.JsonbException + + + + 13 + Writes the Java object tree with root object object to a String instance as JSON. + jakarta.json.bind + Jsonb + + + java.lang.Object + + + + + 14 + If any unexpected problem occurs during the serialization, such as I/O error. + jakarta.json.bind + Jsonb + + + java.lang.Object + + jakarta.json.bind.JsonbException + + + + 15 + Writes the Java object tree with root object object to a String instance as JSON. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.lang.reflect.Type + + + + + 16 + If any unexpected problem occurs during the serialization, such as I/O error. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.lang.reflect.Type + + jakarta.json.bind.JsonbException + + + + 17 + Writes the object content tree into a Writer character stream. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.io.Writer + + + + + 18 + If any unexpected problem occurs during the serialization. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.io.Writer + + jakarta.json.bind.JsonbException + + + + 19 + Writes the object content tree into a Writer character stream. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.lang.reflect.Type + java.io.Writer + + + + + 20 + If any unexpected problem occurs during the serialization. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.lang.reflect.Type + java.io.Writer + + jakarta.json.bind.JsonbException + + + + 21 + Writes the object content tree into output stream. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.io.OutputStream + + + + + 22 + If any unexpected problem occurs during the serialization. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.io.OutputStream + + jakarta.json.bind.JsonbException + + + + 23 + Writes the object content tree into output stream. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.lang.reflect.Type + java.io.OutputStream + + + + + 24 + If any unexpected problem occurs during the serialization. + jakarta.json.bind + Jsonb + + + java.lang.Object + java.lang.reflect.Type + java.io.OutputStream + + jakarta.json.bind.JsonbException + + + + 25 + Returns a new instance of jakarta.json.bind.Jsonb Jsonb based on the parameters and configuration specified previously in this builder. + jakarta.json.bind + JsonbBuilder + + + + 26 + Create a new jakarta.json.bind.Jsonb instance using the default JsonbBuilder implementation provided as returned from jakarta.json.bind.spi.JsonbProvider#provider() method. + jakarta.json.bind + JsonbBuilder + + + + 27 + Create a new jakarta.json.bind.Jsonb instance using the default JsonbBuilder implementation provided as returned from jakarta.json.bind.spi.JsonbProvider#provider() method, configured with provided configuration. + jakarta.json.bind + JsonbBuilder + + + jakarta.json.bind.JsonbConfig + + + + + 28 + Create a new JsonbBuilder instance as returned by the default jakarta.json.bind.spi.JsonbProvider#provider() method. + jakarta.json.bind + JsonbBuilder + + + + 29 + Create a new JsonbBuilder instance as returned by jakarta.json.bind.spi.JsonbProvider#provider(String) method. + jakarta.json.bind + JsonbBuilder + + + java.lang.String + + + + + 30 + Create a new JsonbBuilder instance as returned by provider#create call. + jakarta.json.bind + JsonbBuilder + + + jakarta.json.bind.spi.JsonbProvider + + + + + 31 + Set configuration which will be set to the newly created jakarta.json.bind.Jsonb Jsonb instance. + jakarta.json.bind + JsonbBuilder + + + jakarta.json.bind.JsonbConfig + + + + + 33 + Return all configuration properties as an unmodifiable map. + jakarta.json.bind + JsonbConfig + + + + 34 + Return value of particular configuration property. The method can only be used to retrieve one of the standard JSON Binding properties defined in this class or a provider specific property. Attempting to get an undefined property will result in an empty Optional value. See Supported Properties. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + 35 + + jakarta.json.bind + JsonbConfig + + + + 36 + Set the particular configuration property to a new value. The method can only be used to set one of the standard JSON Binding properties defined in this class or a provider specific property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + java.lang.Object + + + + + 51 + Constructs a new runtime exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to #initCause. + jakarta.json.bind + JsonbException + + + java.lang.String + + + + + 52 + Constructs a new runtime exception with the specified detail message and cause. Note that the detail message associated with cause is not automatically incorporated in this runtime exception's detail message. + jakarta.json.bind + JsonbException + + + java.lang.String + java.lang.Throwable + + + + + 53 + This method is used on deserialization only. It contains a conversion logic from type Adapted to type Original. + jakarta.json.bind.adapter + JsonbAdapter + + + java.lang.Object + + + + + 54 + if there is an error during the conversion. + jakarta.json.bind.adapter + JsonbAdapter + + + java.lang.Object + + java.lang.Exception + + + + 55 + This method is used on serialization only. It contains a conversion logic from type Original to type Adapted. After conversion Adapted type will be mapped to JSON the standard way. + jakarta.json.bind.adapter + JsonbAdapter + + + java.lang.Object + + + + + 56 + if there is an error during the conversion. + jakarta.json.bind.adapter + JsonbAdapter + + + java.lang.Object + + java.lang.Exception + + + + 57 + Custom java.util.Locale to use. + jakarta.json.bind.annotation + JsonbDateFormat + + + + 58 + Specifies the date pattern to use. + jakarta.json.bind.annotation + JsonbDateFormat + + + + 60 + Custom java.util.Locale to use. + jakarta.json.bind.annotation + JsonbNumberFormat + + + + 61 + Specifies the number pattern to use. + jakarta.json.bind.annotation + JsonbNumberFormat + + + + 63 + Customized name of the field (or JavaBean property). + jakarta.json.bind.annotation + JsonbProperty + + + + 64 + Order in which properties are serialized. Names must correspond to original names defined in Java class before any customization applied. + jakarta.json.bind.annotation + JsonbPropertyOrder + + + + 65 + Custom JsonbAdapter which provides custom mapping for given field or JavaBean property. + jakarta.json.bind.annotation + JsonbTypeAdapter + + + + 66 + Custom JsonbDeserializer which provides custom mapping for given field or JavaBean property. + jakarta.json.bind.annotation + JsonbTypeDeserializer + + + + 67 + Custom JsonbSerializer which provides custom mapping for given field or JavaBean property. + jakarta.json.bind.annotation + JsonbTypeSerializer + + + + 68 + Custom property visibility strategy used to resolve visibility of the members. + jakarta.json.bind.annotation + JsonbVisibility + + + + 69 + Translates the property name into its JSON field name representation. + jakarta.json.bind.config + PropertyNamingStrategy + + + java.lang.String + + + + + 70 + Responds whether the given field should be considered as the JsonbProperty. + jakarta.json.bind.config + PropertyVisibilityStrategy + + + java.lang.reflect.Field + + + + + 71 + Responds whether the given method should be considered as the JsonbProperty. + jakarta.json.bind.config + PropertyVisibilityStrategy + + + java.lang.reflect.Method + + + + + 78 + Returns a new instance of jakarta.json.bind.JsonbBuilder JsonbBuilder class. jakarta.json.bind.JsonbBuilder JsonbBuilder provides necessary getter methods to access required parameters. + jakarta.json.bind.spi + JsonbProvider + + + + 80 + Creates a JSON Binding provider object by using the java.util.ServiceLoader#load(Class) method. The first provider of JsonbProvider class from list of providers returned by ServiceLoader.load call is returned. If there are no available service providers, this method tries to load the default service provider using Class#forName(String) method. + jakarta.json.bind.spi + JsonbProvider + + + + 81 + Creates a JSON Binding provider object by using the java.util.ServiceLoader#load(Class) method, matching providerName. The first provider of JsonbProvider class from list of providers returned by ServiceLoader.load call, matching providerName is returned. If no such provider is found, JsonbException is thrown. + jakarta.json.bind.spi + JsonbProvider + + + java.lang.String + + + + + + + + + + + + + + + + + 37__OLD + Property used to specify custom mapping adapters. Configures value of ADAPTERS property. Calling withAdapters more than once will merge the adapters with previous value. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.adapter.JsonbAdapter[] + + + + + + 37 + Property used to specify custom mapping adapters. Configures value of #ADAPTERS property. Calling withAdapters more than once will merge the adapters with previous value. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.adapter.JsonbAdapter[] + + + + + + + 38__OLD + Property used to specify custom binary data strategy. Configures value of BINARY_DATA_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + 38 + Property used to specify custom binary data strategy. Configures value of #BINARY_DATA_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + + 39__OLD + Property used to specify custom date format. This format will be used by default for all date classes serialization and deserialization. + jakarta.json.bind + JsonbConfig + + + java.lang.String + java.util.Locale + + + + + + 39 + Property used to specify custom date format. This format will be used by default for all date classes serialization and deserialization. Configures values of #DATE_FORMAT and #LOCALE properties. + jakarta.json.bind + JsonbConfig + + + java.lang.String + java.util.Locale + + + + + + + 40__OLD + Property used to specify custom deserializers. Configures value of DESERIALIZERS property. Calling withDeserializers more than once will merge the deserializers with previous value. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.serializer.JsonbDeserializer[] + + + + + + 40 + Property used to specify custom deserializers. Configures value of #DESERIALIZERS property. Calling withDeserializers more than once will merge the deserializers with previous value. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.serializer.JsonbDeserializer[] + + + + + + + 41__OLD + The binding operations will default to this property for encoding of JSON data. For input data (fromJson), selected encoding is used if the encoding cannot be detected automatically. Default value is 'UTF-8'. Configures value of ENCODING property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + 41 + The binding operations will default to this property for encoding of JSON data. For input data (fromJson), selected encoding is used if the encoding cannot be detected automatically. Default value is 'UTF-8'. Configures value of #ENCODING property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + + 42__OLD + Property used to specify whether or not the serialized JSON data is formatted with linefeeds and indentation. Configures value of FORMATTING property. + jakarta.json.bind + JsonbConfig + + + java.lang.Boolean + + + + + + 42 + Property used to specify whether or not the serialized JSON data is formatted with linefeeds and indentation. Configures value of #FORMATTING property. + jakarta.json.bind + JsonbConfig + + + java.lang.Boolean + + + + + + + 43__OLD + Property used to specify custom locale. + jakarta.json.bind + JsonbConfig + + + java.util.Locale + + + + + + 43 + Property used to specify custom locale. Configures value of #LOCALE property. + jakarta.json.bind + JsonbConfig + + + java.util.Locale + + + + + + + 44__OLD + Property used to specify whether null values should be serialized to JSON document or skipped. Configures value of NULL_VALUES property. + jakarta.json.bind + JsonbConfig + + + java.lang.Boolean + + + + + + 44 + Property used to specify whether null values should be serialized to JSON document or skipped. Configures value of #NULL_VALUES property. + jakarta.json.bind + JsonbConfig + + + java.lang.Boolean + + + + + + + 45__OLD + Property used to specify custom naming strategy. Configures value of JSONB_PROPERTY_NAMING_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.config.PropertyNamingStrategy + + + + + + 45 + Property used to specify custom naming strategy. Configures value of #PROPERTY_NAMING_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.config.PropertyNamingStrategy + + + + + + + 46__OLD + Property used to specify custom naming strategy. Configures value of JSONB_PROPERTY_NAMING_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + 46 + Property used to specify custom naming strategy. Configures value of #PROPERTY_NAMING_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + + 47__OLD + Property used to specify property order strategy. Configures values of JSONB_PROPERTY_ORDER_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + 47 + Property used to specify property order strategy. Configures values of #PROPERTY_ORDER_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + java.lang.String + + + + + + + 48__OLD + Property used to specify custom property visibility strategy. Configures value of PROPERTY_VISIBILITY_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.config.PropertyVisibilityStrategy + + + + + + 48 + Property used to specify custom property visibility strategy. Configures value of #PROPERTY_VISIBILITY_STRATEGY property. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.config.PropertyVisibilityStrategy + + + + + + + 49__OLD + Property used to specify custom serializers. Configures value of SERIALIZERS property. Calling withSerializers more than once will merge the serializers with previous value. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.serializer.JsonbSerializer[] + + + + + + 49 + Property used to specify custom serializers. Configures value of #SERIALIZERS property. Calling withSerializers more than once will merge the serializers with previous value. + jakarta.json.bind + JsonbConfig + + + jakarta.json.bind.serializer.JsonbSerializer[] + + + + + + + 50__OLD + Property used to specify whether strict I-JSON serialization compliance should be enforced. Configures value of STRICT_IJSON property. + jakarta.json.bind + JsonbConfig + + + java.lang.Boolean + + + + + + 50 + Property used to specify whether strict I-JSON serialization compliance should be enforced. Configures value of #STRICT_IJSON property. + jakarta.json.bind + JsonbConfig + + + java.lang.Boolean + + + + + + + 59__OLD + True if field with null value should be serialized as key/value pair into JSON with null value. + jakarta.json.bind.annotation + JsonbNillable + + + + + 59 + Switches on/off serialization of properties with null value. + jakarta.json.bind.annotation + JsonbNillable + + + + + + 62__OLD + True if field with null value should be serialized as key/value pair into JSON with null value. + jakarta.json.bind.annotation + JsonbProperty + + + + + 62 + Switches on/off serialization of null values. + jakarta.json.bind.annotation + JsonbProperty + + + + + + + + 32 + Provides a JSON-P provider to be used for all JSON-P related operations. + jakarta.json.bind + JsonbBuilder + + + JsonProvider + + + + + + 72 + Deserialize JSON stream into instance of provided class using jakarta.json.stream.JsonParser. JsonParser cursor have to be at KEY_NAME before START_OBJECT / START_ARRAY, or at START_OBJECT / START_ARRAY to call this method. After deserialization is complete JsonParser will be at END_OBJECT / END_ARRAY for deserialized JSON structure. If method is called for the same type, which is deserializer bound to, deserializer recursion is suppressed. Otherwise deserializers are reentrant during deserialization process started by this method. JsonParser instance of JSONB runtime is shared with custom deserializer. + jakarta.json.bind.serializer + DeserializationContext + + + java.lang.Class + JsonParser + + + + + + 73 + Deserialize JSON stream into instance of provided class using jakarta.json.stream.JsonParser. JsonParser cursor have to be at KEY_NAME before START_OBJECT / START_ARRAY, or at START_OBJECT / START_ARRAY to call this method. After deserialization is complete JsonParser will be at END_OBJECT / END_ARRAY for deserialized JSON structure. If method is called for the same type, which is deserializer bound to, deserializer recursion is suppressed. Otherwise deserializers are reentrant during deserialization process started by this method. JsonParser instance of JSONB runtime is shared with custom deserializer. + jakarta.json.bind.serializer + DeserializationContext + + + java.lang.reflect.Type + JsonParser + + + + + + 74 + Deserialize JSON stream into object. + jakarta.json.bind.serializer + JsonbDeserializer + + + JsonParser + jakarta.json.bind.serializer.DeserializationContext + java.lang.reflect.Type + + + + + + 75 + Serializes object into JSON stream. + jakarta.json.bind.serializer + JsonbSerializer + + + java.lang.Object + JsonGenerator + jakarta.json.bind.serializer.SerializationContext + + + + + + 76 + Serializes arbitrary object to JSON, using current jakarta.json.stream.JsonGenerator instance. Serialization is ran as serialization of a root type from user JsonbSerializer. JsonGenerator instance is shared with JSONB and user serializer. + jakarta.json.bind.serializer + SerializationContext + + + java.lang.String + java.lang.Object + JsonGenerator + + + + + + 77 + Serializes arbitrary object to JSON, using current jakarta.json.stream.JsonGenerator instance. Serialization is ran as serialization of a root type from user JsonbSerializer. JsonGenerator instance is shared with JSONB and user serializer. Method without key parameter is intended to serialize inside JSON_ARRAYs. + jakarta.json.bind.serializer + SerializationContext + + + java.lang.Object + JsonGenerator + + + + + + + + + JSONB:JAVADOC:82 + Provides a JSON-P provider to be used for all JSON-P related operations. + jakarta.json.bind + JsonbBuilder + + + jakarta.json.spi.JsonProvider + + + + + + JSONB:JAVADOC:83 + Property used to specify whether all creator parameters should be treated as required. Default value is false. + jakarta.json.bind + JsonbConfig + + + boolean + + + + + + JSONB:JAVADOC:84 + Type alias which is used instead of a class name. + jakarta.json.bind.annotation + JsonbSubtype + + + + + JSONB:JAVADOC:85 + An actual type bound to the alias. + jakarta.json.bind.annotation + JsonbSubtype + + + + + JSONB:JAVADOC:86 + Key used for keeping the type information (alias). Default value is @type. + jakarta.json.bind.annotation + JsonbTypeInfo + + + + + JSONB:JAVADOC:87 + Allowed aliases of the handled type. + jakarta.json.bind.annotation + JsonbTypeInfo + + + + + JSONB:JAVADOC:88 + Deserialize JSON stream into instance of provided class using jakarta.json.stream.JsonParser. JsonParser cursor have to be at KEY_NAME before START_OBJECT / START_ARRAY, or at START_OBJECT / START_ARRAY to call this method. After deserialization is complete JsonParser will be at END_OBJECT / END_ARRAY for deserialized JSON structure. If method is called for the same type, which is deserializer bound to, deserializer recursion is suppressed. Otherwise deserializers are reentrant during deserialization process started by this method. JsonParser instance of JSONB runtime is shared with custom deserializer. + jakarta.json.bind.serializer + DeserializationContext + + + java.lang.Class + jakarta.json.stream.JsonParser + + + + + + JSONB:JAVADOC:89 + Deserialize JSON stream into instance of provided class using jakarta.json.stream.JsonParser. JsonParser cursor have to be at KEY_NAME before START_OBJECT / START_ARRAY, or at START_OBJECT / START_ARRAY to call this method. After deserialization is complete JsonParser will be at END_OBJECT / END_ARRAY for deserialized JSON structure. If method is called for the same type, which is deserializer bound to, deserializer recursion is suppressed. Otherwise deserializers are reentrant during deserialization process started by this method. JsonParser instance of JSONB runtime is shared with custom deserializer. + jakarta.json.bind.serializer + DeserializationContext + + + java.lang.reflect.Type + jakarta.json.stream.JsonParser + + + + + + JSONB:JAVADOC:90 + Deserialize JSON stream into object. + jakarta.json.bind.serializer + JsonbDeserializer + + + jakarta.json.stream.JsonParser + jakarta.json.bind.serializer.DeserializationContext + java.lang.reflect.Type + + + + + + JSONB:JAVADOC:91 + Serializes object into JSON stream. + jakarta.json.bind.serializer + JsonbSerializer + + + java.lang.Object + jakarta.json.stream.JsonGenerator + jakarta.json.bind.serializer.SerializationContext + + + + + + JSONB:JAVADOC:92 + Serializes arbitrary object to JSON, using current jakarta.json.stream.JsonGenerator instance. Serialization is ran as serialization of a root type from user JsonbSerializer. JsonGenerator instance is shared with JSONB and user serializer. + jakarta.json.bind.serializer + SerializationContext + + + java.lang.String + java.lang.Object + jakarta.json.stream.JsonGenerator + + + + + + JSONB:JAVADOC:93 + Serializes arbitrary object to JSON, using current jakarta.json.stream.JsonGenerator instance. Serialization is ran as serialization of a root type from user JsonbSerializer. JsonGenerator instance is shared with JSONB and user serializer. Method without key parameter is intended to serialize inside JSON_ARRAYs. + jakarta.json.bind.serializer + SerializationContext + + + java.lang.Object + jakarta.json.stream.JsonGenerator + + + + + + diff --git a/tck-docs/assertions/JSONBSpecAssertions.html b/tck-docs/assertions/JSONBSpecAssertions.html new file mode 100644 index 00000000..eb87d73a --- /dev/null +++ b/tck-docs/assertions/JSONBSpecAssertions.html @@ -0,0 +1,1020 @@ + + + + + +Specification Assertion Detail + + +
+
+

Jakarta JSON Binding - 3.0
+Specification Assertion Detail +

+
+ + + + + + + + + + + +
TotalsTotalActiveDeprecatedRemoved
+# of Assertions +16916801
+# of Required Assertions +16216101
+# of Optional Assertions +7700
+
Assertions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IDChapterSectionDescriptionRequiredDependencyImplementation SpecificDefined byStatusTestable
JSONB:SPEC:JSB-3.1-133.1JSON Binding implementations MUST support binding of JSON documents as defined in RFC 7159 JSON Grammar. Serialized JSON output MUST conform to the RFC 7159 JSON Grammar and be encoded in UTF-8 encoding as defined in Section 8.1 (Character Encoding) of RFC 7159 + true +
+
falsetechnologyactivefalse
JSONB:SPEC:JSB-3.1-233.1Implementations MUST support deserialization of documents conforming to RFC 7159 JSON Grammartrue +
+
falsetechnologyactivefalse
JSONB:SPEC:JSB-3.1-333.1In addition, implementations SHOULD NOT allow deserialization of RFC 7159 non-conforming text (e.g. unsupported encoding, ...) and report error in such casefalse +
+
falsetechnologyactivefalse
JSONB:SPEC:JSB-3.1-433.1Detection of UTF encoding of deserialized document is done as defined in the Section 3 (Encoding) of RFC 4627true +
+
falsetechnologyactivefalse
JSONB:SPEC:JSB-3.1-533.1Implementations SHOULD ignore presence of UTF byte order mark (BOM) and not treat it as an error.false +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.2-133.2Implementations SHOULD NOT allow unmarshalling of RFC 7159 non-conforming text (e.g. unsupported encoding) and report error in such case.false +
+
falsetechnologyactivefalse
JSONB:SPEC:JSB-3.2-233.2Implementation SHOULD also report error also during unmarshalling operation, if it is not possible to represent JSON document value in the expected Java typefalse +
+
falsetechnologyactivefalse
JSONB:SPEC:JSB-3.3-133.3Implementation MUST report binding of the following basic java classes and their corresponding primitive types +java.lang.String +java.lang.Character +java.lang.Byte +java.lang.Short +java.lang.Integer +java.lang.Long +java.lang.Float +java.lang.Double +java.lang.Booleantrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.1-133.3.1Instances of type java.lang.String and java.lang.Character are marshalled to JSON String values as defined within RFC 7159 Section 7 (Strings) in UTF-8 encoding without byte order mark. true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.1-233.3.1Implementations SHOULD support deserialization of JSON text in other (than UTF-8) UTF encodings into java.lang.String instancesfalse +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.2-133.3.2Serialization of type java.lang.Byte, Short, Integer, Long, Float, Double and their corresponding primitive types to JSON Number MUST follow the conversion process defined in javadoc specification for the corresponding toString methodtrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.2-233.3.2Deserialization of a JSON value into java.lang.Byte, Short, Integer, Long, Float, Double instance or corresponding primitive type MUST follow the conversion process as defined in the specification for their corresponding parse$Type method, such as java.lang.Byte.parseByte for Byte.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.3-133.3.3Serialization of type java.lang.Boolean and its corresponding boolean primitive type to JSON value MUST follow conversion process defined in specification for java.lang.Boolean.toString methodtrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.3-233.3.3Deserialization of a JSON value into java.lang.Boolean instance or boolean primitive type MUST follow the conversion process as defined in specification for java.lang.Boolean.parseBoolean method.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.4-133.3.4Serialization of type java.lang.Number (if their more concrete type is not defined elsewhere in this chapter) to JSON string MUST retrieve double value returned from java.lang.Number.doubleValue() method and converting the value to JSON Number as defined in subsection 3.3.2true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.3.4-233.3.4Deserialization of a JSON value into Java type java.lang.Number should return instance of java.math.BigDecimal by using conversion as defined in the specification for constructor of java.math.BigDecimal with java.lang.String.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4-133.4Implementations MUST support binding of the following standard Java SE classes: +java.math.BigInteger +java.math.BigDecimal +java.net.URL +java.net.URI +java.util.Optional +java.util.OptionalInt +java.util.OptionalLong +java.util.OptionalDouble true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.1-133.4.1Serialization of type java.math.BigInteger, BigDecimal to s JSON Number MUST follow the conversion process defined in specification for their toString methodtrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.1-233.4.1Deserialization of JSON value into java.math.BigInteger, BigDecimal instance MUST follow the conversion process as defined in the specification for constructor of java.math.BigInteger, BigDecimal with java.lang.String.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.2-133.4.2Serialization of type java.net.URL, URI to a JSON String value MUST follow the conversion process defined in specification for their toString methodtrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.2-233.4.2Deserialization of a JSON value into java.net.URL, URI instance MUST follow the conversion process as defined in the specification for constructor of java.net.URL, URI with java.lang.String input.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.3-133.4.3Non-empty instances of type java.util.Optional, OptionalInt, OptionalLong, OptionalDouble are serialized to a JSON value by retrieving their contained instance and converting it to JSON value based on its type and corresponding mapping definitions within this chapter.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.3-233.4.3Class fields containing empty optional instances are treated as having a null value and serialized based on 3.14.1.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.3-333.4.3Empty optional instances in array items are serialized as null.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.3-433.4.3Deserializing into Optional, OptionalInt, OptionalLong, OptionalDouble return empty optional value for properties containing a null value.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.3-533.4.3Otherwise any non-empty Optional, OptionalInt, OptionalLong, OptionalDouble value is constructed of type unmarshalled based on mappings defined in this chapter.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.3-633.4.3Instances of type java.util.Optional T are serialized to a JSON value as JSON objects when T alone would be serialized as JSON object. When T would be serialized as a JSON value (e.g. java.lang.String, java.lang.Integer), an instance of java.util.Optional T is serialized as a JSON value (without curly brackets).true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.4.3-733.4.3Deserialization of a JSON value into java.util.Optional(T) MUST be supported if deserialization of a JSON value into instance of T is supported.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5-133.5Implementations MUST support binding of the following standard Java date/time classes: java.util.Date +java.util.Calendar +java.util.GregorianCalendar +java.util.TimeZone +java.util.SimpleTimeZone +java.time.Instant +java.time.Duration +java.time.Period +java.time.LocalDate +java.time.LocalTime +java.time.LocalDateTime +java.time.ZonedDateTime +java.time.ZoneId +java.time.ZoneOffset +java.time.OffsetDateTime +java.time.OffsetTimetrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5-233.5If not specified otherwise in this section, GMT standard time zone and offset specified from UTC Greenwich is used.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5-333.5If not specified otherwise, date time format for marshalling and unmarshalling is ISO 8601 without offset, as specified in java.time.format.DateTimeFormatter.ISO_DATE.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5-433.5Implementations MUST report error if the date/time string in JSON document does not correspond to the expected datetime format. true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5-533.5If in strict I-JSON compliance mode, default date format is changed as it’s described in 4.4.1.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.1-133.5.1The serialization format of java.util.Date, Calendar, GregorianCalendar instances with no time information is ISO_DATE.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.1-233.5.1If time information is present, the format is ISO_DATE_TIMEtrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.1-333.5.1Implementations MUST support deserialization of both ISO_DATE and ISO_DATE_TIME into java.util.Date, Calendar and GregorianCalendar instances.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.2-133.5.2Implementations MUST support deserialization of any time zone format specified in java.util.TimeZone into a field or property of type java.util.TimeZone and SimpleTimeZone.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.2-233.5.2Implementations MUST report an error for deprecated three-letter time zone IDs as specified in java.util.Timezone.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.2-333.5.2The serialization format of java.util.TimeZone and SimpleTimeZone is NormalizedCustomID as specified in java.util.TimeZone.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-133.5.3The serialization output for a java.time.Instant instance MUST be in a ISO_INSTANT format, as specified in java.time.format.DateTimeFormatter.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-233.5.3Implementations MUST support the deserialization of an ISO_INSTANT formatted JSON string to a java.time.Instant instance.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-333.5.3Analogically, for other java.time.* classes, following mapping table matches Java types and corresponding formats: +java.time.Instant ISO_INSTANT +java.time.LocalDate ISO_LOCAL_DATE +java.time.LocalTime ISO_LOCAL_TIME +java.time.LocalDateTime ISO_LOCAL_DATE_TIME +java.time.ZonedDateTime ISO_ZONED_DATE_TIME +java.time.OffsetDateTime ISO_OFFSET_DATE_TIME +java.time.OffsetTime ISO_OFFSET_TIMEtrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-433.5.3Implementations MUST support the deserialization of any time zone ID format specified in java.time.ZoneId into a field or property of type java.time.ZoneId.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-533.5.3The serialization format of java.time.ZoneId is the normalized zone ID as specified in java.time.ZoneId.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-633.5.3Implementations MUST support the deserialization of any time zone ID format specified in java.time.ZoneOffset into a field or property of type java.time.ZoneOffset.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-733.5.3The serialization format of java.time.ZoneOffset is the normalized zone ID as specified in java.time.ZoneOffset.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-833.5.3Implementations MUST support the deserialization of any duration format specified in java.time.Duration into a field or property of type java.time.Duration.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-933.5.3This is super-set of ISO 8601 duration format. The serialization format of java.time.Duration is the ISO 8601 seconds based representation, such as PT8H6M12.345S.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-1033.5.3Implementations MUST support the deserialization of any period format specified in java.time.Period into a field or property of type java.time.Period.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-1133.5.3This is a super-set of ISO 8601 period format. The serialization format of java.time.Period is ISO 8601 period representation.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.5.3-1233.5.3A zero-length period is represented as zero days 'P0D'.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.6-133.6For an unspecified output type of a deserialization operation, as well as where output type is specified as Object.class, implementations MUST deserialize a JSON document using Java runtime types specified in table below: +object java.util.Map String,Object +array java.util.List Object +string java.lang.String +number java.math.BigDecimal +true, false java.lang.Boolean +null null +true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.6-233.6JSON object values are deserialized into an implementation of java.util.Map(String, Object) with a predictable iteration order.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7-133.7Any instance passed to a deserialization operation must have a public or protected no-argument constructor. Implementations SHOULD throw an error if this condition is not met.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7-233.7This limitation does not apply to serialization operations, as well as to classes which specify explicit instantiation methods as described in section 4.5.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.1-133.7.1For a deserialization operation of a Java property, if a matching public setter method exists, the method is called to set the value of the property. If a matching setter method with private, protected, or defaulted to package-only access exists, then this field is ignored. If no matching setter method exists and the field is public, then direct field assignment is used.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.1-233.7.1For a serialization operation, if a matching public getter method exists, the method is called to obtain the value of the property. If a matching getter method with private, protected, or defaulted to package-only access exists, then this field is ignored. If no matching getter method exists and the field is public, then the value is obtained directly from the field.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.1-333.7.1JSON Binding implementations MUST NOT deserialize into transient, final or static fields and MUST ignore name/value pairs corresponding to such fields.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.1-433.7.1Implementations MUST support serialization of final fields.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.1-533.7.1Transient and static fields MUST be ignored during serialization operation.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.1-633.7.1If a JSON document contains a name/value pair not corresponding to field or setter method, then this name/value pair MUST be ignored.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.1-733.7.1Public getter/setter methods without a corresponding field MUST be supported. When only public getter/setter method without corresponding field is present in the class, the getter method is called to obtain the value to serialize, and the setter method is called during deserialization operation.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.2-133.7.2Implementations MUST support the binding of public and protected nested classes.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.2-233.7.2For deserialization operations, both nested and encapsulating classes MUST fulfill the same instantiation requirements as specified in 3.7.1.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.3-133.7.3Implementations MUST support the binding of public and protected static nested classes.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.3-233.7.3For deserialization operations, the nested class MUST fulfill the same instantiation requirements as specified in 3.7.1.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.7.4-133.7.4Deserialization into anonymous classes is not supported. Serialization of anonymous classes is supported by default object mapping.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-133.8Polymorphic type handling is supported for deserialization and serialization. Polymorphic handling is ensured by annotation JsonbTypeInfo and @JsonbSubtype.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-233.8JsonbTypeInfo defines key name of the property to store type information in it and defines all the supported aliases using @JsonbSubtype annotations.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-333.8@JsonbSubtype ensures proper and safe mapping between class alias and type.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-433.8Implementation must validate mapped types if they are assignable from the annotated type. If not, an exception must be thrown.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-533.8Type information is obtained from @JsonbSubtype annotation as a type alias mapped to the type. If no matching class is found for obtained alias during deserialization, an exception must be thrown.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-633.8New property with type information is added to the serialized object.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-733.8The property key name is taken from the key property of the annotation JsonbTypeInfo.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-833.8This type information property key name has to be unique in the resulting JSON document. If any naming collision with class or any other JsonbTypeInfo properties occurs, an exception must be thrown.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-933.8It is required for all polymorphism fields to be serialized as the first properties in the JSON and any actual object properties are serialized after.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-1033.8If no JsonbTypeInfo is used on handled class or its predecessors, it is not possible to ensure proper polymorphic type handling and in such cases deserialization is not supported.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-1133.8If there are multiple different type polymorphic customizations that need to be merged, an exception must be thrown.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.8-1233.8The order of the type information properties must be the same in which they appear in the +polymorphic type chain.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.9-133.9Serialization of an Enum instance to a JSON String value MUST follow the conversion process defined in javadoc specification for their name().true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.9-233.9Deserialization of a JSON value into an enum instance MUST be done by calling the enum’s valueOf(String) method.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.10-133.10Implementations MUST support the deserialization of specific interfaces defined in 3.11 and 3.3.4.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.10-233.10Deserialization to other interfaces is not supported and implementations SHOULD report error in such case.false +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.10-333.10If a class property is defined with an interface and not concrete type, then the mapping for a serialized property is resolved based on its runtime type.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.11-133.11Implementations MUST support binding of the following collection interfaces, classes and their implementations. +java.util.Collection +java.util.Map +java.util.Set +java.util.HashSet +java.util.NavigableSet +java.util.SortedSet +java.util.TreeSet +java.util.LinkedHashSet +java.util.TreeHashSet +java.util.HashMap +java.util.NavigableMap +java.util.SortedMap +java.util.TreeMap +java.util.LinkedHashMap +java.util.TreeHashMap +java.util.List +java.util.ArrayList +java.util.LinkedList +java.util.Deque +java.util.ArrayDeque +java.util.Queue +java.util.PriorityQueue +java.util.EnumSet +java.util.EnumMap + +true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.11-233.11Implementations of interfaces below must provide accessible default constructor. JSON Binding implementations MUST report unmarshalling error if default constructor is not present or is not in accessible scope.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.12-133.12JSON Binding implementations MUST support binding of Java arrays of all supported Java types from this chapter into/from JSON array structures as defined in Section 5 of RFC 7159true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.12-233.12Arrays of primitive types and multi-dimensional arrays MUST be supported.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.13-133.13Declared fields MUST be serialized in lexicographical order into the resulting JSON document. In case of inheritance, declared fields of super class MUST be serialized before declared fields of child class.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.13-233.13When deserializing a JSON document, declared fields MUST be set in the order of attributes present in the JSON document.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.14.1-133.14.1The result of serializing a java field with a null value is the absence of the property in the resulting JSON document.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.14.1-233.14.1The deserialization operation of a property absent in JSON document MUST not set the value of the field, the setter (if available) MUST not be called, and thus original value of the field MUST be preserved.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.14.1-333.14.1The deserialization operation of a property with a null value in a JSON document MUST set the value of the field to null value (or call setter with null value if setter is present). The exception is java.util.Optional, OptionalInt, OptionalLong, OptionalDouble instances. In this case the value of the field is set to an empty optional value.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.14.2-133.14.2The result of deserialization n-ary array represented in JSON document is n-ary Java array.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.14.2-233.14.2Null value in JSON array is represented by null value in Java array.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.14.2-333.14.2Serialization operation on Java array with null value at index i MUST output null value at index i of the array in resulting JSON document.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.15-133.15According to RFC 7159 Section 7 , every Java identifier name can be transformed using identity function into a valid JSON String. Identity function MUST be used for transforming Java identifier names into name Strings in JSON document.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.15-233.15For deserialization operations defined in 3.6 section, identity function is used to transform JSON name strings into Java String instances in the resulting map Map(String, Object).true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.15-333.15Identity function is used also for other deseralization operations.true +
+
falsetechnologyremovedtrue
JSONB:SPEC:JSB-3.15-433.15If a Java identifier with corresponding name does not exist or is not accessible, the implementations MUST report error.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.16-133.16JSON Binding implementation MUST serialize numbers that express greater magnitude or precision than an IEEE 754 double precision number as strings.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17-133.17JSON Binding implementations MUST support binding of generic types.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17-233.17Due to type erasure, there are situations when it is not possible to obtain generic type information. There are two ways for JSON Binding implementations to obtain generic type information. If there is a class file available (in the following text referred as static type information), it is possible to obtain generic type information (effectively generic type declaration) from Signature attribute (if this information is present).true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17-333.17The second option is to provide generic type information at runtime. To provide generic type information at runtime, an argument of java.lang.reflect.Type MUST be passed to Jsonb::toJson or to Jsonb::fromJson method.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-133.17.1There are several levels of information JSON Binding implementations may obtain about the type of field/class/interface: + 1. runtime type provided via java.lang.reflect.Type parameter passed to Jsonb::toJson or Jsonb::fromJson method + 2. static type provided in class file (effectively stored in Signature attribute) + 3. raw type + 4. no information about the typetrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-233.17.1If there is no information about the type, JSON Binding implementation MUST treat this type as java.lang.Object.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-333.17.1If only raw type of given field/class/interface is known, then the type MUST be treated like raw type.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-433.17.1For example, if the only available information is that given field/class/interface is of type java.util.ArrayList, than the type MUST be treated as java.util.ArrayList Object. JSON Binding implementations MUST use the most specific type derived from the information available.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-533.17.1Let's consider situation where there is only static type information of a given field/class/interface known, +and there is no runtime type information available. Let GenericClass T1; : : : ; Tn be part of generic type +declaration, where GenericClass is name of the generic type and T1; : : : ; Tn are type parameters. For every +Ti, where i in 1; : : : ; n, there are 3 possible options:true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-633.17.11. Ti is concrete parameter type +2. Ti is bounded parameter type +3. Ti is wildcard parameter type without bounds +In case 1, the most specific parameter type MUST be given concrete parameter type Ti.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-733.17.1For bounded parameter type, using bounds B1; : : : ;Bm. If m = 1, then the most specific parameter type MUST be derived from the given bound B1.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-833.17.1If B1 is class or interface, the most specific parameter type MUST be the class or interface.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-933.17.1Otherwise, the most specific parameter type SHOULD be java.lang.Object.false +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-1033.17.1If multiple bounds are specified, the first step is to resolve every bound separately. Let’s define result of such resolution as S1; : : : ; Sm specific parameter types. If S1; : : : ; Sm are java.lang.Object, then the bounded parameter type Ti MUST be java.lang.Object.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-1133.17.1If there is exactly one Sk, where 1 <= k <= m is different than java.lang.Object, then the most specific parameter type for this bounded parameter type Ti MUST be Sk.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-1233.17.1If there exists Sk1; Sk2, where 1 <= k1 <= k2 <= m, then the most specific parameter type is Sk1.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-1333.17.1For wildcard parameter type without bounds, the most specific parameter type MUST be java.lang.Object.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-1433.17.1Any unresolved type parameter MUST be treated as java.lang.Object. true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.17.1-1533.17.1If runtime type is provided via java.lang.reflect.Type parameter passed to Jsonb::toJson or Jsonb::fromJson method, than that runtime type overrides static type declaration wherever applicabletrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.18-133.18When JSON Binding implementation encounters key in key/value pair that it does not recognize, it should treat the rest of the JSON document as if the element simply did not appear, and in particular, the implementation MUST NOT treat this as an error condition.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.19-133.19JSON Binding implementations MUST NOT produce JSON documents with members with duplicate names. In this context, "duplicate" means that the names, after processing any escaped characters, are identical sequences of Unicode characters.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.19-233.19When non-unique property (after override and rename) is found, implementation MUST throw an exception. This doesn't apply for customized user serialization behavior implemented with the usage of JsonbAdapter mechanism.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.20-133.20JSON Binding implementations MUST support binding of the following JSON Processing types. + +jakarta.json.JsonObject +jakarta.json.JsonArray +jakarta.json.JsonStructure +jakarta.json.JsonValue +jakarta.json.JsonPointer +jakarta.json.JsonString +jakarta.json.JsonNumber + true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.20-233.20Serialization of supported jakarta.json.* objects/interfaces/fields MUST have the same result as serialization these objects with jakarta.json.JsonWriter.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.20-333.20Deserialization into supported jakarta.json.* objects/interfaces/fields MUST have the same result as deserialization into such objects with jakarta.json.JsonReader.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-3.20-433.20If the null value is deserialized into the JsonValue, it is handled as JsonValue.NULL. JsonValue.NULL is not assigned as a default value if no value is set.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.1-144.1.1JSON Binding implementations MUST NOT serialize fields, JavaBean properties or types annotated with jakarta.json.bind.annotation.JsonbTransient.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.1-244.1.1JsonbTransient annotation is mutually exclusive with all other JSON Binding defined annotations. Implementations must throw JsonbException in the following cases: Class field is annotated with @JsonbTransient. Exception must be thrown when this field, getter or setter is annotated with other JSON Binding annotations.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.1-344.1.1Getter is annotated with @JsonbTransient. Exception is thrown if when the field or this getter are annotated with other JSON Binding annotations. Exception is not thrown if JSON Binding annotations are presented on the setter.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.1-444.1.1Setter is annotated with @JsonbTransient. Exception is thrown if when the field or this setter are annotated with other JSON Binding annotations. Exception is not thrown if JSON Binding annotations are presented on the getter.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.2-144.1.2To provide custom name for given field (or JavaBean property), +jakarta.json.bind.annotation.JsonbProperty may be used. JsonbProperty annotation may be specified on +field, getter or setter method. If specified on field, custom name is used both for serialization and +deserialization.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.2-244.1.2If jakarta.json.bind.annotation.JsonbProperty is specified on getter method, it is used +only for serialization.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.2-344.1.2If jakarta.json.bind.annotation.JsonbProperty is specified on setter method, it is used only for deserialization.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.2-444.1.2It is possible to specify different values for getter and setter method for jakarta.json.bind.annotation.JsonbProperty annotation. In such case the different custom name will be used for serialization and deserialization.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.3-144.1.3The way to set custom property naming strategy is to use jakarta.json.bin.JsonbConfig::withPropertyNamingStrategy method.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.1.4-144.1.4If duplicate name is found exception MUST be thrown. The definition of duplicate (non-unique) property +can be found in 3.19.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.244.2The way to set custom property order strategy is to use jakarta.json.bin.JsonbConfig::withPropertyOrderStrategy method.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.2-244.2To customize the order of serialized properties only for one specific type, JSON Binding provides jakarta.json.bind.annotation.JsonbPropertyOrder annotation. Order specified by JsonbPropertyOrder annotation overrides order specified by PropertyOrderStrategy.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.3-144.3If annotations (JsonbNillable or JsonbProperty) on different level apply to the same field (or JavaBean property) or if there is config wide configuration and some annotation (JsonbNillable or JsonbProperty) which apply to the same field (or JavaBean property), the annotation with the smallest scope applies.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.3-244.3/font> JsonbNillable and JsonbProperty are applied on the same level, JsonbNillable takes precedence.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.3.1-144.3.1When given object (type or package) is annotated with jakarta.json.bind.annotation.JsonbNillable annotation, the result of null value will be presence of associated property in JSON document with explicit null value.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.3.1-244.3.1The same behavior as JsonbNillable, but only at field, parameter and method (JavaBean property) level is provided by jakarta.json.bind.annotation.JsonbProperty annotation with its nillable parameter. This option is currently deprecated, and it is recommended to use +jakarta.json.bind.annotation.JsonbNillable instead.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.3.1-344.3.1JSON Binding implementations MUST implement override of annotations according to target of the annotation (FIELD, PARAMETER, METHOD, TYPE, PACKAGE). Type level annotation overrides behavior set at the package level. Method, parameter or field level annotation overrides behavior set at the type level.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.3.2-144.3.2The way to enforce serialization of null values, is to call method jakarta.json.bind.JsonbConfig::withNullValues with parameter true. The way to skip serialization of null values is to call method jakarta.json.bind.JsonbConfig::withNullValues with parameter false.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.4-144.4To enforce strict compliance of serialized JSON documents, JSON Binding implementations MUST implement configuration option jsonb.i-json.strict-ser-compliance.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.4.1-144.4.1Uppercase rather than lowercase letters MUST be used.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.4.1-244.4.1The timezone MUST always be included and optional trailing seconds MUST be included even when their value is 00.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.4.1-344.4.1JSON Binding implementations MUST serialize java.util.Date, java.util.Calendar, java.util.GregorianCalendar, java.time.LocalDate, java.time.LocalDateTime and java.time.Instant in the same format as java.time.ZonedDateTime.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.4.1-444.4.1The result of serialization of duration must conform to the duration production in Appendix A of RFC 3339, with the same additional restrictionstrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.5-144.5At most one JsonbCreator annotation can be used to annotate custom constructor or static void factory method in a class, otherwise JsonbException MUST be thrown.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.5-244.5Factory method annotated with JsonbCreator annotation should return instance of particular class this annotation is used for, otherwise JsonbException MUST be thrown.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.5-344.5Mapping between parameters of constructor/factory method annotated with JsonbCreator and JSON fields is defined using JsonbProperty annotation on all parameters. +If the JsonbProperty annotation on parameters is not used, then parameters should be mapped from JSON fields with the same name. In this case the proper mapping is NOT guaranteed. +All the JsonbCreator parameters are treated as optional by default. See Optional parameter values chapter for default optional parameter values. +All the JsonbCreator parameters can be turned to required by using configuration method Config::withCreatorParametersRequired. +If a required field for a parameter mapping does not exist in the JSON document, then JsonbException MUST be thrown.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.5.1-144.5When a property is marked as optional, the proper default should be used. If the parameter is any type other than Optional or its variations, then the null value is used. If the parameter is java.util.Optional, OptionalInt, OptionalLong, OptionalDouble, then the corresponding empty object must be used. +Primitive types cannot accept null values, so a corresponding value is required as listed in the following table:.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.6-144.5To customize scope and field access strategy as specified in section 3.7.1, it is possible to specify jakarta.json.bind.annotation.JsonbVisibility annotation or to override default behavior globally calling JsonbConfig::withPropertyVisibilityStrategy method with given custom property visibility strategy.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.1-144.7.1On serialization of Original type JSONB calls JsonbAdapter::adaptToJson method of the adapter to convert Original to Adapted and serializes Adapted the standard way. On deserialization JSONB deserializes Adapted from JSON and converts it to Original using JsonbAdapter::adaptFromJson method.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.1-244.7.1There are two ways how to register JsonbAdapter: Using JsonbConfig::withAdapters method & Annotating a class field with JsonbTypeAdapter annotation.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.1-344.7.1Implementations must provide a CDI support in adapters to allow injection of CDI managed beans into it.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.1-444.7.1JsonbAdapter registered via JsonbConfig::withAdapters is visible to all serialize/deserialize operations +performed with given JsonbConfig. JsonbAdapter registered with annotation is visible to serialize/deserialize operation used only for annotated field.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.1-544.7.1It is possible to annotate JsonbCreator parameter with JsonbTypeAdapter and provide adapter for a parameter this way. However, if JsonbTypeAdapter annotation is provided to any other parameter (such as setter method parameter) it will be ignored.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.2-144.7.2Serializer is a class implementing jakarta.json.bind.serializers.JsonbSerializer interface. It is used to serialize the type it's registered on (Original). On marshalling of Original type JSONB calls JsonbSerializer::serialize method. This method has to contain a custom code to serialize Original type using provided JsonpGenerator.Deserializer is a class implementing jakarta.json.bind.serializers.JsonbDeserializer interface. It is used to deserialize the type it’s registered on (Original). On deserialization of Original type JSONB calls JsonbDeserializer::deserialize method. This method has to contain a custom code to deserialize Original type using provided JsonpParser. There are two ways how to register JsonbSerializer/JsonbDeserializer:Using JsonbConfig::withSerializers/ JsonbConfig::withDeserializers method;true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.2-244.7.2Annotating a type with JsonbSerializer/JsonbDeserializer annotation.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.2-344.7.2Implementations must provide a CDI support in serializers/deserializers to allow injection of CDI managed beans into it.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.7.2-444.7.2It is possible to annotate JsonbCreator parameter with JsonbTypeDeserializer and provide deserializer for a parameter this way. However, if JsonbTypeDeserializer annotation is provided to any other parameter (such as setter method parameter) it will be ignored.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.8-144.8JsonbDateFormat annotation can be applied to the following targets: field, method, type, parameter, packagetrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.8-244.8Annotation applied to more specific target overrides the same annotation applied to target with wider scope and global configuration. For example, annotation applied to type target will override the same annotation applied to package target.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.8-344.8Default date format and default locale can be customized globally using jakarta.json.bind.JsonbConfig::withDateFormat and jakarta.json.bind.JsonbConfig::withLocale methods.true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.9-144.9JsonbNumberFormat annotation can be applied to the following targets: field, getter/setter, method, type, parameter, packagetrue +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.9-244.9Annotation applied to more specific target overrides the same annotation applied to target with wider scope. For example, annotation applied to type target will override the same annotation applied to package target. true +
+
falsetechnologyactivetrue
JSONB:SPEC:JSB-4.10-144.10The way to set custom binary data handling strategy is to use jakarta.json.bin.JsonbConfig::withBinaryDataStrategy method.true +
+
falsetechnologyactivetrue
+ +