Module io.jstach.jstachio

Package io.jstach.jstachio.output

Interface ChunkEncodedOutput<T>

Type Parameters:

T - the chunk type

All Superinterfaces:

AutoCloseable, BufferedEncodedOutput, Output<RuntimeException>, Output.CloseableEncodedOutput<RuntimeException>, Output.EncodedOutput<RuntimeException>

public non-sealed interface ChunkEncodedOutput<T>
extends BufferedEncodedOutput

Maintains the encoded output in an iterable of chunks of type T that is optimized for BufferedEncodedOutput.asReadableByteChannel().

Author:

agentgt

Nested Class Summary

Nested classes/interfaces inherited from interface io.jstach.jstachio.Output

Output.CloseableEncodedOutput<E extends Exception>, Output.EncodedOutput<E extends Exception>, Output.StringOutput

Method Summary

Modifier and Type	Method	Description
int	bufferSizeHint()	For chunk output the buffer hint is usually the size of the largest chunk.
Iterable<T>	getChunks()	Gets the internal sequence of chunks.
static ChunkEncodedOutput<byte[]>	ofByteArrays(Charset charset)	A chunk encoded output backed by a list of byte arrays

Methods inherited from interface io.jstach.jstachio.output.BufferedEncodedOutput

accept, append, append, asReadableByteChannel, close, isReusable, limit, size, toByteArray, transferTo

Methods inherited from interface io.jstach.jstachio.Output

append, append, append, append, append, toAppendable

Methods inherited from interface io.jstach.jstachio.Output.EncodedOutput

append, append, charset, write, write

Method Details

getChunks

Iterable<T> getChunks()

Gets the internal sequence of chunks.

Returns:

sequence of chunks

ofByteArrays

static ChunkEncodedOutput<byte[]> ofByteArrays(Charset charset)

A chunk encoded output backed by a list of byte arrays

Parameters:

charset - the expected charset

Returns:

encoded output ready to be written to.

bufferSizeHint

int bufferSizeHint()

For chunk output the buffer hint is usually the size of the largest chunk. The recommend buffer size to use for extracting with BufferedEncodedOutput.asReadableByteChannel() or BufferedEncodedOutput.transferTo(OutputStream).

Specified by:

bufferSizeHint in interface BufferedEncodedOutput

Returns:

buffer size to use which by default is BufferedEncodedOutput.size().