Package io.deephaven.io.streams

Interface CurrentByteBufferSink

All Superinterfaces:

ByteBufferSink

All Known Implementing Classes:

CurrentByteBufferSink.Adapter, SimpleByteBufferSink

public interface CurrentByteBufferSink
extends ByteBufferSink

A ByteBufferSink that knows and provides a getter for the last buffer it gave out, to avoid unnecessary state in code that uses the buffer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CurrentByteBufferSink.Adapter

Method Summary

Modifier and Type	Method	Description
default void	close()	Convenience close method.
default ByteBuffer	ensureSpace(int need)	Return the current buffer, guaranteed to have sufficient space remaining to append the requested number of bytes.
default void	flush()	Cause the current buffer to be accepted if it has any contents that aren't yet accepted into the sink.
ByteBuffer	getBuffer()	Access the current buffer for this sink.

Methods inherited from interface io.deephaven.io.streams.ByteBufferSink

acceptBuffer, close

Method Details

getBuffer

ByteBuffer getBuffer()

Access the current buffer for this sink. This is either the initial buffer, or the last one provided by ByteBufferSink.acceptBuffer(ByteBuffer, int)) or ensureSpace(int).

Returns:

The current buffer for this sink

ensureSpace

default ByteBuffer ensureSpace(int need)
                        throws IOException

Return the current buffer, guaranteed to have sufficient space remaining to append the requested number of bytes. The existing current buffer may be accepted (see ByteBufferSink.acceptBuffer(ByteBuffer, int)) as a side effect of this operation.

Parameters:

need - The number of bytes required to proceed

Returns:

The current buffer for further output

Throws:

IOException

flush

default void flush()
            throws IOException

Cause the current buffer to be accepted if it has any contents that aren't yet accepted into the sink.

Throws:

IOException

close

default void close()
            throws IOException

Convenience close method. Effectively the same as invoking ByteBufferSink.close(ByteBuffer) with the result of getBuffer().

Throws:

IOException