Package io.micronaut.http.body

Interface MessageBodyWriter<T>

Type Parameters:

T - The generic type.

All Known Subinterfaces:

MessageBodyHandler<T>, NettyBodyWriter<T>, RawMessageBodyHandler<T>

All Known Implementing Classes:

ByteBufRawMessageBodyHandler, CharSequenceBodyWriter, DynamicMessageBodyWriter, FileBodyWriter, InputStreamBodyWriter, JsonMessageHandler, NettyJsonHandler, NettyJsonStreamHandler, NettyWritableBodyWriter, StreamFileBodyWriter, SystemFileBodyWriter, TextPlainHandler, WritableBodyWriter

@Indexed(MessageBodyWriter.class)
public interface MessageBodyWriter<T>

An interface that allows writing a message body for the client or the server.

Implementors can define beans that use Produces to restrict the applicable content types.

Use Order to specify the precedence of the writer with lower order corresponding to higher precedence.

Since:

4.0.0

See Also:

• Produces

Method Summary

Modifier and Type	Method	Description
default MessageBodyWriter<T>	createSpecific(@NonNull Argument<T> type)	Prepare a MessageBodyWriter that will write the given type.
static @NonNull Charset	getCharset(@NonNull Headers headers)	Resolve the charset.
default boolean	isBlocking()	true iff this closure can do a blocking read on the object it receives.
default boolean	isWriteable(@NonNull Argument<T> type, @Nullable MediaType mediaType)	Is the type writeable.
default @NonNull ByteBuffer<?>	writeTo(@NonNull Argument<T> type, @NonNull MediaType mediaType, T object, @NonNull MutableHeaders outgoingHeaders, @NonNull ByteBufferFactory<?,?> bufferFactory)	Writes an object to the given stream.
void	writeTo(@NonNull Argument<T> type, @NonNull MediaType mediaType, T object, @NonNull MutableHeaders outgoingHeaders, @NonNull OutputStream outputStream)	Writes an object to the given output stream.

Method Details

isWriteable

default boolean isWriteable(@NonNull
 @NonNull Argument<T> type,
 @Nullable
 @Nullable MediaType mediaType)

Is the type writeable.

Parameters:

type - The type

mediaType - The media type, can be null

Returns:

True if is writable

createSpecific

default MessageBodyWriter<T> createSpecific(@NonNull
 @NonNull Argument<T> type)

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

Parameters:

type - The type

Returns:

The closure

isBlocking

default boolean isBlocking()

true iff this closure can do a blocking read on the object it receives. For example, if this closure writes from an InputStream, that operation may be blocking and this method returns true.
Note that even when this is false, writeTo(Argument, MediaType, Object, MutableHeaders, OutputStream) may still block because the OutputStream that is passed as the write destination may still block.

Returns:

Whether this writer may block

getCharset

@NonNull
static @NonNull Charset getCharset(@NonNull
 @NonNull Headers headers)

Resolve the charset.

Parameters:

headers - The headers

Returns:

The charset

writeTo

void writeTo(@NonNull
 @NonNull Argument<T> type,
 @NonNull
 @NonNull MediaType mediaType,
 T object,
 @NonNull
 @NonNull MutableHeaders outgoingHeaders,
 @NonNull
 @NonNull OutputStream outputStream)
      throws CodecException

Writes an object to the given output stream.

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

@NonNull
default @NonNull ByteBuffer<?> writeTo(@NonNull
 @NonNull Argument<T> type,
 @NonNull
 @NonNull MediaType mediaType,
 T object,
 @NonNull
 @NonNull MutableHeaders outgoingHeaders,
 @NonNull
 @NonNull ByteBufferFactory<?,?> bufferFactory)
                                throws CodecException

Writes an object to the given stream.

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