Class CborObjectMapper

java.lang.Object

io.micronaut.serde.cbor.CborObjectMapper

All Implemented Interfaces:

io.micronaut.json.JsonMapper, ObjectMapper

@Singleton
@Order(150)
public final class CborObjectMapper
extends Object
implements ObjectMapper

ObjectMapper implementation that encodes and decodes CBOR using Jackson's streaming CBOR factory together with Micronaut Serialization serializers and deserializers.

This mapper does not use Jackson Databind. CBORFactory is used only as a token parser/generator; object graphs are handled by SerdeRegistry.

Since:

3.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface ObjectMapper

ObjectMapper.CloseableObjectMapper

Constructor Summary

Constructors

Constructor	Description
CborObjectMapper(SerdeRegistry registry, SerdeConfiguration serdeConfiguration, SerdeCborConfiguration cborConfiguration)	Creates a CBOR mapper backed by the given registry and configuration.

Method Summary

Modifier and Type	Method	Description
CborObjectMapper	cloneWithConfiguration(SerdeCborConfiguration cborConfiguration)	Create a new mapper with the given CBOR configuration.
ObjectMapper	cloneWithConfiguration(@Nullable SerdeConfiguration configuration, @Nullable SerializationConfiguration serializationConfiguration, @Nullable DeserializationConfiguration deserializationConfiguration)	Optional feature.
ObjectMapper	cloneWithConfiguration(@Nullable SerdeConfiguration configuration, @Nullable SerializationConfiguration serializationConfiguration, @Nullable DeserializationConfiguration deserializationConfiguration, @Nullable SerdeIntrospections introspections)	Optional feature.
io.micronaut.json.JsonMapper	cloneWithViewClass(Class<?> viewClass)
org.reactivestreams.Processor<byte[], io.micronaut.json.tree.JsonNode>	createReactiveParser(Consumer<org.reactivestreams.Processor<byte[], io.micronaut.json.tree.JsonNode>> onSubscribe, boolean streamArray)
io.micronaut.json.JsonMapper	createSpecific(io.micronaut.core.type.Argument<?> type)
SerdeRegistry	getSerdeRegistry()	Returns the SerdeRegistry used by this object mapper, if possible.
io.micronaut.json.JsonStreamConfig	getStreamConfig()
<T> @Nullable T	readValue(byte[] byteArray, io.micronaut.core.type.Argument<T> type)
<T> @Nullable T	readValue(io.micronaut.core.io.buffer.ByteBuffer<?> byteBuffer, io.micronaut.core.type.Argument<T> type)
<T> @Nullable T	readValue(InputStream inputStream, io.micronaut.core.type.Argument<T> type)
<T> @Nullable T	readValueFromTree(io.micronaut.json.tree.JsonNode tree, io.micronaut.core.type.Argument<T> type)
<T> T	updateValue(T valueToUpdate, io.micronaut.core.type.Argument<T> type, byte[] byteArray)	Update an existing mutable value from JSON read from the supplied byte array.
<T> T	updateValue(T valueToUpdate, io.micronaut.core.type.Argument<T> type, io.micronaut.core.io.buffer.ByteBuffer<?> byteBuffer)	Update an existing mutable value from JSON read from the supplied byte buffer.
<T> T	updateValue(T valueToUpdate, io.micronaut.core.type.Argument<T> type, InputStream inputStream)	Update an existing mutable value from JSON read from the supplied input stream.
<T> T	updateValue(T valueToUpdate, io.micronaut.core.type.Argument<T> type, @Nullable Object overrides)	Update an existing mutable value from the supplied override value.
void	updateValueFromTree(Object value, io.micronaut.json.tree.JsonNode tree)
<T> void	writeValue(OutputStream outputStream, io.micronaut.core.type.Argument<T> type, @Nullable T object)
void	writeValue(OutputStream outputStream, @Nullable Object object)
<T> byte[]	writeValueAsBytes(io.micronaut.core.type.Argument<T> type, @Nullable T object)
byte[]	writeValueAsBytes(@Nullable Object object)
<T> io.micronaut.json.tree.JsonNode	writeValueToTree(io.micronaut.core.type.Argument<T> type, @Nullable T value)
io.micronaut.json.tree.JsonNode	writeValueToTree(@Nullable Object value)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.json.JsonMapper

detectFeatures, readValue, readValue, readValue, readValue, readValue, readValueFromTree, writeValueAsString, writeValueAsString, writeValueAsString

Methods inherited from interface ObjectMapper

cloneWithFeatures, updateValue

Constructor Details

CborObjectMapper

@Inject
public CborObjectMapper(SerdeRegistry registry,
 SerdeConfiguration serdeConfiguration,
 SerdeCborConfiguration cborConfiguration)

Creates a CBOR mapper backed by the given registry and configuration.

Parameters:

registry - The serde registry

serdeConfiguration - The serde configuration

cborConfiguration - The CBOR configuration

Method Details

getSerdeRegistry

public SerdeRegistry getSerdeRegistry()

Description copied from interface: ObjectMapper

Returns the SerdeRegistry used by this object mapper, if possible.

Specified by:

getSerdeRegistry in interface ObjectMapper

Returns:

The serde registry

createSpecific

public io.micronaut.json.JsonMapper createSpecific(io.micronaut.core.type.Argument<?> type)

Specified by:

createSpecific in interface io.micronaut.json.JsonMapper

cloneWithConfiguration

public ObjectMapper cloneWithConfiguration(@Nullable SerdeConfiguration configuration,
 @Nullable SerializationConfiguration serializationConfiguration,
 @Nullable DeserializationConfiguration deserializationConfiguration)

Description copied from interface: ObjectMapper

Optional feature. Create a new ObjectMapper with the given configuration values. A null parameter indicates the old configuration should be used.

Specified by:

cloneWithConfiguration in interface ObjectMapper

Parameters:

configuration - The SerdeConfiguration

serializationConfiguration - The SerializationConfiguration

deserializationConfiguration - The DeserializationConfiguration

Returns:

A new JsonMapper with the updated config

cloneWithConfiguration

public ObjectMapper cloneWithConfiguration(@Nullable SerdeConfiguration configuration,
 @Nullable SerializationConfiguration serializationConfiguration,
 @Nullable DeserializationConfiguration deserializationConfiguration,
 @Nullable SerdeIntrospections introspections)

Description copied from interface: ObjectMapper

Optional feature. Create a new ObjectMapper with the given configuration values and introspections. A null configuration parameter indicates the old configuration should be used.

Specified by:

cloneWithConfiguration in interface ObjectMapper

Parameters:

configuration - The SerdeConfiguration

serializationConfiguration - The SerializationConfiguration

deserializationConfiguration - The DeserializationConfiguration

introspections - The SerdeIntrospections

Returns:

A new JsonMapper with the updated config and introspections

cloneWithConfiguration

public CborObjectMapper cloneWithConfiguration(SerdeCborConfiguration cborConfiguration)

Create a new mapper with the given CBOR configuration.

Parameters:

cborConfiguration - The CBOR configuration

Returns:

A new mapper

cloneWithViewClass

public io.micronaut.json.JsonMapper cloneWithViewClass(Class<?> viewClass)

Specified by:

cloneWithViewClass in interface io.micronaut.json.JsonMapper

getStreamConfig

public io.micronaut.json.JsonStreamConfig getStreamConfig()

Specified by:

getStreamConfig in interface io.micronaut.json.JsonMapper

readValueFromTree

public <T> @Nullable T readValueFromTree(io.micronaut.json.tree.JsonNode tree,
 io.micronaut.core.type.Argument<T> type)
                                  throws IOException

Specified by:

readValueFromTree in interface io.micronaut.json.JsonMapper

Throws:

IOException

writeValueToTree

public io.micronaut.json.tree.JsonNode writeValueToTree(@Nullable Object value)
                                                 throws IOException

Specified by:

writeValueToTree in interface io.micronaut.json.JsonMapper

Throws:

IOException

writeValueToTree

public <T> io.micronaut.json.tree.JsonNode writeValueToTree(io.micronaut.core.type.Argument<T> type,
 @Nullable T value)
                                                     throws IOException

Specified by:

writeValueToTree in interface io.micronaut.json.JsonMapper

Throws:

IOException

readValue

public <T> @Nullable T readValue(InputStream inputStream,
 io.micronaut.core.type.Argument<T> type)
                          throws IOException

Specified by:

readValue in interface io.micronaut.json.JsonMapper

Throws:

IOException

readValue

public <T> @Nullable T readValue(byte[] byteArray,
 io.micronaut.core.type.Argument<T> type)
                          throws IOException

Specified by:

readValue in interface io.micronaut.json.JsonMapper

Throws:

IOException

readValue

public <T> @Nullable T readValue(io.micronaut.core.io.buffer.ByteBuffer<?> byteBuffer,
 io.micronaut.core.type.Argument<T> type)
                          throws IOException

Specified by:

readValue in interface io.micronaut.json.JsonMapper

Throws:

IOException

writeValue

public void writeValue(OutputStream outputStream,
 @Nullable Object object)
                throws IOException

Specified by:

writeValue in interface io.micronaut.json.JsonMapper

Throws:

IOException

writeValue

public <T> void writeValue(OutputStream outputStream,
 io.micronaut.core.type.Argument<T> type,
 @Nullable T object)
                    throws IOException

Specified by:

writeValue in interface io.micronaut.json.JsonMapper

Throws:

IOException

writeValueAsBytes

public byte[] writeValueAsBytes(@Nullable Object object)
                         throws IOException

Specified by:

writeValueAsBytes in interface io.micronaut.json.JsonMapper

Throws:

IOException

writeValueAsBytes

public <T> byte[] writeValueAsBytes(io.micronaut.core.type.Argument<T> type,
 @Nullable T object)
                             throws IOException

Specified by:

writeValueAsBytes in interface io.micronaut.json.JsonMapper

Throws:

IOException

createReactiveParser

public org.reactivestreams.Processor<byte[], io.micronaut.json.tree.JsonNode> createReactiveParser(Consumer<org.reactivestreams.Processor<byte[], io.micronaut.json.tree.JsonNode>> onSubscribe,
 boolean streamArray)

Specified by:

createReactiveParser in interface io.micronaut.json.JsonMapper

updateValueFromTree

public void updateValueFromTree(Object value,
 io.micronaut.json.tree.JsonNode tree)
                         throws IOException

Specified by:

updateValueFromTree in interface io.micronaut.json.JsonMapper

Throws:

IOException

updateValue

public <T> T updateValue(T valueToUpdate,
 io.micronaut.core.type.Argument<T> type,
 @Nullable Object overrides)
                  throws IOException

Description copied from interface: ObjectMapper

Update an existing mutable value from the supplied override value.

The override value is converted to a JSON tree and applied through JsonMapper.updateValueFromTree(Object, JsonNode). Supported update semantics are implementation-specific; immutable, creator-only, and builder-only values may be rejected.

Specified by:

updateValue in interface ObjectMapper

Type Parameters:

T - The value type

Parameters:

valueToUpdate - The existing value to update

type - The type of the value to update

overrides - The override value containing fields to apply

Returns:

The updated valueToUpdate

Throws:

IOException - If an I/O or decoding error occurs

updateValue

public <T> T updateValue(T valueToUpdate,
 io.micronaut.core.type.Argument<T> type,
 InputStream inputStream)
                  throws IOException

Description copied from interface: ObjectMapper

Update an existing mutable value from JSON read from the supplied input stream.

Specified by:

updateValue in interface ObjectMapper

Type Parameters:

T - The value type

Parameters:

valueToUpdate - The existing value to update

type - The type of the value to update

inputStream - The input stream containing JSON fields to apply

Returns:

The updated valueToUpdate

Throws:

IOException - If an I/O or decoding error occurs

updateValue

public <T> T updateValue(T valueToUpdate,
 io.micronaut.core.type.Argument<T> type,
 byte[] byteArray)
                  throws IOException

Description copied from interface: ObjectMapper

Update an existing mutable value from JSON read from the supplied byte array.

Specified by:

updateValue in interface ObjectMapper

Type Parameters:

T - The value type

Parameters:

valueToUpdate - The existing value to update

type - The type of the value to update

byteArray - The byte array containing JSON fields to apply

Returns:

The updated valueToUpdate

Throws:

IOException - If an I/O or decoding error occurs

updateValue

public <T> T updateValue(T valueToUpdate,
 io.micronaut.core.type.Argument<T> type,
 io.micronaut.core.io.buffer.ByteBuffer<?> byteBuffer)
                  throws IOException

Description copied from interface: ObjectMapper

Update an existing mutable value from JSON read from the supplied byte buffer.

Specified by:

updateValue in interface ObjectMapper

Type Parameters:

T - The value type

Parameters:

valueToUpdate - The existing value to update

type - The type of the value to update

byteBuffer - The byte buffer containing JSON fields to apply

Returns:

The updated valueToUpdate

Throws:

IOException - If an I/O or decoding error occurs