Interface MessageOutput<T>

Type Parameters:

T - the type of output produced

All Known Subinterfaces:

MessageOutput.Buffer

public sealed interface MessageOutput<T>
permits MessageOutput.Buffer (not exhaustive)

A container for the in-memory output produced by a MessageWriter.

To create a MessageOutput, call one of its ofXxx methods. To pass the MessageOutput to a message writer, call MessageWriter.of(java.nio.channels.WritableByteChannel). To obtain the produced output, call get() after the message writer has been closed.

Producing in-memory output requires buffer copying. For best performance, use a message writer that writes to a WritableByteChannel or OutputStream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MessageOutput.Buffer	A container for the LeasedByteBuffer produced by a MessageWriter.

Method Summary

Modifier and Type	Method	Description
T	get()	Returns the output produced by a MessageWriter.
static MessageOutput.Buffer	ofBuffer()	Returns a new MessageOutput for a LeasedByteBuffer.
static MessageOutput.Buffer	ofBuffer(Consumer<MessageOutput.Buffer.OptionBuilder> optionHandler)	Returns a new MessageOutput for a LeasedByteBuffer with the given options.

Method Details

ofBuffer

static MessageOutput.Buffer ofBuffer()

Returns a new MessageOutput for a LeasedByteBuffer.

Returns:

a new MessageOutput for a LeasedByteBuffer

ofBuffer

static MessageOutput.Buffer ofBuffer(Consumer<MessageOutput.Buffer.OptionBuilder> optionHandler)

Returns a new MessageOutput for a LeasedByteBuffer with the given options.

Parameters:

optionHandler - a handler that receives a MessageOutput.Buffer.OptionBuilder

Returns:

a new MessageOutput for a LeasedByteBuffer with the given options

get

T get()

Returns the output produced by a MessageWriter.

Returns:

the output produced by a MessageWriter

Throws:

IllegalStateException - if this method is called before the message writer has been closed