Package io.micronaut.http.body
Class WritableBodyWriter
java.lang.Object
io.micronaut.http.body.WritableBodyWriter
- All Implemented Interfaces:
ChunkedMessageBodyReader<Writable>
,MessageBodyHandler<Writable>
,MessageBodyReader<Writable>
,MessageBodyWriter<Writable>
,RawMessageBodyHandler<Writable>
@Singleton
@Bean(typed=RawMessageBodyHandler.class)
public final class WritableBodyWriter
extends Object
implements RawMessageBodyHandler<Writable>
Body writer for
Writable
s.- Since:
- 4.0.0
- Author:
- Graeme Rocher
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionCollection<? extends Class<?>>
getTypes()
Supported types of this raw body handler.boolean
true
iff this closure can do a blocking read on the object it receives.Reads an object from the given byte buffer.Reads an object from the given byte buffer.readChunked
(Argument<Writable> type, MediaType mediaType, Headers httpHeaders, Publisher<ByteBuffer<?>> input) void
writeTo
(Argument<Writable> type, MediaType mediaType, Writable 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.MessageBodyReader
isReadable
Methods inherited from interface io.micronaut.http.body.MessageBodyWriter
createSpecific, isWriteable, writeTo
-
Constructor Details
-
WritableBodyWriter
-
-
Method Details
-
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 anInputStream
, that operation may be blocking and this method returnstrue
.
Note that even when this isfalse
,MessageBodyWriter.writeTo(Argument, MediaType, Object, MutableHeaders, OutputStream)
may still block because theOutputStream
that is passed as the write destination may still block.- Specified by:
isBlocking
in interfaceMessageBodyWriter<Writable>
- Returns:
- Whether this writer may block
-
getTypes
Description copied from interface:RawMessageBodyHandler
Supported types of this raw body handler. Exact match is used for reading. For writing, the match is covariant. For example, if this returns[String, CharSequence]
, then this raw handler will be used for reading types declared as exactlyString
orCharSequence
, and will additionally be used for writing (but not reading) subtypes (e.g.StringBuilder
).- Specified by:
getTypes
in interfaceRawMessageBodyHandler<Writable>
- Returns:
- The supported types
-
writeTo
public void writeTo(Argument<Writable> type, MediaType mediaType, Writable object, MutableHeaders outgoingHeaders, OutputStream outputStream) throws CodecException Description copied from interface:MessageBodyWriter
Writes an object to the given output stream.- Specified by:
writeTo
in interfaceMessageBodyWriter<Writable>
- Parameters:
type
- The typemediaType
- The media typeobject
- The object to writeoutgoingHeaders
- The HTTP headersoutputStream
- The output stream- Throws:
CodecException
- If an error occurs decoding
-
readChunked
public Publisher<? extends Writable> readChunked(Argument<Writable> type, MediaType mediaType, Headers httpHeaders, Publisher<ByteBuffer<?>> input) - Specified by:
readChunked
in interfaceChunkedMessageBodyReader<Writable>
-
read
public Writable read(Argument<Writable> type, MediaType mediaType, Headers httpHeaders, ByteBuffer<?> byteBuffer) throws CodecException Description copied from interface:MessageBodyReader
Reads an object from the given byte buffer.- Specified by:
read
in interfaceMessageBodyReader<Writable>
- Parameters:
type
- The type being decoded.mediaType
- The media type, can benull
httpHeaders
- The HTTP headersbyteBuffer
- The byte buffer- Returns:
- The read object or
null
- Throws:
CodecException
- If an error occurs decoding
-
read
public Writable read(Argument<Writable> type, MediaType mediaType, Headers httpHeaders, InputStream inputStream) throws CodecException Description copied from interface:MessageBodyReader
Reads an object from the given byte buffer.- Specified by:
read
in interfaceMessageBodyReader<Writable>
- Parameters:
type
- The type being decoded.mediaType
- The media type, can benull
httpHeaders
- The HTTP headersinputStream
- The input stream- Returns:
- The read object or
null
- Throws:
CodecException
- If an error occurs decoding
-