Package io.micronaut.http.body

Class ByteBodyFactory

java.lang.Object

io.micronaut.http.body.ByteBodyFactory

Direct Known Subclasses:

NettyByteBodyFactory

public class ByteBodyFactory
extends Object

Factory methods for ByteBodys.

While this is public API, extension is only allowed by micronaut-core.

Since:

4.8.0

Author:

Jonas Konrad

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ByteBodyFactory(@NonNull ByteBufferFactory<?,?> byteBufferFactory)	Internal constructor.

Method Summary

Modifier and Type	Method	Description
@NonNull CloseableAvailableByteBody	adapt(byte @NonNull [] array)	Create a new CloseableAvailableByteBody from the given array.
@NonNull CloseableAvailableByteBody	adapt(@NonNull ByteBuffer<?> buffer)	Create a new CloseableAvailableByteBody from the given buffer.
<T extends Throwable> @NonNull CloseableAvailableByteBody	buffer(@NonNull ThrowingConsumer<? super OutputStream,T> writer)	Buffer any data written to an OutputStream and return it as a ByteBody.
final @NonNull ByteBufferFactory<?,?>	byteBufferFactory()	Get the underlying ByteBufferFactory.
@NonNull CloseableAvailableByteBody	copyOf(@NonNull InputStream stream)	Copy the data of the given InputStream into an available ByteBody.
@NonNull CloseableAvailableByteBody	copyOf(@NonNull CharSequence cs, @NonNull Charset charset)	Encode the given CharSequence and create a ByteBody from it.
static @NonNull ByteBodyFactory	createDefault(@NonNull ByteBufferFactory<?,?> byteBufferFactory)	Create a default body factory.
@NonNull CloseableAvailableByteBody	createEmpty()	Create an empty body.

Methods inherited from class java.lang.Object

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

Constructor Details

ByteBodyFactory

@Internal
protected ByteBodyFactory(@NonNull
 @NonNull ByteBufferFactory<?,?> byteBufferFactory)

Internal constructor.

Parameters:

byteBufferFactory - The buffer factory

Method Details

createDefault

@NonNull
public static @NonNull ByteBodyFactory createDefault(@NonNull
 @NonNull ByteBufferFactory<?,?> byteBufferFactory)

Create a default body factory. Where possible, prefer using an existing factory that may have runtime-specific optimizations, such as the factory passed to ResponseBodyWriter.

Parameters:

byteBufferFactory - The base buffer factory

Returns:

The body factory

byteBufferFactory

@NonNull
public final @NonNull ByteBufferFactory<?,?> byteBufferFactory()

Get the underlying ByteBufferFactory. Where possible, prefer using methods on the body factory directly.

Returns:

The buffer factory

adapt

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

Create a new CloseableAvailableByteBody from the given buffer. Ownership of the buffer is transferred to this method; the original buffer may be copied or used as-is depending on implementation. If the buffer is ReferenceCounted, release ownership is also transferred to this method.

Parameters:

buffer - The buffer

Returns:

A ByteBody with the same content as the buffer

adapt

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

Create a new CloseableAvailableByteBody from the given array. Ownership of the array is transferred to this method; the array may be copied or used as-is, so do not modify the array after passing it to this method.

Parameters:

array - The array

Returns:

A ByteBody with the same content as the array

buffer

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

Buffer any data written to an OutputStream and return it as a ByteBody.

Type Parameters:

T - Exception type thrown by the consumer

Parameters:

writer - The function that will write to the OutputStream

Returns:

The data written to the stream

Throws:

T - Exception thrown by the consumer

createEmpty

@NonNull
public @NonNull CloseableAvailableByteBody createEmpty()

Create an empty body.

Returns:

The empty body

copyOf

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

Encode the given CharSequence and create a ByteBody from it.

Parameters:

cs - The input string

charset - The charset to use for encoding

Returns:

The encoded body

copyOf

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

Copy the data of the given InputStream into an available ByteBody. If the input is blocking, this method will also block.

Parameters:

stream - The input to copy

Returns:

A body containing the data read from the input

Throws:

IOException - Any exception thrown by the InputStream read methods