Package io.micronaut.http.body

Class ResponseBodyWriterWrapper<T>

java.lang.Object

io.micronaut.http.body.ResponseBodyWriterWrapper<T>

Type Parameters:

T - The body type

All Implemented Interfaces:

MessageBodyWriter<T>, ResponseBodyWriter<T>

@Internal
public class ResponseBodyWriterWrapper<T>
extends Object
implements ResponseBodyWriter<T>

ResponseBodyWriter implementation that delegates to a MessageBodyWriter.

Since:

4.7.0

Author:

Jonas Konrad

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResponseBodyWriterWrapper(MessageBodyWriter<T> wrapped)

Method Summary

Modifier and Type	Method	Description
MessageBodyWriter<T>	createSpecific(@NonNull Argument<T> type)	Prepare a MessageBodyWriter that will write the given type.
boolean	isBlocking()	true iff this closure can do a blocking read on the object it receives.
boolean	isWriteable(@NonNull Argument<T> type, @Nullable MediaType mediaType)	Is the type writeable.
@NonNull ByteBodyHttpResponse<?>	write(@NonNull ByteBufferFactory<?,?> bufferFactory, @NonNull HttpRequest<?> request, @NonNull MutableHttpResponse<T> httpResponse, @NonNull Argument<T> type, @NonNull MediaType mediaType, T object)	Writes an object as a ByteBodyHttpResponse.
@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.

Methods inherited from class java.lang.Object

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

Constructor Details

ResponseBodyWriterWrapper

protected ResponseBodyWriterWrapper(MessageBodyWriter<T> wrapped)

Method Details

isWriteable

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

Description copied from interface: MessageBodyWriter

Is the type writeable.

Specified by:

isWriteable in interface MessageBodyWriter<T>

Parameters:

type - The type

mediaType - The media type, can be null

Returns:

True if is writable

createSpecific

public MessageBodyWriter<T> createSpecific(@NonNull
 @NonNull Argument<T> 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<T>

Parameters:

type - The type

Returns:

The closure

isBlocking

public boolean isBlocking()

Description copied from interface: MessageBodyWriter

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, MessageBodyWriter.writeTo(Argument, MediaType, Object, MutableHeaders, OutputStream) may still block because the OutputStream that is passed as the write destination may still block.

Specified by:

isBlocking in interface MessageBodyWriter<T>

Returns:

Whether this writer may block

writeTo

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

Description copied from interface: MessageBodyWriter

Writes an object to the given output stream.

Specified by:

writeTo in interface MessageBodyWriter<T>

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
public @NonNull ByteBuffer<?> writeTo(@NonNull
 @NonNull Argument<T> type,
 @NonNull
 @NonNull MediaType mediaType,
 T object,
 @NonNull
 @NonNull MutableHeaders outgoingHeaders,
 @NonNull
 @NonNull ByteBufferFactory<?,?> bufferFactory)
                               throws CodecException

Description copied from interface: MessageBodyWriter

Writes an object to the given stream.

Specified by:

writeTo in interface MessageBodyWriter<T>

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

write

@NonNull
public @NonNull ByteBodyHttpResponse<?> write(@NonNull
 @NonNull ByteBufferFactory<?,?> bufferFactory,
 @NonNull
 @NonNull HttpRequest<?> request,
 @NonNull
 @NonNull MutableHttpResponse<T> httpResponse,
 @NonNull
 @NonNull Argument<T> type,
 @NonNull
 @NonNull MediaType mediaType,
 T object)
                                       throws CodecException

Description copied from interface: ResponseBodyWriter

Writes an object as a ByteBodyHttpResponse.

Specified by:

write in interface ResponseBodyWriter<T>

Parameters:

bufferFactory - The buffer factory

request - The request

httpResponse - The response

type - The response body type

mediaType - The media type

object - The object to write

Returns:

A ByteBodyHttpResponse with the response bytes

Throws:

CodecException - If an error occurs encoding