Package io.micronaut.http.body

Class DynamicMessageBodyWriter

java.lang.Object

io.micronaut.http.body.DynamicMessageBodyWriter

All Implemented Interfaces:

MessageBodyWriter<Object>

@Internal
public final class DynamicMessageBodyWriter
extends Object
implements MessageBodyWriter<Object>

Placeholder MessageBodyWriter implementation that decides which writer to use based on the dynamic (runtime) type of the body. Used as fallback where the type is not known statically.

Since:

4.0.0

Author:

Jonas Konrad

Constructor Summary

Constructors

Constructor	Description
DynamicMessageBodyWriter(MessageBodyHandlerRegistry registry, List<MediaType> mediaTypes)

Method Summary

Modifier and Type	Method	Description
MessageBodyWriter<Object>	createSpecific(Argument<Object> type)	Prepare a MessageBodyWriter that will write the given type.
MessageBodyWriter<Object>	find(Argument<Object> type, MediaType mediaType, Object object)
ByteBuffer<?>	writeTo(Argument<Object> type, MediaType mediaType, Object object, MutableHeaders outgoingHeaders, ByteBufferFactory<?,?> bufferFactory)	Writes an object to the given stream.
void	writeTo(Argument<Object> type, MediaType mediaType, Object object, MutableHeaders outgoingHeaders, OutputStream outputStream)	Writes an object to the given output stream.

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.body.MessageBodyWriter

isBlocking, isWriteable

Constructor Details

DynamicMessageBodyWriter

public DynamicMessageBodyWriter(MessageBodyHandlerRegistry registry,
 List<MediaType> mediaTypes)

Method Details

createSpecific

public MessageBodyWriter<Object> createSpecific(Argument<Object> type)

Description copied from interface: MessageBodyWriter

Prepare a MessageBodyWriter that will write the given type. This can be used for precomputing some route data.

Specified by:

createSpecific in interface MessageBodyWriter<Object>

Parameters:

type - The type

Returns:

The closure

find

public MessageBodyWriter<Object> find(Argument<Object> type,
 MediaType mediaType,
 Object object)

writeTo

public void writeTo(Argument<Object> type,
 MediaType mediaType,
 Object object,
 MutableHeaders outgoingHeaders,
 OutputStream outputStream)
             throws CodecException

Description copied from interface: MessageBodyWriter

Writes an object to the given output stream.

Specified by:

writeTo in interface MessageBodyWriter<Object>

Parameters:

type - The type

mediaType - The media type

object - The object to write

outgoingHeaders - The HTTP headers

outputStream - The output stream

Throws:

CodecException - If an error occurs decoding

writeTo

public ByteBuffer<?> writeTo(Argument<Object> type,
 MediaType mediaType,
 Object object,
 MutableHeaders outgoingHeaders,
 ByteBufferFactory<?,?> bufferFactory)
                      throws CodecException

Description copied from interface: MessageBodyWriter

Writes an object to the given stream.

Specified by:

writeTo in interface MessageBodyWriter<Object>

Parameters:

type - The type

mediaType - The media type

object - The object to write

outgoingHeaders - The HTTP headers

bufferFactory - A byte buffer factory

Returns:

The encoded byte buffer

Throws:

CodecException - If an error occurs decoding