com.google.flatbuffers.FlatBufferBuilder.ByteBufferFactory Class Reference

An interface that provides a user of the FlatBufferBuilder class the ability to specify the method in which the internal buffer gets allocated. More...

Inheritance diagram for com.google.flatbuffers.FlatBufferBuilder.ByteBufferFactory:

Detailed Description

An interface that provides a user of the FlatBufferBuilder class the ability to specify the method in which the internal buffer gets allocated.

This allows for alternatives to the default behavior, which is to allocate memory for a new byte-array backed ByteBuffer array inside the JVM.

The FlatBufferBuilder class contains the HeapByteBufferFactory class to preserve the default behavior in the event that the user does not provide their own implementation of this interface.

Public Member Functions
abstract ByteBuffer	newByteBuffer (int capacity)
	Create a ByteBuffer with a given capacity. More...
void	releaseByteBuffer (ByteBuffer bb)
	Release a ByteBuffer. More...

Member Function Documentation

newByteBuffer()

abstract ByteBuffer com.google.flatbuffers.FlatBufferBuilder.ByteBufferFactory.newByteBuffer ( int  capacity )

abstract

Create a ByteBuffer with a given capacity.

The returned ByteBuf must have a ByteOrder.LITTLE_ENDIAN ByteOrder.

Parameters

capacity

The size of the ByteBuffer to allocate.

Returns

Returns the new ByteBuffer that was allocated.

Reimplemented in com.google.flatbuffers.FlatBufferBuilder.HeapByteBufferFactory.

releaseByteBuffer()

void com.google.flatbuffers.FlatBufferBuilder.ByteBufferFactory.releaseByteBuffer ( ByteBuffer  bb )

inline

Release a ByteBuffer.

Current FlatBufferBuilder released any reference to it, so it is safe to dispose the buffer or return it to a pool. It is not guaranteed that the buffer has been created with newByteBuffer(int).

Parameters

bb	the buffer to release

---

The documentation for this class was generated from the following file:

• FlatBufferBuilder.java