io.micronaut.serde

Interface ObjectMapper

All Superinterfaces:

io.micronaut.json.JsonMapper

All Known Subinterfaces:

ObjectMapper.CloseableObjectMapper

All Known Implementing Classes:

AbstractBsonMapper, BsonBinaryMapper, BsonJsonMapper, JacksonJsonMapper, JsonStreamMapper, OracleJdbcJsonBinaryObjectMapper, OracleJdbcJsonTextObjectMapper

public interface ObjectMapper
extends io.micronaut.json.JsonMapper

Sub-interface of JsonMapper with customizations.

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ObjectMapper.CloseableObjectMapper A closeable object mapper.

Method Summary

Modifier and Type	Method and Description
default io.micronaut.json.JsonMapper	cloneWithFeatures(io.micronaut.json.JsonFeatures features)
static ObjectMapper.CloseableObjectMapper	create(java.util.Map<java.lang.String,java.lang.Object> configuration, java.lang.String... packageNames) Creates a new custom ObjectMapper with additional beans (serializers, deserializers etc.) loaded from the given package locations.
static ObjectMapper	getDefault() Get the default ObjectMapper instance.
default <T> T	readValue(byte[] byteArray, java.lang.Class<T> type) Read a value from the byte array for the given type.
default <T> T	readValue(java.io.InputStream inputStream, java.lang.Class<T> type) Read a value from the given input stream for the given type.
default <T> T	readValue(java.lang.String string, java.lang.Class<T> type) Read a value from the given string for the given type.
default <T> java.lang.String	writeValueAsString(io.micronaut.core.type.Argument<T> type, T object) Write the given value as a string.
default <T> java.lang.String	writeValueAsString(io.micronaut.core.type.Argument<T> type, T object, java.nio.charset.Charset charset) Write the given value as a string.
default <T> java.lang.String	writeValueAsString(T object) Write the given value as a string.

Methods inherited from interface io.micronaut.json.JsonMapper

cloneWithViewClass, createReactiveParser, detectFeatures, getStreamConfig, readValue, readValue, readValue, readValueFromTree, readValueFromTree, updateValueFromTree, writeValue, writeValue, writeValueAsBytes, writeValueAsBytes, writeValueToTree, writeValueToTree

Method Detail

readValue

@Nullable
default <T> T readValue(@NonNull
                                  java.io.InputStream inputStream,
                                  @NonNull
                                  java.lang.Class<T> type)
                           throws java.io.IOException

Read a value from the given input stream for the given type.

Type Parameters:

T - The generic type

Parameters:

inputStream - The input stream

type - The type

Returns:

The value or null if it decodes to null

Throws:

java.io.IOException - If an unrecoverable error occurs

readValue

@Nullable
default <T> T readValue(@NonNull
                                  byte[] byteArray,
                                  @NonNull
                                  java.lang.Class<T> type)
                           throws java.io.IOException

Read a value from the byte array for the given type.

Type Parameters:

T - The generic type

Parameters:

byteArray - The byte array

type - The type

Returns:

The value or null if it decodes to null

Throws:

java.io.IOException - If an unrecoverable error occurs

readValue

@Nullable
default <T> T readValue(@NonNull
                                  java.lang.String string,
                                  @NonNull
                                  java.lang.Class<T> type)
                           throws java.io.IOException

Read a value from the given string for the given type.

Type Parameters:

T - The generic type

Parameters:

string - The string

type - The type

Returns:

The value or null if it decodes to null

Throws:

java.io.IOException - If an unrecoverable error occurs

writeValueAsString

@NonNull
default <T> java.lang.String writeValueAsString(@NonNull
                                                         T object)
                                                  throws java.io.IOException

Write the given value as a string.

Type Parameters:

T - The generic type

Parameters:

object - The object

Returns:

The string

Throws:

java.io.IOException - If an unrecoverable error occurs

cloneWithFeatures

default io.micronaut.json.JsonMapper cloneWithFeatures(io.micronaut.json.JsonFeatures features)

Specified by:

cloneWithFeatures in interface io.micronaut.json.JsonMapper

writeValueAsString

@NonNull
default <T> java.lang.String writeValueAsString(@NonNull
                                                         io.micronaut.core.type.Argument<T> type,
                                                         @Nullable
                                                         T object)
                                                  throws java.io.IOException

Write the given value as a string.

Type Parameters:

T - The generic type

Parameters:

type - The type, never null

object - The object

Returns:

The string

Throws:

java.io.IOException - If an unrecoverable error occurs

writeValueAsString

@NonNull
default <T> java.lang.String writeValueAsString(@NonNull
                                                         io.micronaut.core.type.Argument<T> type,
                                                         @Nullable
                                                         T object,
                                                         java.nio.charset.Charset charset)
                                                  throws java.io.IOException

Write the given value as a string.

Type Parameters:

T - The generic type

Parameters:

type - The type, never null

object - The object

charset - The charset, never null

Returns:

The string

Throws:

java.io.IOException - If an unrecoverable error occurs

getDefault

@NonNull
static ObjectMapper getDefault()

Get the default ObjectMapper instance.

Note that this method returns an ObjectMapper that does not include any custom defined serializers or deserializers and in general should be avoided outside a few niche cases that require static access.

Where possible you should use dependency injection to instead retrieve the ObjectMapper from the application context.

Returns:

The default object mapper

Since:

1.3.0

create

@NonNull
static ObjectMapper.CloseableObjectMapper create(java.util.Map<java.lang.String,java.lang.Object> configuration,
                                                          java.lang.String... packageNames)

Creates a new custom ObjectMapper with additional beans (serializers, deserializers etc.) loaded from the given package locations.

Parameters:

configuration - The configuration

packageNames - The package names

Returns:

The new object mapper

Since:

1.5.1