io.atomix.catalyst.buffer

Class HeapBuffer

java.lang.Object

io.atomix.catalyst.buffer.AbstractBuffer

io.atomix.catalyst.buffer.HeapBuffer

All Implemented Interfaces:

Buffer, BufferInput<Buffer>, BufferOutput<Buffer>, BytesInput<Buffer>, BytesOutput<Buffer>, ReferenceCounted<Buffer>, AutoCloseable

public class HeapBuffer
extends AbstractBuffer

Heap byte buffer implementation.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
static HeapBuffer	allocate() Allocates a heap buffer with an initial capacity of 4096 and a maximum capacity of HeapMemory.MAX_SIZE.
static HeapBuffer	allocate(long initialCapacity) Allocates a heap buffer with the given initial capacity.
static HeapBuffer	allocate(long initialCapacity, long maxCapacity) Allocates a new heap buffer.
byte[]	array() Returns the underlying byte array.
HeapBuffer	reset(byte[] array) Resets the internal heap array.
static HeapBuffer	wrap(byte[] bytes) Wraps the given bytes in a heap buffer.

Methods inherited from class io.atomix.catalyst.buffer.AbstractBuffer

acquire, asReadOnlyBuffer, bytes, capacity, capacity, clear, close, compact, flip, flush, hasRemaining, isDirect, isFile, isReadOnly, limit, limit, mark, maxCapacity, offset, order, order, position, position, read, read, read, read, read, read, read, readBoolean, readBoolean, readByte, readByte, readChar, readChar, readDouble, readDouble, readFloat, readFloat, readInt, readInt, readLong, readLong, readMedium, readMedium, readShort, readShort, readString, readString, readUnsignedByte, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedMedium, readUnsignedMedium, readUnsignedShort, readUnsignedShort, readUTF8, readUTF8, references, release, remaining, reset, rewind, skip, slice, slice, slice, write, write, write, write, write, write, write, writeBoolean, writeBoolean, writeByte, writeByte, writeChar, writeChar, writeDouble, writeDouble, writeFloat, writeFloat, writeInt, writeInt, writeLong, writeLong, writeMedium, writeMedium, writeShort, writeShort, writeString, writeString, writeUnsignedByte, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt, writeUnsignedMedium, writeUnsignedMedium, writeUnsignedShort, writeUnsignedShort, writeUTF8, writeUTF8, zero, zero, zero

Methods inherited from class java.lang.Object

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

Method Detail

allocate

public static HeapBuffer allocate()

Allocates a heap buffer with an initial capacity of 4096 and a maximum capacity of HeapMemory.MAX_SIZE.

When the buffer is constructed, HeapMemoryAllocator will be used to allocate capacity bytes of memory on the Java heap. The resulting buffer will be initialized with a capacity of 4096 and have a maximum capacity of HeapMemory.MAX_SIZE. The buffer's capacity will dynamically expand as bytes are written to the buffer. The underlying HeapBytes will be initialized to the next power of 2.

Returns:

The heap buffer.

See Also:

allocate(long), allocate(long, long)

allocate

public static HeapBuffer allocate(long initialCapacity)

Allocates a heap buffer with the given initial capacity.

When the buffer is constructed, HeapMemoryAllocator will be used to allocate capacity bytes of memory on the Java heap. The resulting buffer will have an initial capacity of capacity. The underlying HeapBytes will be initialized to the next power of 2.

Parameters:

initialCapacity - The initial capacity of the buffer to allocate (in bytes).

Returns:

The heap buffer.

Throws:

IllegalArgumentException - If capacity is greater than the maximum allowed capacity for an array on the Java heap - Integer.MAX_VALUE - 5

See Also:

allocate(), allocate(long, long)

allocate

public static HeapBuffer allocate(long initialCapacity,
                                  long maxCapacity)

Allocates a new heap buffer.

When the buffer is constructed, HeapMemoryAllocator will be used to allocate capacity bytes of memory on the Java heap. The resulting buffer will have an initial capacity of initialCapacity and will be doubled up to maxCapacity as bytes are written to the buffer. The underlying HeapBytes will be initialized to the next power of 2.

Parameters:

initialCapacity - The initial capacity of the buffer to allocate (in bytes).

maxCapacity - The maximum capacity of the buffer.

Returns:

The heap buffer.

Throws:

IllegalArgumentException - If initialCapacity or maxCapacity is greater than the maximum allowed count for an array on the Java heap - Integer.MAX_VALUE - 5

See Also:

allocate(), allocate(long)

wrap

public static HeapBuffer wrap(byte[] bytes)

Wraps the given bytes in a heap buffer.

The buffer will be created with an initial capacity and maximum capacity equal to the byte array count.

Parameters:

bytes - The bytes to wrap.

Returns:

The wrapped bytes.

array

public byte[] array()

Returns the underlying byte array.

Returns:

The underlying byte array.

reset

public HeapBuffer reset(byte[] array)

Resets the internal heap array.

Parameters:

array - The internal array.

Returns:

The heap buffer.