org.agrona

Class BufferUtil

java.lang.Object

org.agrona.BufferUtil

public class BufferUtil
extends java.lang.Object

Common functions for buffer implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ARRAY_BASE_OFFSET
static long	BYTE_BUFFER_HB_FIELD_OFFSET
static long	BYTE_BUFFER_OFFSET_FIELD_OFFSET
static java.nio.ByteOrder	NATIVE_BYTE_ORDER
static byte[]	NULL_BYTES

Constructor Summary

Constructors

Constructor and Description
BufferUtil()

Method Summary

Modifier and Type	Method and Description
static long	address(java.nio.ByteBuffer buffer) Get the address at which the underlying buffer storage begins.
static java.nio.ByteBuffer	allocateDirectAligned(int capacity, int alignment) Allocate a new direct ByteBuffer that is aligned on a given alignment boundary.
static byte[]	array(java.nio.ByteBuffer buffer) Get the array from a read-only ByteBuffer similar to ByteBuffer.array().
static int	arrayOffset(java.nio.ByteBuffer buffer) Get the array offset from a read-only ByteBuffer similar to ByteBuffer.arrayOffset().
static void	boundsCheck(byte[] buffer, long index, int length) Bounds check the access range and throw a IndexOutOfBoundsException if exceeded.
static void	boundsCheck(java.nio.ByteBuffer buffer, long index, int length) Bounds check the access range and throw a IndexOutOfBoundsException if exceeded.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_BYTES

public static final byte[] NULL_BYTES

NATIVE_BYTE_ORDER

public static final java.nio.ByteOrder NATIVE_BYTE_ORDER

ARRAY_BASE_OFFSET

public static final long ARRAY_BASE_OFFSET

BYTE_BUFFER_HB_FIELD_OFFSET

public static final long BYTE_BUFFER_HB_FIELD_OFFSET

BYTE_BUFFER_OFFSET_FIELD_OFFSET

public static final long BYTE_BUFFER_OFFSET_FIELD_OFFSET

Constructor Detail

BufferUtil

public BufferUtil()

Method Detail

boundsCheck

public static void boundsCheck(byte[] buffer,
                               long index,
                               int length)

Bounds check the access range and throw a IndexOutOfBoundsException if exceeded.

Parameters:

buffer - to be checked.

index - at which the access will begin.

length - of the range accessed.

boundsCheck

public static void boundsCheck(java.nio.ByteBuffer buffer,
                               long index,
                               int length)

Bounds check the access range and throw a IndexOutOfBoundsException if exceeded.

Parameters:

buffer - to be checked.

index - at which the access will begin.

length - of the range accessed.

address

public static long address(java.nio.ByteBuffer buffer)

Get the address at which the underlying buffer storage begins.

Parameters:

buffer - that wraps the underlying storage.

Returns:

the memory address at which the buffer storage begins.

array

public static byte[] array(java.nio.ByteBuffer buffer)

Get the array from a read-only ByteBuffer similar to ByteBuffer.array().

Parameters:

buffer - that wraps the underlying array.

Returns:

the underlying array.

arrayOffset

public static int arrayOffset(java.nio.ByteBuffer buffer)

Get the array offset from a read-only ByteBuffer similar to ByteBuffer.arrayOffset().

Parameters:

buffer - that wraps the underlying array.

Returns:

the underlying array offset at which this ByteBuffer starts.

allocateDirectAligned

public static java.nio.ByteBuffer allocateDirectAligned(int capacity,
                                                        int alignment)

Allocate a new direct ByteBuffer that is aligned on a given alignment boundary.

Parameters:

capacity - required for the buffer.

alignment - boundary at which the buffer should begin.

Returns:

a new ByteBuffer with the required alignment.

Throws:

java.lang.IllegalArgumentException - if the alignment is not a power of 2.