io.aeron

Class BufferBuilder

java.lang.Object

io.aeron.BufferBuilder

public class BufferBuilder
extends java.lang.Object

Reusable Builder for appending a sequence of buffers that grows internal capacity as needed. Similar in concept to StringBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INITIAL_CAPACITY Initial capacity for the internal buffer.
static int	MAX_CAPACITY Maximum capacity to which the array can grow.

Constructor Summary

Constructors

Constructor and Description
BufferBuilder() Construct a buffer builder with a default growth increment of INITIAL_CAPACITY
BufferBuilder(int initialCapacity) Construct a buffer builder with an initial capacity that will be rounded up to the nearest power of 2.

Method Summary

Modifier and Type	Method and Description
BufferBuilder	append(org.agrona.DirectBuffer srcBuffer, int srcOffset, int length) Append a source buffer to the end of the internal buffer, resizing the internal buffer as required.
org.agrona.MutableDirectBuffer	buffer() The MutableDirectBuffer that encapsulates the internal buffer.
int	capacity() The current capacity of the buffer.
BufferBuilder	compact() Compact the buffer to reclaim unused space above the limit.
int	limit() The current limit of the buffer that has been used by append operations.
void	limit(int limit) Set this limit for this buffer as the position at which the next append operation will occur.
BufferBuilder	reset() Reset the builder to restart append operations.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CAPACITY

public static final int MAX_CAPACITY

Maximum capacity to which the array can grow.

See Also:

Constant Field Values

INITIAL_CAPACITY

public static final int INITIAL_CAPACITY

Initial capacity for the internal buffer.

See Also:

Constant Field Values

Constructor Detail

BufferBuilder

public BufferBuilder()

Construct a buffer builder with a default growth increment of INITIAL_CAPACITY

BufferBuilder

public BufferBuilder(int initialCapacity)

Construct a buffer builder with an initial capacity that will be rounded up to the nearest power of 2.

Parameters:

initialCapacity - at which the capacity will start.

Method Detail

capacity

public int capacity()

The current capacity of the buffer.

Returns:

the current capacity of the buffer.

limit

public int limit()

The current limit of the buffer that has been used by append operations.

Returns:

the current limit of the buffer that has been used by append operations.

limit

public void limit(int limit)

Set this limit for this buffer as the position at which the next append operation will occur.

Parameters:

limit - to be the new value.

buffer

public org.agrona.MutableDirectBuffer buffer()

The MutableDirectBuffer that encapsulates the internal buffer.

Returns:

the MutableDirectBuffer that encapsulates the internal buffer.

reset

public BufferBuilder reset()

Reset the builder to restart append operations. The internal buffer does not shrink.

Returns:

the builder for fluent API usage.

compact

public BufferBuilder compact()

Compact the buffer to reclaim unused space above the limit.

Returns:

the builder for fluent API usage.

append

public BufferBuilder append(org.agrona.DirectBuffer srcBuffer,
                            int srcOffset,
                            int length)

Append a source buffer to the end of the internal buffer, resizing the internal buffer as required.

Parameters:

srcBuffer - from which to copy.

srcOffset - in the source buffer from which to copy.

length - in bytes to copy from the source buffer.

Returns:

the builder for fluent API usage.