Spring Framework 6.1.4 · org.springframework.core.io.buffer.NettyDataBufferFactory

Modifier and Type	Field and Description
private final ByteBufAllocator	byteBufAllocator

Access	Constructor and Description
public	NettyDataBufferFactory(ByteBufAllocator the factory to use byteBufAllocator) Create a new `NettyDataBufferFactory` based on the given factory.

Method Summary

Modifier and Type	Method and Description
public NettyDataBuffer	allocateBuffer() Implements org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer. Deprecated Allocate a data buffer of a default initial capacity.
public NettyDataBuffer	allocateBuffer(int the initial capacity of the buffer to allocate initialCapacity) Implements org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer. Allocate a data buffer of the given initial capacity.
public ByteBufAllocator	getByteBufAllocator() Return the `ByteBufAllocator` used by this factory.
public boolean	isDirect() Implements org.springframework.core.io.buffer.DataBufferFactory.isDirect. Indicates whether this factory allocates direct buffers (i.e. non-heap, native memory).
public DataBuffer	join(List<? extends DataBuffer> the data buffers to be composed dataBuffers) Implements org.springframework.core.io.buffer.DataBufferFactory.join. Return a new `DataBuffer` composed of the `dataBuffers` elements joined together.
public static ByteBuf	Returns: the netty `ByteBuf` toByteBuf(DataBuffer the `DataBuffer` to return a `ByteBuf` for dataBuffer) Return the given Netty `DataBuffer` as a `ByteBuf`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public NettyDataBuffer	wrap(ByteBuffer the NIO byte buffer to wrap byteBuffer) Implements org.springframework.core.io.buffer.DataBufferFactory.wrap. Wrap the given `ByteBuffer` in a `DataBuffer`.
public DataBuffer	wrap(byte[] the byte array to wrap bytes) Implements org.springframework.core.io.buffer.DataBufferFactory.wrap. Wrap the given `byte` array in a `DataBuffer`.
public NettyDataBuffer	Returns: the wrapped buffer wrap(ByteBuf the Netty byte buffer to wrap byteBuf) Wrap the given Netty `ByteBuf` in a `NettyDataBuffer`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

byteBufAllocator	back to summary
private final ByteBufAllocator byteBufAllocator

NettyDataBufferFactory	back to summary
public NettyDataBufferFactory(ByteBufAllocator byteBufAllocator) Create a new `NettyDataBufferFactory` based on the given factory. Parameters byteBufAllocator:ByteBufAllocator the factory to use See Also `io.netty.buffer.PooledByteBufAllocator`, `io.netty.buffer.UnpooledByteBufAllocator`

Method Detail

allocateBuffer	back to summary
public NettyDataBuffer allocateBuffer() Implements org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer. Doc from org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer. Deprecated 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. Returns:NettyDataBuffer the allocated buffer Annotations @Override @Deprecated

allocateBuffer

back to summary

public NettyDataBuffer allocateBuffer()

Implements org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer.

Doc from org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer.

Deprecated

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.

Returns:NettyDataBuffer

the allocated buffer

Annotations

@Override
@Deprecated

allocateBuffer	back to summary
public NettyDataBuffer allocateBuffer(int initialCapacity) Implements org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer. Doc from org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer. 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. Parameters initialCapacity:int the initial capacity of the buffer to allocate Returns:NettyDataBuffer the allocated buffer Annotations @Override

allocateBuffer

back to summary

public NettyDataBuffer allocateBuffer(int initialCapacity)

Implements org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer.

Doc from org.springframework.core.io.buffer.DataBufferFactory.allocateBuffer.

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.

Parameters

initialCapacity:int: the initial capacity of the buffer to allocate

Returns:NettyDataBuffer

the allocated buffer

Annotations

@Override

getByteBufAllocator	back to summary
public ByteBufAllocator getByteBufAllocator() Return the `ByteBufAllocator` used by this factory.

isDirect back to summary

isDirect	back to summary
public boolean isDirect() Implements org.springframework.core.io.buffer.DataBufferFactory.isDirect. Doc from org.springframework.core.io.buffer.DataBufferFactory.isDirect. Indicates whether this factory allocates direct buffers (i.e. non-heap, native memory). Returns:boolean `true` if this factory allocates direct buffers; `false` otherwise Annotations @Override

public boolean isDirect()

Implements org.springframework.core.io.buffer.DataBufferFactory.isDirect.

Doc from org.springframework.core.io.buffer.DataBufferFactory.isDirect.

Indicates whether this factory allocates direct buffers (i.e. non-heap, native memory).

Returns:boolean

true if this factory allocates direct buffers; false otherwise

Annotations

@Override

join back to summary

join	back to summary
public DataBuffer join(List<? extends DataBuffer> dataBuffers) Implements org.springframework.core.io.buffer.DataBufferFactory.join. Doc from org.springframework.core.io.buffer.DataBufferFactory.join. 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`. Parameters dataBuffers:List<? extends DataBuffer> the data buffers to be composed Returns:DataBuffer a buffer that is composed of the `dataBuffers` argument Annotations @Override

public DataBuffer join(List<? extends DataBuffer> dataBuffers)

Implements org.springframework.core.io.buffer.DataBufferFactory.join.

Doc from org.springframework.core.io.buffer.DataBufferFactory.join.

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.

Parameters

dataBuffers:List<? extends DataBuffer>: the data buffers to be composed

Returns:DataBuffer

a buffer that is composed of the dataBuffers argument

Annotations

@Override

toByteBuf back to summary

toByteBuf	back to summary
public static ByteBuf toByteBuf(DataBuffer dataBuffer) Return the given Netty `DataBuffer` as a `ByteBuf`. Returns the native buffer if `dataBuffer` is a `NettyDataBuffer`; returns `Unpooled#wrappedBuffer(ByteBuffer)` otherwise. Parameters dataBuffer:DataBuffer the `DataBuffer` to return a `ByteBuf` for Returns:ByteBuf the netty `ByteBuf`

public static ByteBuf toByteBuf(DataBuffer dataBuffer)

Return the given Netty DataBuffer as a ByteBuf.

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

Parameters

dataBuffer:DataBuffer: the DataBuffer to return a ByteBuf for

Returns:ByteBuf

the netty ByteBuf

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

wrap back to summary

wrap	back to summary
public NettyDataBuffer wrap(ByteBuffer byteBuffer) Implements org.springframework.core.io.buffer.DataBufferFactory.wrap. Doc from org.springframework.core.io.buffer.DataBufferFactory.wrap. Wrap the given `ByteBuffer` in a `DataBuffer`. Unlike allocating, wrapping does not use new memory. Parameters byteBuffer:ByteBuffer the NIO byte buffer to wrap Returns:NettyDataBuffer the wrapped buffer Annotations @Override

public NettyDataBuffer wrap(ByteBuffer byteBuffer)

Implements org.springframework.core.io.buffer.DataBufferFactory.wrap.

Doc from org.springframework.core.io.buffer.DataBufferFactory.wrap.

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

Parameters

byteBuffer:ByteBuffer: the NIO byte buffer to wrap

Returns:NettyDataBuffer

the wrapped buffer

Annotations

@Override

wrap back to summary

wrap	back to summary
public DataBuffer wrap(byte[] bytes) Implements org.springframework.core.io.buffer.DataBufferFactory.wrap. Doc from org.springframework.core.io.buffer.DataBufferFactory.wrap. Wrap the given `byte` array in a `DataBuffer`. Unlike allocating, wrapping does not use new memory. Parameters bytes:byte[] the byte array to wrap Returns:DataBuffer the wrapped buffer Annotations @Override

public DataBuffer wrap(byte[] bytes)

Implements org.springframework.core.io.buffer.DataBufferFactory.wrap.

Doc from org.springframework.core.io.buffer.DataBufferFactory.wrap.

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

Parameters

bytes:byte[]: the byte array to wrap

Returns:DataBuffer

the wrapped buffer

Annotations

@Override

wrap back to summary

wrap	back to summary
public NettyDataBuffer wrap(ByteBuf byteBuf) Wrap the given Netty `ByteBuf` in a `NettyDataBuffer`. Parameters byteBuf:ByteBuf the Netty byte buffer to wrap Returns:NettyDataBuffer the wrapped buffer

public NettyDataBuffer wrap(ByteBuf byteBuf)

Wrap the given Netty ByteBuf in a NettyDataBuffer.

Parameters

byteBuf:ByteBuf: the Netty byte buffer to wrap

Returns:NettyDataBuffer

the wrapped buffer

public Class NettyDataBufferFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail