Class StreamingResponseBody.ReaderBody

java.lang.Object

com.soklet.StreamingResponseBody.ReaderBody

All Implemented Interfaces:

StreamingResponseBody

Enclosing interface:

StreamingResponseBody

public static final class StreamingResponseBody.ReaderBody
extends Object
implements StreamingResponseBody

A streaming body backed by a Reader supplier.

Author:

Mark Allen

Nested Class Summary

Nested classes/interfaces inherited from interface StreamingResponseBody

StreamingResponseBody.InputStreamBody, StreamingResponseBody.InputStreamBuilder, StreamingResponseBody.PublisherBody, StreamingResponseBody.ReaderBody, StreamingResponseBody.ReaderBuilder, StreamingResponseBody.WriterBody

Modifier and Type	Interface	Description
static final class	StreamingResponseBody.InputStreamBody	A streaming body backed by an InputStream supplier.
static final class	StreamingResponseBody.InputStreamBuilder	Builder for input-stream-backed response bodies.
static final class	StreamingResponseBody.PublisherBody	A streaming body backed by a Flow.Publisher.
static final class	StreamingResponseBody.ReaderBody	A streaming body backed by a Reader supplier.
static final class	StreamingResponseBody.ReaderBuilder	Builder for reader-backed response bodies.
static final class	StreamingResponseBody.WriterBody	A streaming body backed by a writer callback.

Field Summary

Fields inherited from interface StreamingResponseBody

DEFAULT_INPUT_STREAM_BUFFER_SIZE_IN_BYTES, DEFAULT_MALFORMED_INPUT_ACTION, DEFAULT_READER_BUFFER_SIZE_IN_CHARACTERS, DEFAULT_UNMAPPABLE_CHARACTER_ACTION

Modifier and Type	Field	Description
static final @NonNull Integer	DEFAULT_INPUT_STREAM_BUFFER_SIZE_IN_BYTES
static final @NonNull CodingErrorAction	DEFAULT_MALFORMED_INPUT_ACTION
static final @NonNull Integer	DEFAULT_READER_BUFFER_SIZE_IN_CHARACTERS
static final @NonNull CodingErrorAction	DEFAULT_UNMAPPABLE_CHARACTER_ACTION

Method Summary

Modifier and Type	Method	Description
@NonNull Integer	getBufferSizeInCharacters()	The adapter buffer size.
@NonNull Charset	getCharset()	The charset used to encode characters to response bytes.
@NonNull CodingErrorAction	getMalformedInputAction()	Encoder behavior for malformed input.
@NonNull Supplier<? extends Reader>	getReaderSupplier()	The supplier that opens the source reader.
@NonNull CodingErrorAction	getUnmappableCharacterAction()	Encoder behavior for unmappable characters.
@NonNull CharsetEncoder	newEncoder()	Creates a new charset encoder configured with this body's error actions.

Methods inherited from class Object

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

Method Details

getReaderSupplier

public @NonNull Supplier<? extends Reader> getReaderSupplier()

The supplier that opens the source reader.

Returns:

the reader supplier

getCharset

public @NonNull Charset getCharset()

The charset used to encode characters to response bytes.

Returns:

the charset

getBufferSizeInCharacters

public @NonNull Integer getBufferSizeInCharacters()

The adapter buffer size.

Returns:

the adapter buffer size in characters

getMalformedInputAction

public @NonNull CodingErrorAction getMalformedInputAction()

Encoder behavior for malformed input.

Returns:

the malformed-input behavior

getUnmappableCharacterAction

public @NonNull CodingErrorAction getUnmappableCharacterAction()

Encoder behavior for unmappable characters.

Returns:

the unmappable-character behavior

newEncoder

public @NonNull CharsetEncoder newEncoder()

Creates a new charset encoder configured with this body's error actions.

Returns:

a newly configured charset encoder