JSONB 1.0
JSONB 1.0 - 1.0
JavaDoc Assertion Detail

TotalsTotalActiveDeprecatedRemoved
# of Assertions 808000
# of Required Assertions 808000
# of Optional Assertions 0000

IDReturnMethod/FieldDescriptionRequiredDeprecatedTestable
JSONB:JAVADOC:1Objectjavax.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:2Objectjavax.json.bind.Jsonb.fromJson
( String ,
Class )
throws JsonbException
If any unexpected error(s) occur(s) during deserialization.true
false
JSONB:JAVADOC:3Objectjavax.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:4Objectjavax.json.bind.Jsonb.fromJson
( String ,
Type )
throws JsonbException
If any unexpected error(s) occur(s) during deserialization.true
false
JSONB:JAVADOC:5Objectjavax.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:6Objectjavax.json.bind.Jsonb.fromJson
( Reader ,
Class )
throws JsonbException
If any unexpected error(s) occur(s) during deserialization.true
false
JSONB:JAVADOC:7Objectjavax.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:8Objectjavax.json.bind.Jsonb.fromJson
( Reader ,
Type )
throws JsonbException
If any unexpected error(s) occur(s) during deserialization.true
false
JSONB:JAVADOC:9Objectjavax.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:10Objectjavax.json.bind.Jsonb.fromJson
( InputStream ,
Class )
throws JsonbException
If any unexpected error(s) occur(s) during deserialization.true
false
JSONB:JAVADOC:11Objectjavax.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:12Objectjavax.json.bind.Jsonb.fromJson
( InputStream ,
Type )
throws JsonbException
If any unexpected error(s) occur(s) during deserialization.true
false
JSONB:JAVADOC:13Stringjavax.json.bind.Jsonb.toJson
( Object )
Writes the Java object tree with root object object to a String instance as JSON.true
true
JSONB:JAVADOC:14Stringjavax.json.bind.Jsonb.toJson
( Object )
throws JsonbException
If any unexpected problem occurs during the serialization, such as I/O error.true
false
JSONB:JAVADOC:15Stringjavax.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:16Stringjavax.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:17voidjavax.json.bind.Jsonb.toJson
( Object ,
Writer )
Writes the object content tree into a Writer character stream.true
true
JSONB:JAVADOC:18voidjavax.json.bind.Jsonb.toJson
( Object ,
Writer )
throws JsonbException
If any unexpected problem occurs during the serialization.true
false
JSONB:JAVADOC:19voidjavax.json.bind.Jsonb.toJson
( Object ,
Type ,
Writer )
Writes the object content tree into a Writer character stream.true
true
JSONB:JAVADOC:20voidjavax.json.bind.Jsonb.toJson
( Object ,
Type ,
Writer )
throws JsonbException
If any unexpected problem occurs during the serialization.true
false
JSONB:JAVADOC:21voidjavax.json.bind.Jsonb.toJson
( Object ,
OutputStream )
Writes the object content tree into output stream.true
true
JSONB:JAVADOC:22voidjavax.json.bind.Jsonb.toJson
( Object ,
OutputStream )
throws JsonbException
If any unexpected problem occurs during the serialization.true
false
JSONB:JAVADOC:23voidjavax.json.bind.Jsonb.toJson
( Object ,
Type ,
OutputStream )
Writes the object content tree into output stream.true
true
JSONB:JAVADOC:24voidjavax.json.bind.Jsonb.toJson
( Object ,
Type ,
OutputStream )
throws JsonbException
If any unexpected problem occurs during the serialization.true
false
JSONB:JAVADOC:25Jsonbjavax.json.bind.JsonbBuilder.build
Returns a new instance of javax.json.bind.Jsonb Jsonb based on the parameters and configuration specified previously in this builder.true
true
JSONB:JAVADOC:26Jsonbjavax.json.bind.JsonbBuilder.create
Create a new javax.json.bind.Jsonb instance using the default JsonbBuilder implementation provided as returned from javax.json.bind.spi.JsonbProvider#provider() method.true
true
JSONB:JAVADOC:27Jsonbjavax.json.bind.JsonbBuilder.create
( JsonbConfig )
Create a new javax.json.bind.Jsonb instance using the default JsonbBuilder implementation provided as returned from javax.json.bind.spi.JsonbProvider#provider() method, configured with provided configuration.true
true
JSONB:JAVADOC:28JsonbBuilderjavax.json.bind.JsonbBuilder.newBuilder
Create a new JsonbBuilder instance as returned by the default javax.json.bind.spi.JsonbProvider#provider() method.true
true
JSONB:JAVADOC:29JsonbBuilderjavax.json.bind.JsonbBuilder.newBuilder
( String )
Create a new JsonbBuilder instance as returned by javax.json.bind.spi.JsonbProvider#provider(String) method.true
true
JSONB:JAVADOC:30JsonbBuilderjavax.json.bind.JsonbBuilder.newBuilder
( JsonbProvider )
Create a new JsonbBuilder instance as returned by provider#create call.true
true
JSONB:JAVADOC:31JsonbBuilderjavax.json.bind.JsonbBuilder.withConfig
( JsonbConfig )
Set configuration which will be set to the newly created javax.json.bind.Jsonb Jsonb instance.true
true
JSONB:JAVADOC:32JsonbBuilderjavax.json.bind.JsonbBuilder.withProvider
( JsonProvider )
Provides a JSON-P provider to be used for all JSON-P related operations.true
true
JSONB:JAVADOC:33Mapjavax.json.bind.JsonbConfig.getAsMap
Return all configuration properties as an unmodifiable map.true
true
JSONB:JAVADOC:34Optionaljavax.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:35JsonbConfigjavax.json.bind.JsonbConfig.JsonbConfig

true
true
JSONB:JAVADOC:36JsonbConfigjavax.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:37JsonbConfigjavax.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:38JsonbConfigjavax.json.bind.JsonbConfig.withBinaryDataStrategy
( String )
Property used to specify custom binary data strategy. Configures value of BINARY_DATA_STRATEGY property.true
true
JSONB:JAVADOC:39JsonbConfigjavax.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:40JsonbConfigjavax.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:41JsonbConfigjavax.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:42JsonbConfigjavax.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:43JsonbConfigjavax.json.bind.JsonbConfig.withLocale
( Locale )
Property used to specify custom locale.true
true
JSONB:JAVADOC:44JsonbConfigjavax.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:45JsonbConfigjavax.json.bind.JsonbConfig.withPropertyNamingStrategy
( PropertyNamingStrategy )
Property used to specify custom naming strategy. Configures value of JSONB_PROPERTY_NAMING_STRATEGY property.true
true
JSONB:JAVADOC:46JsonbConfigjavax.json.bind.JsonbConfig.withPropertyNamingStrategy
( String )
Property used to specify custom naming strategy. Configures value of JSONB_PROPERTY_NAMING_STRATEGY property.true
true
JSONB:JAVADOC:47JsonbConfigjavax.json.bind.JsonbConfig.withPropertyOrderStrategy
( String )
Property used to specify property order strategy. Configures values of JSONB_PROPERTY_ORDER_STRATEGY property.true
true
JSONB:JAVADOC:48JsonbConfigjavax.json.bind.JsonbConfig.withPropertyVisibilityStrategy
( PropertyVisibilityStrategy )
Property used to specify custom property visibility strategy. Configures value of PROPERTY_VISIBILITY_STRATEGY property.true
true
JSONB:JAVADOC:49JsonbConfigjavax.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:50JsonbConfigjavax.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:51JsonbExceptionjavax.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:52JsonbExceptionjavax.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:53Objectjavax.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:54Objectjavax.json.bind.adapter.JsonbAdapter.adaptFromJson
( Object )
throws Exception
if there is an error during the conversion.true
false
JSONB:JAVADOC:55Objectjavax.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:56Objectjavax.json.bind.adapter.JsonbAdapter.adaptToJson
( Object )
throws Exception
if there is an error during the conversion.true
false
JSONB:JAVADOC:57Stringjavax.json.bind.annotation.JsonbDateFormat.locale
Custom java.util.Locale to use.true
true
JSONB:JAVADOC:58Stringjavax.json.bind.annotation.JsonbDateFormat.value
Specifies the date pattern to use.true
true
JSONB:JAVADOC:59booleanjavax.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:60Stringjavax.json.bind.annotation.JsonbNumberFormat.locale
Custom java.util.Locale to use.true
true
JSONB:JAVADOC:61Stringjavax.json.bind.annotation.JsonbNumberFormat.value
Specifies the number pattern to use.true
true
JSONB:JAVADOC:62booleanjavax.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:63Stringjavax.json.bind.annotation.JsonbProperty.value
Customized name of the field (or JavaBean property).true
true
JSONB:JAVADOC:64String[]javax.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:65Classjavax.json.bind.annotation.JsonbTypeAdapter.value
Custom JsonbAdapter which provides custom mapping for given field or JavaBean property.true
true
JSONB:JAVADOC:66Classjavax.json.bind.annotation.JsonbTypeDeserializer.value
Custom JsonbDeserializer which provides custom mapping for given field or JavaBean property.true
true
JSONB:JAVADOC:67Classjavax.json.bind.annotation.JsonbTypeSerializer.value
Custom JsonbSerializer which provides custom mapping for given field or JavaBean property.true
true
JSONB:JAVADOC:68Classjavax.json.bind.annotation.JsonbVisibility.value
Custom property visibility strategy used to resolve visibility of the members.true
true
JSONB:JAVADOC:69Stringjavax.json.bind.config.PropertyNamingStrategy.translateName
( String )
Translates the property name into its JSON field name representation.true
true
JSONB:JAVADOC:70booleanjavax.json.bind.config.PropertyVisibilityStrategy.isVisible
( Field )
Responds whether the given field should be considered as the JsonbProperty.true
true
JSONB:JAVADOC:71booleanjavax.json.bind.config.PropertyVisibilityStrategy.isVisible
( Method )
Responds whether the given method should be considered as the JsonbProperty.true
true
JSONB:JAVADOC:72Objectjavax.json.bind.serializer.DeserializationContext.deserialize
( Class ,
JsonParser )
Deserialize JSON stream into instance of provided class using javax.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:73Objectjavax.json.bind.serializer.DeserializationContext.deserialize
( Type ,
JsonParser )
Deserialize JSON stream into instance of provided class using javax.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:74Objectjavax.json.bind.serializer.JsonbDeserializer.deserialize
( JsonParser ,
DeserializationContext ,
Type )
Deserialize JSON stream into object.true
true
JSONB:JAVADOC:75voidjavax.json.bind.serializer.JsonbSerializer.serialize
( Object ,
JsonGenerator ,
SerializationContext )
Serializes object into JSON stream.true
true
JSONB:JAVADOC:76voidjavax.json.bind.serializer.SerializationContext.serialize
( String ,
Object ,
JsonGenerator )
Serializes arbitrary object to JSON, using current javax.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:77voidjavax.json.bind.serializer.SerializationContext.serialize
( Object ,
JsonGenerator )
Serializes arbitrary object to JSON, using current javax.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
JSONB:JAVADOC:78JsonbBuilderjavax.json.bind.spi.JsonbProvider.create
Returns a new instance of javax.json.bind.JsonbBuilder JsonbBuilder class. javax.json.bind.JsonbBuilder JsonbBuilder provides necessary getter methods to access required parameters.true
true
JSONB:JAVADOC:80JsonbProviderjavax.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:81JsonbProviderjavax.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