org.springframework.core.io.buffer

Class NettyDataBufferFactory

java.lang.Object

org.springframework.core.io.buffer.NettyDataBufferFactory

All Implemented Interfaces:

DataBufferFactory

public class NettyDataBufferFactory
extends Object
implements DataBufferFactory

Implementation of the DataBufferFactory interface based on a Netty ByteBufAllocator.

Since:

5.0

Author:

Arjen Poutsma

See Also:

PooledByteBufAllocator, UnpooledByteBufAllocator

Constructor Summary

Constructors

Constructor and Description
NettyDataBufferFactory(io.netty.buffer.ByteBufAllocator byteBufAllocator) Creates 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.
static io.netty.buffer.ByteBuf	toByteBuf(DataBuffer buffer) Return the given Netty DataBuffer as a ByteBuf.
String	toString()
DataBuffer	wrap(byte[] bytes) Wrap the given byte array in a DataBuffer.
NettyDataBuffer	wrap(io.netty.buffer.ByteBuf byteBuf) Wrap the given Netty ByteBuf in a NettyDataBuffer.
NettyDataBuffer	wrap(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

Constructor Detail

NettyDataBufferFactory

public NettyDataBufferFactory(io.netty.buffer.ByteBufAllocator byteBufAllocator)

Creates a new NettyDataBufferFactory based on the given factory.

Parameters:

byteBufAllocator - the factory to use

See Also:

PooledByteBufAllocator, UnpooledByteBufAllocator

Method Detail

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(ByteBuffer byteBuffer)

Description copied from interface: DataBufferFactory

Wrap the given ByteBuffer in a DataBuffer.

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.

Specified by:

wrap in interface DataBufferFactory

Parameters:

bytes - the byte array to wrap

Returns:

the wrapped buffer

wrap

public NettyDataBuffer wrap(io.netty.buffer.ByteBuf byteBuf)

Wrap the given Netty ByteBuf in a NettyDataBuffer.

Parameters:

byteBuf - the Netty byte buffer to wrap

Returns:

the wrapped buffer

toByteBuf

public static io.netty.buffer.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 String toString()

Overrides:

toString in class Object