io.micronaut.jackson.codec

Class JacksonMediaTypeCodec

java.lang.Object

io.micronaut.jackson.codec.JacksonMediaTypeCodec

All Implemented Interfaces:

MediaTypeCodec

Direct Known Subclasses:

JsonMediaTypeCodec

public abstract class JacksonMediaTypeCodec
extends java.lang.Object
implements MediaTypeCodec

A MediaTypeCodec Jackson based implementations.

Since:

1.3.0

Author:

Graeme Rocher, svishnyakov

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<MediaType>	additionalTypes
protected ApplicationConfiguration	applicationConfiguration
protected CodecConfiguration	codecConfiguration
protected MediaType	mediaType

Constructor Summary

Constructors

Constructor and Description
JacksonMediaTypeCodec(com.fasterxml.jackson.databind.ObjectMapper objectMapper, ApplicationConfiguration applicationConfiguration, CodecConfiguration codecConfiguration, MediaType mediaType)
JacksonMediaTypeCodec(javax.inject.Provider<com.fasterxml.jackson.databind.ObjectMapper> objectMapperProvider, ApplicationConfiguration applicationConfiguration, CodecConfiguration codecConfiguration, MediaType mediaType)

Method Summary

Modifier and Type	Method and Description
abstract JacksonMediaTypeCodec	cloneWithFeatures(JacksonFeatures jacksonFeatures) Create a new codec with the provided features.
<T> T	decode(Argument<T> type, ByteBuffer<?> buffer) Decode the given type from the given buffer.
<T> T	decode(Argument<T> type, java.io.InputStream inputStream) Decode the given type from the given InputStream.
<T> T	decode(Argument<T> type, com.fasterxml.jackson.databind.JsonNode node) Decodes the given JSON node.
<T> T	decode(Argument<T> type, java.lang.String data) Decode the given type from the given bytes.
<T> byte[]	encode(T object) Encode the given type returning the object as a byte[].
<T,B> ByteBuffer<B>	encode(T object, ByteBufferFactory<?,B> allocator) Encode the given type returning the object as a ByteBuffer.
<T> void	encode(T object, java.io.OutputStream outputStream) Encode the given type to the given OutputStream.
java.util.Collection<MediaType>	getMediaTypes()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
boolean	supportsType(java.lang.Class<?> type) Whether the codec can decode the given type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.codec.MediaTypeCodec

decode, decode, decode, decode, decode

Field Detail

applicationConfiguration

protected final ApplicationConfiguration applicationConfiguration

additionalTypes

protected final java.util.List<MediaType> additionalTypes

codecConfiguration

protected final CodecConfiguration codecConfiguration

mediaType

protected final MediaType mediaType

Constructor Detail

JacksonMediaTypeCodec

public JacksonMediaTypeCodec(javax.inject.Provider<com.fasterxml.jackson.databind.ObjectMapper> objectMapperProvider,
                             ApplicationConfiguration applicationConfiguration,
                             CodecConfiguration codecConfiguration,
                             MediaType mediaType)

Parameters:

objectMapperProvider - To read/write JSON

applicationConfiguration - The common application configurations

codecConfiguration - The configuration for the codec

mediaType - Client request/response media type

JacksonMediaTypeCodec

public JacksonMediaTypeCodec(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                             ApplicationConfiguration applicationConfiguration,
                             CodecConfiguration codecConfiguration,
                             MediaType mediaType)

Parameters:

objectMapper - To read/write JSON

applicationConfiguration - The common application configurations

codecConfiguration - The configuration for the codec

mediaType - Client request/response media type

Method Detail

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Returns:

The object mapper

cloneWithFeatures

public abstract JacksonMediaTypeCodec cloneWithFeatures(JacksonFeatures jacksonFeatures)

Create a new codec with the provided features.

Parameters:

jacksonFeatures - The jackson features

Returns:

The new codec

getMediaTypes

public java.util.Collection<MediaType> getMediaTypes()

Specified by:

getMediaTypes in interface MediaTypeCodec

Returns:

The media type of the codec

supportsType

public boolean supportsType(java.lang.Class<?> type)

Description copied from interface: MediaTypeCodec

Whether the codec can decode the given type.

Specified by:

supportsType in interface MediaTypeCodec

Parameters:

type - The type

Returns:

True if it can

decode

public <T> T decode(Argument<T> type,
                    java.io.InputStream inputStream)
             throws CodecException

Description copied from interface: MediaTypeCodec

Decode the given type from the given InputStream.

Specified by:

decode in interface MediaTypeCodec

Type Parameters:

T - The generic type

Parameters:

type - The type

inputStream - The input stream

Returns:

The decoded result

Throws:

CodecException - When the result cannot be decoded

decode

public <T> T decode(Argument<T> type,
                    com.fasterxml.jackson.databind.JsonNode node)
             throws CodecException

Decodes the given JSON node.

Type Parameters:

T - The generic type

Parameters:

type - The type

node - The Json Node

Returns:

The decoded object

Throws:

CodecException - When object cannot be decoded

decode

public <T> T decode(Argument<T> type,
                    ByteBuffer<?> buffer)
             throws CodecException

Description copied from interface: MediaTypeCodec

Decode the given type from the given buffer. Implementations optimized to handle ByteBuffer instances should override this method.

Specified by:

decode in interface MediaTypeCodec

Type Parameters:

T - The decoded type

Parameters:

type - The type

buffer - the buffer

Returns:

The decoded result

Throws:

CodecException - When the result cannot be decoded

decode

public <T> T decode(Argument<T> type,
                    java.lang.String data)
             throws CodecException

Description copied from interface: MediaTypeCodec

Decode the given type from the given bytes.

Specified by:

decode in interface MediaTypeCodec

Type Parameters:

T - The decoded type

Parameters:

type - The type

data - The data as a string

Returns:

The decoded result

Throws:

CodecException - When the result cannot be decoded

encode

public <T> void encode(T object,
                       java.io.OutputStream outputStream)
                throws CodecException

Description copied from interface: MediaTypeCodec

Encode the given type to the given OutputStream.

Specified by:

encode in interface MediaTypeCodec

Type Parameters:

T - The generic type

Parameters:

object - The object to encode

outputStream - The output stream

Throws:

CodecException - When the result cannot be encoded

encode

public <T> byte[] encode(T object)
                  throws CodecException

Description copied from interface: MediaTypeCodec

Encode the given type returning the object as a byte[].

Specified by:

encode in interface MediaTypeCodec

Type Parameters:

T - The generic type

Parameters:

object - The object to encode

Returns:

The decoded result

Throws:

CodecException - When the result cannot be encoded

encode

public <T,B> ByteBuffer<B> encode(T object,
                                  ByteBufferFactory<?,B> allocator)
                           throws CodecException

Description copied from interface: MediaTypeCodec

Encode the given type returning the object as a ByteBuffer.

Specified by:

encode in interface MediaTypeCodec

Type Parameters:

T - The generic type

B - The buffer type

Parameters:

object - The object to encode

allocator - The allocator

Returns:

The decoded result

Throws:

CodecException - When the result cannot be encoded