io.micronaut.json

Interface JsonMapper

All Known Implementing Classes:

JacksonDatabindMapper

public interface JsonMapper

Common abstraction for mapping json to data structures.

Since:

3.1

Author:

Jonas Konrad

Method Summary

Modifier and Type	Method and Description
default JsonMapper	cloneWithFeatures(JsonFeatures features) Create a copy of this mapper with the given json features as returned by detectFeatures(io.micronaut.core.annotation.AnnotationMetadata).
default JsonMapper	cloneWithViewClass(Class<?> viewClass) Create a copy of this mapper with the given view class.
Processor<byte[],JsonNode>	createReactiveParser(Consumer<Processor<byte[],JsonNode>> onSubscribe, boolean streamArray) Create a reactive Processor that accepts json bytes and parses them as JsonNodes.
default Optional<JsonFeatures>	detectFeatures(AnnotationMetadata annotations) Detect JsonFeatures from the given annotation data.
JsonStreamConfig	getStreamConfig()
<T> T	readValue(byte[] byteArray, Argument<T> type) Parse and map json from the given byte array.
<T> T	readValue(InputStream inputStream, Argument<T> type) Parse and map json from the given stream.
default <T> T	readValue(String string, Argument<T> type) Parse and map json from the given string.
<T> T	readValueFromTree(JsonNode tree, Argument<T> type) Transform a JsonNode to a value of the given type.
default <T> T	readValueFromTree(JsonNode tree, Class<T> type) Transform a JsonNode to a value of the given type.
default void	updateValueFromTree(Object value, JsonNode tree) Update an object from json data.
<T> void	writeValue(OutputStream outputStream, Argument<T> type, T object) Write an object as json.
void	writeValue(OutputStream outputStream, Object object) Write an object as json.
<T> byte[]	writeValueAsBytes(Argument<T> type, T object) Write an object as json.
byte[]	writeValueAsBytes(Object object) Write an object as json.
<T> JsonNode	writeValueToTree(Argument<T> type, T value) Transform an object value to a json tree.
JsonNode	writeValueToTree(Object value) Transform an object value to a json tree.

Method Detail

readValueFromTree

<T> T readValueFromTree(@NonNull
                        JsonNode tree,
                        @NonNull
                        Argument<T> type)
                 throws IOException

Transform a JsonNode to a value of the given type.

Type Parameters:

T - Type variable of the return type.

Parameters:

tree - The input json data.

type - The type to deserialize.

Returns:

The deserialized value.

Throws:

IOException - IOException

readValueFromTree

default <T> T readValueFromTree(@NonNull
                                JsonNode tree,
                                @NonNull
                                Class<T> type)
                         throws IOException

Transform a JsonNode to a value of the given type.

Type Parameters:

T - Type variable of the return type.

Parameters:

tree - The input json data.

type - The type to deserialize.

Returns:

The deserialized value.

Throws:

IOException - IOException

readValue

<T> T readValue(@NonNull
                InputStream inputStream,
                @NonNull
                Argument<T> type)
         throws IOException

Parse and map json from the given stream.

Type Parameters:

T - Type variable of the return type.

Parameters:

inputStream - The input data.

type - The type to deserialize to.

Returns:

The deserialized object.

Throws:

IOException - IOException

readValue

<T> T readValue(@NonNull
                byte[] byteArray,
                @NonNull
                Argument<T> type)
         throws IOException

Parse and map json from the given byte array.

Type Parameters:

T - Type variable of the return type.

Parameters:

byteArray - The input data.

type - The type to deserialize to.

Returns:

The deserialized object.

Throws:

IOException - IOException

readValue

default <T> T readValue(@NonNull
                        String string,
                        @NonNull
                        Argument<T> type)
                 throws IOException

Parse and map json from the given string.

Type Parameters:

T - Type variable of the return type.

Parameters:

string - The input data.

type - The type to deserialize to.

Returns:

The deserialized object.

Throws:

IOException - IOException

createReactiveParser

@NonNull
Processor<byte[],JsonNode> createReactiveParser(@NonNull
                                                         Consumer<Processor<byte[],JsonNode>> onSubscribe,
                                                         boolean streamArray)

Create a reactive Processor that accepts json bytes and parses them as JsonNodes.

Parameters:

onSubscribe - An additional function to invoke with this processor when the returned processor is subscribed to.

streamArray - Whether to return a top-level json array as a stream of elements rather than a single array.

Returns:

The reactive processor.

writeValueToTree

@NonNull
JsonNode writeValueToTree(@Nullable
                                   Object value)
                            throws IOException

Transform an object value to a json tree.

Parameters:

value - The object value to transform.

Returns:

The json representation.

Throws:

IOException - If there are any mapping exceptions (e.g. illegal values).

writeValueToTree

@NonNull
<T> JsonNode writeValueToTree(@NonNull
                                       Argument<T> type,
                                       @Nullable
                                       T value)
                                throws IOException

Transform an object value to a json tree.

Type Parameters:

T - The type variable of the type.

Parameters:

type - The object type

value - The object value to transform.

Returns:

The json representation.

Throws:

IOException - If there are any mapping exceptions (e.g. illegal values).

writeValue

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

Write an object as json.

Parameters:

outputStream - The stream to write to.

object - The object to serialize.

Throws:

IOException - IOException

writeValue

<T> void writeValue(@NonNull
                    OutputStream outputStream,
                    @NonNull
                    Argument<T> type,
                    @Nullable
                    T object)
             throws IOException

Write an object as json.

Type Parameters:

T - The generic type

Parameters:

outputStream - The stream to write to.

type - The object type

object - The object to serialize.

Throws:

IOException - IOException

writeValueAsBytes

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

Write an object as json.

Parameters:

object - The object to serialize.

Returns:

The serialized encoded json.

Throws:

IOException - IOException

writeValueAsBytes

<T> byte[] writeValueAsBytes(@NonNull
                             Argument<T> type,
                             @Nullable
                             T object)
                      throws IOException

Write an object as json.

Type Parameters:

T - The generidc type

Parameters:

type - The object type

object - The object to serialize.

Returns:

The serialized encoded json.

Throws:

IOException - IOException

updateValueFromTree

default void updateValueFromTree(Object value,
                                 @NonNull
                                 JsonNode tree)
                          throws IOException

Update an object from json data.

Parameters:

value - The object to update.

tree - The json data to update from.

Throws:

IOException - If there are any mapping exceptions (e.g. illegal values).

UnsupportedOperationException - If this operation is not supported.

cloneWithFeatures

@NonNull
default JsonMapper cloneWithFeatures(@NonNull
                                              JsonFeatures features)

Create a copy of this mapper with the given json features as returned by detectFeatures(io.micronaut.core.annotation.AnnotationMetadata).

Parameters:

features - The json features to configure.

Returns:

A new mapper.

detectFeatures

@NonNull
default Optional<JsonFeatures> detectFeatures(@NonNull
                                                       AnnotationMetadata annotations)

Detect JsonFeatures from the given annotation data.

Parameters:

annotations - The annotations to scan.

Returns:

The json features for use in cloneWithFeatures(io.micronaut.json.JsonFeatures), or an empty optional if there were no feature annotations detected (or feature annotations are not supported).

cloneWithViewClass

@NonNull
default JsonMapper cloneWithViewClass(@NonNull
                                               Class<?> viewClass)

Create a copy of this mapper with the given view class.

Parameters:

viewClass - The view class to use for serialization and deserialization.

Returns:

A new mapper.

Throws:

UnsupportedOperationException - If views are not supported by this mapper.

getStreamConfig

@NonNull
JsonStreamConfig getStreamConfig()

Returns:

The configured stream config.