Module io.jstach.jstachio

Package io.jstach.jstachio.output

Interface ByteBufferEncodedOutput

All Superinterfaces:

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

All Known Implementing Classes:

ByteBufferedOutputStream

public non-sealed interface ByteBufferEncodedOutput
extends BufferedEncodedOutput

An encoded output optimized for producing a single ByteBuffer. The BufferedEncodedOutput.bufferSizeHint() is usually the size of the entire output and usually implementations of this type are reusable with care.

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
ByteBuffer	asByteBuffer()	Gets a byte buffer view of the data.
default ReadableByteChannel	asReadableByteChannel()	Represents the encoded output as readable channel.
static ByteBufferEncodedOutput	ofByteArray(Charset charset)	Calls ofByteArray(Charset, int) with initial size of 4096.
static ByteBufferEncodedOutput	ofByteArray(Charset charset, int initialSize)	Create a buffered encoded output backed by an array that will grow as needed analagous to StringBuilder and/or ByteArrayOutputStream.

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

accept, append, append, bufferSizeHint, 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

asByteBuffer

ByteBuffer asByteBuffer()

Gets a byte buffer view of the data.

Returns:

byte buffer

ofByteArray

static ByteBufferEncodedOutput ofByteArray(Charset charset,
 int initialSize)

Create a buffered encoded output backed by an array that will grow as needed analagous to StringBuilder and/or ByteArrayOutputStream. This output is more optimized for getting byte array or a ByteBuffer as well a reuse.

Parameters:

charset - the expected encoding

initialSize - the initial size of the backing array.

Returns:

buffered output

ofByteArray

static ByteBufferEncodedOutput ofByteArray(Charset charset)

Calls ofByteArray(Charset, int) with initial size of 4096.

Parameters:

charset - the expected encoding

Returns:

buffered output

asReadableByteChannel

default ReadableByteChannel asReadableByteChannel()

Description copied from interface: BufferedEncodedOutput

Represents the encoded output as readable channel. The channel should be closed when finished to signal reuse or destruction of the buffered output!. To possibly help determine the buffer to use for ReadableByteChannel.read(java.nio.ByteBuffer) one can use BufferedEncodedOutput.bufferSizeHint() or BufferedEncodedOutput.size().

Specified by:

asReadableByteChannel in interface BufferedEncodedOutput

Returns:

channel open and ready to read from at the start of the output.

See Also:

• BufferedEncodedOutput.bufferSizeHint()