Package io.micronaut.core.io.buffer

Class ReadBufferFactory

java.lang.Object

io.micronaut.core.io.buffer.ReadBufferFactory

Direct Known Subclasses:

NettyReadBufferFactory

public class ReadBufferFactory
extends Object

Factory for ReadBuffers.

Since:

4.10.0

Author:

Jonas Konrad

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReadBufferFactory.BufferingOutputStream	Wrapper around a OutputStream that buffers into a ReadBuffer.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReadBufferFactory()	Internal constructor.

Method Summary

Modifier and Type	Method	Description
@NonNull ReadBuffer	adapt(byte @NonNull [] array)	Create a buffer with the given input data.
@NonNull ReadBuffer	adapt(@NonNull ByteBuffer nioBuffer)	Create a buffer with the given input data.
@NonNull ReadBuffer	adapt(ByteBuffer<?> buffer)	Create a buffer with the given input data.
<T extends Throwable> @NonNull ReadBuffer	buffer(@NonNull ThrowingConsumer<@NonNull ? super OutputStream,T> writer)	Write to a new buffer using an OutputStream.
@NonNull ReadBuffer	compose(@NonNull Iterable<@NonNull ReadBuffer> buffers)	Create a new composite buffer out of the given collection of buffers.
@NonNull ReadBuffer	copyOf(@NonNull InputStream stream)	Create a new buffer containing all data from the given stream.
@NonNull ReadBuffer	copyOf(@NonNull CharSequence cs, @NonNull Charset charset)	Create a new buffer containing the given text.
@NonNull ReadBuffer	copyOf(@NonNull ByteBuffer nioBuffer)	Create a buffer, copying the given input data.
@NonNull ReadBuffer	createEmpty()	Create an empty ReadBuffer.
static @NonNull ReadBufferFactory	getJdkFactory()	Get the default ReadBufferFactory backed by JDK-only data structures.
ReadBufferFactory.BufferingOutputStream	outputStreamBuffer()	Create a new OutputStream that buffers into a ReadBuffer.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadBufferFactory

@Internal
protected ReadBufferFactory()

Internal constructor. Extension is only allowed in micronaut-core.

Method Details

getJdkFactory

@NonNull
public static @NonNull ReadBufferFactory getJdkFactory()

Get the default ReadBufferFactory backed by JDK-only data structures.

Returns:

The factory

createEmpty

@NonNull
public @NonNull ReadBuffer createEmpty()

Create an empty ReadBuffer.

Returns:

An empty buffer

copyOf

@NonNull
public @NonNull ReadBuffer copyOf(@NonNull
 @NonNull CharSequence cs,
 @NonNull
 @NonNull Charset charset)

Create a new buffer containing the given text.

Parameters:

cs - The input text

charset - The charset to use for encoding

Returns:

The text buffer

copyOf

@NonNull
public @NonNull ReadBuffer copyOf(@NonNull
 @NonNull InputStream stream)
                           throws IOException

Create a new buffer containing all data from the given stream. This is a blocking operation.

Parameters:

stream - The stream to read from

Returns:

The buffer

Throws:

IOException

copyOf

@NonNull
public @NonNull ReadBuffer copyOf(@NonNull
 @NonNull ByteBuffer nioBuffer)

Create a buffer, copying the given input data.

Parameters:

nioBuffer - A NIO buffer to read data from

Returns:

The copied buffer

adapt

@NonNull
public @NonNull ReadBuffer adapt(@NonNull
 @NonNull ByteBuffer nioBuffer)

Create a buffer with the given input data. Whether the data is copied or used as-is is implementation-defined. Ownership of the given buffer transfers to this class, so it should not be modified elsewhere after this method is called.

Parameters:

nioBuffer - A NIO buffer

Returns:

The adapted buffer

adapt

@NonNull
public @NonNull ReadBuffer adapt(@NonNull
 ByteBuffer<?> buffer)

Create a buffer with the given input data. Whether the data is copied or used as-is is implementation-defined. Ownership of the given buffer transfers to this class, so it should not be modified elsewhere after this method is called. If the input buffer is reference counted, release ownership also transfers to this class.

Parameters:

buffer - A buffer

Returns:

The adapted buffer

adapt

@NonNull
public @NonNull ReadBuffer adapt(byte @NonNull [] array)

Create a buffer with the given input data. Whether the data is copied or used as-is is implementation-defined. Ownership of the given array transfers to this class, so it should not be modified elsewhere after this method is called.

Parameters:

array - A byte array

Returns:

The adapted buffer

buffer

@NonNull
public <T extends Throwable> @NonNull ReadBuffer buffer(@NonNull
 @NonNull ThrowingConsumer<@NonNull ? super OutputStream,T> writer)
                                                 throws T

Write to a new buffer using an OutputStream. When the given writer completes, the written data is combined into a ReadBuffer that is then returned.

Type Parameters:

T - An exception thrown by the writer

Parameters:

writer - The writer

Returns:

The written data

Throws:

T - If the writer throws an exception

outputStreamBuffer

@NonNull
public ReadBufferFactory.BufferingOutputStream outputStreamBuffer()

Create a new OutputStream that buffers into a ReadBuffer. Used like this:

 CloseableAvailableByteBody body;
 try (BufferingOutputStream bos = byteBodyFactory.outputStreamBuffer()) {
     bos.stream().write(123);
     // ...
     body = bos.finishBuffer();
 }
 // use body
 

Note that for simple use cases, buffer(ThrowingConsumer) may be a bit more convenient, but this method offers more control over the stream lifecycle.

Returns:

The ReadBufferFactory.BufferingOutputStream wrapper

compose

@NonNull
public @NonNull ReadBuffer compose(@NonNull
 @NonNull Iterable<@NonNull ReadBuffer> buffers)

Create a new composite buffer out of the given collection of buffers. This operation consumes all input buffers, even if there is an exception along the way.

Parameters:

buffers - The input buffers to compose

Returns:

The composite buffer

Throws:

IllegalStateException - If any given buffer is already closed or consumed