Module methanol

Package com.github.mizosoft.methanol

Interface BodyAdapter.Decoder

All Superinterfaces:

BodyAdapter

All Known Subinterfaces:

AbstractBodyAdapter.BaseDecoder

All Known Implementing Classes:

ForwardingDecoder, StringDecoder

Enclosing interface:

BodyAdapter

public static interface BodyAdapter.Decoder
extends BodyAdapter

A BodyAdapter that decodes response bodies into objects.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.mizosoft.methanol.BodyAdapter

BodyAdapter.Decoder, BodyAdapter.Encoder, BodyAdapter.Hints

Method Summary

Modifier and Type	Method	Description
static BodyAdapter.Decoder	basic()	Returns the basic decoder.
static Optional<BodyAdapter.Decoder>	getDecoder(TypeRef<?> typeRef, @Nullable MediaType mediaType)	Returns a registered decoder that supports the given object type and media type, if any.
static List<BodyAdapter.Decoder>	installed()	Returns an immutable list containing the installed decoders.
default <T> HttpResponse.BodySubscriber<Supplier<T>>	toDeferredObject(TypeRef<T> typeRef, @Nullable MediaType mediaType)	Returns a completed HttpResponse.BodySubscriber that lazily decodes the response body into an object of the given type using the format specified by the given media type.
default <T> HttpResponse.BodySubscriber<Supplier<T>>	toDeferredObject(TypeRef<T> typeRef, BodyAdapter.Hints hints)	Returns a completed HttpResponse.BodySubscriber that lazily decodes the response body into an object of the given type using the given BodyAdapter.Hints.
<T> HttpResponse.BodySubscriber<T>	toObject(TypeRef<T> typeRef, @Nullable MediaType mediaType)	Returns a HttpResponse.BodySubscriber that decodes the response body into an object of the given type using the format specified by the given media type.
default <T> HttpResponse.BodySubscriber<T>	toObject(TypeRef<T> typeRef, BodyAdapter.Hints hints)	Returns a HttpResponse.BodySubscriber that decodes the response body into an object of the given type using the given BodyAdapter.Hints.

Methods inherited from interface com.github.mizosoft.methanol.BodyAdapter

isCompatibleWith, supportsType

Method Details

toObject

<T> HttpResponse.BodySubscriber<T> toObject(TypeRef<T> typeRef,
 @Nullable MediaType mediaType)

Returns a HttpResponse.BodySubscriber that decodes the response body into an object of the given type using the format specified by the given media type. If the given media type is null, the decoder's default format parameters (e.g., charset) are used.

Throws:

UnsupportedOperationException - if any of the given type or media type is not supported

toObject

default <T> HttpResponse.BodySubscriber<T> toObject(TypeRef<T> typeRef,
 BodyAdapter.Hints hints)

Returns a HttpResponse.BodySubscriber that decodes the response body into an object of the given type using the given BodyAdapter.Hints.

Throws:

UnsupportedOperationException - if any of the given type or hint's media type is not supported

toDeferredObject

default <T>
HttpResponse.BodySubscriber<Supplier<T>> toDeferredObject(TypeRef<T> typeRef,
 @Nullable MediaType mediaType)

Returns a completed HttpResponse.BodySubscriber that lazily decodes the response body into an object of the given type using the format specified by the given media type. If mediaType is null, the decoder uses its default format parameters (e.g., charset).

Throws:

UnsupportedOperationException - if any of the given type or media type is not supported

toDeferredObject

default <T>
HttpResponse.BodySubscriber<Supplier<T>> toDeferredObject(TypeRef<T> typeRef,
 BodyAdapter.Hints hints)

Returns a completed HttpResponse.BodySubscriber that lazily decodes the response body into an object of the given type using the given BodyAdapter.Hints.

Throws:

UnsupportedOperationException - if any of the given type or media type is not supported

installed

static List<BodyAdapter.Decoder> installed()

Returns an immutable list containing the installed decoders.

getDecoder

static Optional<BodyAdapter.Decoder> getDecoder(TypeRef<?> typeRef,
 @Nullable MediaType mediaType)

Returns a registered decoder that supports the given object type and media type, if any. If the given media type is null, any decoder supporting the given object type is returned.

basic

static BodyAdapter.Decoder basic()

Returns the basic decoder. The basic decoder is compatible with any media type, and supports decoding:

• String (decoded using MediaType's charset or UTF-8 if absent)
• InputStream
• Reader (decoded using MediaType's charset or UTF-8 if absent)
• byte[]
• ByteBuffer
• Stream<String> (response body lines; MediaType's charset or UTF-8 if absent)
• ResponsePayload (here the decoder expects to receive the HttpResponse.ResponseInfo hint, and an AdapterCodec hint that will be used to convert the payload into the desired type; this is done automatically when sending the request through Methanol)
• Publisher<List<ByteBuffer>> (a replaying publisher for the response body)
• Void (discards the response body)