Interface DataBufferFactory
- All Known Implementing Classes:
DefaultDataBufferFactory,NettyDataBufferFactory
public interface DataBufferFactory
A factory for
DataBuffers, allowing for allocation and
wrapping of data buffers.- Since:
- 5.0
- Author:
- Arjen Poutsma
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionAllocate a data buffer of a default initial capacity.allocateBuffer(int initialCapacity) Allocate a data buffer of the given initial capacity.join(List<? extends DataBuffer> dataBuffers) Return a newDataBuffercomposed of thedataBufferselements joined together.wrap(byte[] bytes) Wrap the givenbytearray in aDataBuffer.wrap(ByteBuffer byteBuffer) Wrap the givenByteBufferin aDataBuffer.
-
Method Details
-
allocateBuffer
DataBuffer allocateBuffer()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:
- the allocated buffer
-
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- the initial capacity of the buffer to allocate- Returns:
- the allocated buffer
-
wrap
- Parameters:
byteBuffer- the NIO byte buffer to wrap- Returns:
- the wrapped buffer
-
wrap
- Parameters:
bytes- the byte array to wrap- Returns:
- the wrapped buffer
-
join
Return a newDataBuffercomposed of thedataBufferselements 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.
- Parameters:
dataBuffers- the data buffers to be composed- Returns:
- a buffer that is composed from the
dataBuffersargument - Since:
- 5.0.3
-