org.springframework.core.io.buffer

Class NettyDataBufferFactory

java.lang.Object

org.springframework.core.io.buffer.NettyDataBufferFactory

All Implemented Interfaces:

DataBufferFactory

public class NettyDataBufferFactory
extends java.lang.Object
implements DataBufferFactory

Implementation of the DataBufferFactory interface based on a Netty ByteBufAllocator.

Since:

5.0

Author:

Arjen Poutsma, Juergen Hoeller

See Also:

io.netty.buffer.PooledByteBufAllocator, io.netty.buffer.UnpooledByteBufAllocator

Field Summary

Fields

Modifier and Type	Field and Description
private ByteBufAllocator	byteBufAllocator

Constructor Summary

Constructors

Constructor and Description
NettyDataBufferFactory(ByteBufAllocator byteBufAllocator) Create a new NettyDataBufferFactory based on the given factory.

Method Summary

Modifier and Type	Method and Description
NettyDataBuffer	allocateBuffer() Allocate a data buffer of a default initial capacity.
NettyDataBuffer	allocateBuffer(int initialCapacity) Allocate a data buffer of the given initial capacity.
ByteBufAllocator	getByteBufAllocator() Return the ByteBufAllocator used by this factory.
DataBuffer	join(java.util.List<? extends DataBuffer> dataBuffers) Return a new DataBuffer composed of the dataBuffers elements joined together.
static ByteBuf	toByteBuf(DataBuffer buffer) Return the given Netty DataBuffer as a ByteBuf.
java.lang.String	toString()
DataBuffer	wrap(byte[] bytes) Wrap the given byte array in a DataBuffer.
NettyDataBuffer	wrap(ByteBuf byteBuf) Wrap the given Netty ByteBuf in a NettyDataBuffer.
NettyDataBuffer	wrap(java.nio.ByteBuffer byteBuffer) Wrap the given ByteBuffer in a DataBuffer.

Methods inherited from class java.lang.Object

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

Field Detail

byteBufAllocator

private final ByteBufAllocator byteBufAllocator

Constructor Detail

NettyDataBufferFactory

public NettyDataBufferFactory(ByteBufAllocator byteBufAllocator)

Create a new NettyDataBufferFactory based on the given factory.

Parameters:

byteBufAllocator - the factory to use

See Also:

io.netty.buffer.PooledByteBufAllocator, io.netty.buffer.UnpooledByteBufAllocator

Method Detail

getByteBufAllocator

public ByteBufAllocator getByteBufAllocator()

Return the ByteBufAllocator used by this factory.

allocateBuffer

public NettyDataBuffer allocateBuffer()

Description copied from interface: DataBufferFactory

Allocate a data buffer of a default initial capacity. Depending on the underlying implementation and its configuration, this will be heap-based or direct buffer.

Specified by:

allocateBuffer in interface DataBufferFactory

Returns:

the allocated buffer

allocateBuffer

public NettyDataBuffer allocateBuffer(int initialCapacity)

Description copied from interface: DataBufferFactory

Allocate a data buffer of the given initial capacity. Depending on the underlying implementation and its configuration, this will be heap-based or direct buffer.

Specified by:

allocateBuffer in interface DataBufferFactory

Parameters:

initialCapacity - the initial capacity of the buffer to allocate

Returns:

the allocated buffer

wrap

public NettyDataBuffer wrap(java.nio.ByteBuffer byteBuffer)

Description copied from interface: DataBufferFactory

Wrap the given ByteBuffer in a DataBuffer. Unlike allocating, wrapping does not use new memory.

Specified by:

wrap in interface DataBufferFactory

Parameters:

byteBuffer - the NIO byte buffer to wrap

Returns:

the wrapped buffer

wrap

public DataBuffer wrap(byte[] bytes)

Description copied from interface: DataBufferFactory

Wrap the given byte array in a DataBuffer. Unlike allocating, wrapping does not use new memory.

Specified by:

wrap in interface DataBufferFactory

Parameters:

bytes - the byte array to wrap

Returns:

the wrapped buffer

wrap

public NettyDataBuffer wrap(ByteBuf byteBuf)

Wrap the given Netty ByteBuf in a NettyDataBuffer.

Specified by:

wrap in interface DataBufferFactory

Parameters:

byteBuf - the Netty byte buffer to wrap

Returns:

the wrapped buffer

join

public DataBuffer join(java.util.List<? extends DataBuffer> dataBuffers)

Return a new DataBuffer composed of the dataBuffers elements joined together. Depending on the implementation, the returned buffer may be a single buffer containing all data of the provided buffers, or it may be a true composite that contains references to the buffers.

Note that the given data buffers do not have to be released, as they are released as part of the returned composite.

This implementation uses Netty's CompositeByteBuf.

Specified by:

join in interface DataBufferFactory

Parameters:

dataBuffers - the data buffers to be composed

Returns:

a buffer that is composed from the dataBuffers argument

toByteBuf

public static ByteBuf toByteBuf(DataBuffer buffer)

Return the given Netty DataBuffer as a ByteBuf.

Returns the native buffer if buffer is a NettyDataBuffer; returns Unpooled#wrappedBuffer(ByteBuffer) otherwise.

Parameters:

buffer - the DataBuffer to return a ByteBuf for

Returns:

the netty ByteBuf

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object