Package io.micronaut.runtime.http.codec

Class TextPlainCodec

java.lang.Object

io.micronaut.runtime.http.codec.TextPlainCodec

All Implemented Interfaces:

MediaTypeCodec

@Singleton
public class TextPlainCodec
extends Object
implements MediaTypeCodec

A codec that handles MediaType.TEXT_PLAIN.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATION_QUALIFIER

Constructor Summary

Constructors

Constructor	Description
TextPlainCodec(Charset defaultCharset, ConversionService conversionService)
TextPlainCodec(Optional<Charset> defaultCharset, @Nullable CodecConfiguration codecConfiguration, ConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
<T> T	decode(Argument<T> type, byte[] bytes)	Decode the given type from the given bytes.
<T> T	decode(Argument<T> type, ByteBuffer<?> buffer)	Decode the given type from the given buffer.
<T> T	decode(Argument<T> type, InputStream inputStream)	Decode the given type from the given InputStream.
<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, OutputStream outputStream)	Encode the given type to the given OutputStream.
Collection<MediaType>	getMediaTypes()

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, encode, encode, encode, supportsType

Field Details

CONFIGURATION_QUALIFIER

public static final String CONFIGURATION_QUALIFIER

See Also:

• Constant Field Values

Constructor Details

TextPlainCodec

@Inject
public TextPlainCodec(@Value("${micronaut.application.default-charset}")
 Optional<Charset> defaultCharset,
 @Named("text") @Nullable
 @Nullable CodecConfiguration codecConfiguration,
 ConversionService conversionService)

Parameters:

defaultCharset - The default charset used for serialization and deserialization

codecConfiguration - The configuration for the codec

conversionService - The conversion service

TextPlainCodec

public TextPlainCodec(Charset defaultCharset,
 ConversionService conversionService)

Parameters:

defaultCharset - The default charset used for serialization and deserialization

conversionService - The conversion service

Method Details

getMediaTypes

public Collection<MediaType> getMediaTypes()

Specified by:

getMediaTypes in interface MediaTypeCodec

Returns:

The media type of the codec

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,
 byte[] bytes)
             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

bytes - The bytes

Returns:

The decoded result

Throws:

CodecException - When the result cannot be decoded

decode

public <T> T decode(Argument<T> type,
 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

encode

public <T> void encode(T object,
 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