UnsafeBuffer (Agrona)

java.lang.Object
- org.agrona.concurrent.UnsafeBuffer

All Implemented Interfaces:

java.lang.Comparable<DirectBuffer>, AtomicBuffer, DirectBuffer, MutableDirectBuffer
```
public class UnsafeBuffer
extends java.lang.Object
implements AtomicBuffer
```
Supports regular, byte ordered, and atomic (memory ordered) access to an underlying buffer. The buffer can be a byte[] or one of the various ByteBuffer implementations. ByteOrder of a wrapped buffer is not applied to the UnsafeBuffer; UnsafeBuffers are stateless and can be used concurrently. To control ByteOrder use the appropriate accessor method with the ByteOrder overload. Note: This class has a natural ordering that is inconsistent with equals. Types my be different but equal on buffer contents. Note: The wrap methods on this class are not thread safe. Concurrent access should only happen after a successful wrap.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNMENT` Buffer alignment to ensure atomic word accesses.
`static java.lang.String`	`DISABLE_BOUNDS_CHECKS_PROP_NAME`
`static boolean`	`SHOULD_BOUNDS_CHECK`

Constructor Summary

Constructors
Constructor and Description
`UnsafeBuffer(byte[] buffer)` Attach a view to a byte[] for providing direct access.
`UnsafeBuffer(byte[] buffer, int offset, int length)` Attach a view to a byte[] for providing direct access.
`UnsafeBuffer(java.nio.ByteBuffer buffer)` Attach a view to a `ByteBuffer` for providing direct access, the `ByteBuffer` can be heap based or direct.
`UnsafeBuffer(java.nio.ByteBuffer buffer, int offset, int length)` Attach a view to a `ByteBuffer` for providing direct access, the `ByteBuffer` can be heap based or direct.
`UnsafeBuffer(DirectBuffer buffer)` Attach a view to an existing `DirectBuffer`
`UnsafeBuffer(DirectBuffer buffer, int offset, int length)` Attach a view to an existing `DirectBuffer`
`UnsafeBuffer(long address, int length)` Attach a view to an off-heap memory region by address.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addIntOrdered(int index, int increment)` Add a value to a given index with ordered store semantics.
`long`	`addLongOrdered(int index, long increment)` Add a value to a given index with ordered store semantics.
`long`	`addressOffset()` Reads the underlying offset to to the memory address.
`void`	`boundsCheck(int index, int length)` Check that a given length of bytes is within the bounds from a given index.
`byte[]`	`byteArray()` Get the underlying byte[] if one exists.
`java.nio.ByteBuffer`	`byteBuffer()` Get the underlying `ByteBuffer` if one exists.
`int`	`capacity()` Get the capacity of the underlying buffer.
`void`	`checkLimit(int limit)` Check that a given limit is not greater than the capacity of a buffer from a given offset.
`boolean`	`compareAndSetInt(int index, int expectedValue, int updateValue)` Atomic compare and set of a int given an expected value.
`boolean`	`compareAndSetLong(int index, long expectedValue, long updateValue)` Atomic compare and set of a long given an expected value.
`int`	`compareTo(DirectBuffer that)`
`boolean`	`equals(java.lang.Object obj)`
`int`	`getAndAddInt(int index, int delta)` Atomically add a delta to a value at a location returning the previous contents.
`long`	`getAndAddLong(int index, long delta)` Atomically add a delta to a value at a location returning the previous contents.
`int`	`getAndSetInt(int index, int value)` Atomically exchange a value at a location returning the previous contents.
`long`	`getAndSetLong(int index, long value)` Atomically exchange a value at a location returning the previous contents.
`byte`	`getByte(int index)` Get the value at a given index.
`void`	`getBytes(int index, byte[] dst)` Get from the underlying buffer into a supplied byte array.
`void`	`getBytes(int index, byte[] dst, int offset, int length)` Get bytes from the underlying buffer into a supplied byte array.
`void`	`getBytes(int index, java.nio.ByteBuffer dstBuffer, int length)` Get from the underlying buffer into a supplied `ByteBuffer` current `Buffer.position()`.
`void`	`getBytes(int index, java.nio.ByteBuffer dstBuffer, int dstOffset, int length)` Get from the underlying buffer into a supplied `ByteBuffer` at a offset.
`void`	`getBytes(int index, MutableDirectBuffer dstBuffer, int dstIndex, int length)` Get bytes from this `DirectBuffer` into the provided `MutableDirectBuffer` at given indices.
`byte`	`getByteVolatile(int index)` Get the value at a given index with volatile semantics.
`char`	`getChar(int index)` Get the value at a given index.
`char`	`getChar(int index, java.nio.ByteOrder byteOrder)` Get the value at a given index.
`char`	`getCharVolatile(int index)` Get the value at a given index with volatile semantics.
`double`	`getDouble(int index)` Get the value at a given index.
`double`	`getDouble(int index, java.nio.ByteOrder byteOrder)` Get the value at a given index.
`float`	`getFloat(int index)` Get the value at a given index.
`float`	`getFloat(int index, java.nio.ByteOrder byteOrder)` Get the value at a given index.
`int`	`getInt(int index)` Get the value at a given index.
`int`	`getInt(int index, java.nio.ByteOrder byteOrder)` Get the value at a given index.
`int`	`getIntVolatile(int index)` Get the value at a given index with volatile semantics.
`long`	`getLong(int index)` Get the value at a given index.
`long`	`getLong(int index, java.nio.ByteOrder byteOrder)` Get the value at a given index.
`long`	`getLongVolatile(int index)` Get the value at a given index with volatile semantics.
`short`	`getShort(int index)` Get the value at a given index.
`short`	`getShort(int index, java.nio.ByteOrder byteOrder)` Get the value at a given index.
`short`	`getShortVolatile(int index)` Get the value at a given index with volatile semantics.
`java.lang.String`	`getStringUtf8(int index)` Get a String from bytes encoded in UTF-8 format that is length prefixed.
`java.lang.String`	`getStringUtf8(int index, java.nio.ByteOrder byteOrder)` Get a String from bytes encoded in UTF-8 format that is length prefixed.
`java.lang.String`	`getStringUtf8(int index, int length)` Get part of String from bytes encoded in UTF-8 format that is length prefixed.
`java.lang.String`	`getStringWithoutLengthUtf8(int index, int length)` Get an encoded UTF-8 String from the buffer that does not have a length prefix.
`int`	`hashCode()`
`boolean`	`isExpandable()` Is this buffer expandable to accommodate putting data into it beyond the current capacity?
`void`	`putByte(int index, byte value)` Put a value to a given index.
`void`	`putBytes(int index, byte[] src)` Put an array of src into the underlying buffer.
`void`	`putBytes(int index, byte[] src, int offset, int length)` Put an array into the underlying buffer.
`void`	`putBytes(int index, java.nio.ByteBuffer srcBuffer, int length)` Put bytes into the underlying buffer for the view.
`void`	`putBytes(int index, java.nio.ByteBuffer srcBuffer, int srcIndex, int length)` Put bytes into the underlying buffer for the view.
`void`	`putBytes(int index, DirectBuffer srcBuffer, int srcIndex, int length)` Put bytes from a source `DirectBuffer` into this `MutableDirectBuffer` at given indices.
`void`	`putByteVolatile(int index, byte value)` Put a value to a given index with volatile semantics.
`void`	`putChar(int index, char value)` Put a value to a given index.
`void`	`putChar(int index, char value, java.nio.ByteOrder byteOrder)` Put a value to a given index.
`void`	`putCharVolatile(int index, char value)` Put a value to a given index with volatile semantics.
`void`	`putDouble(int index, double value)` Put a value to a given index.
`void`	`putDouble(int index, double value, java.nio.ByteOrder byteOrder)` Put a value to a given index.
`void`	`putFloat(int index, float value)` Put a value to a given index.
`void`	`putFloat(int index, float value, java.nio.ByteOrder byteOrder)` Put a value to a given index.
`void`	`putInt(int index, int value)` Put a value to a given index.
`void`	`putInt(int index, int value, java.nio.ByteOrder byteOrder)` Put a value to a given index.
`void`	`putIntOrdered(int index, int value)` Put a value to a given index with ordered semantics.
`void`	`putIntVolatile(int index, int value)` Put a value to a given index with volatile semantics.
`void`	`putLong(int index, long value)` Put a value to a given index.
`void`	`putLong(int index, long value, java.nio.ByteOrder byteOrder)` Put a value to a given index.
`void`	`putLongOrdered(int index, long value)` Put a value to a given index with ordered store semantics.
`void`	`putLongVolatile(int index, long value)` Put a value to a given index with volatile semantics.
`void`	`putShort(int index, short value)` Put a value to a given index.
`void`	`putShort(int index, short value, java.nio.ByteOrder byteOrder)` Put a value to a given index.
`void`	`putShortVolatile(int index, short value)` Put a value to a given index with volatile semantics.
`int`	`putStringUtf8(int index, java.lang.String value)` Encode a String as UTF-8 bytes to the buffer with a length prefix.
`int`	`putStringUtf8(int index, java.lang.String value, java.nio.ByteOrder byteOrder)` Encode a String as UTF-8 bytes to the buffer with a length prefix.
`int`	`putStringUtf8(int index, java.lang.String value, java.nio.ByteOrder byteOrder, int maxEncodedSize)` Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
`int`	`putStringUtf8(int index, java.lang.String value, int maxEncodedSize)` Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
`int`	`putStringWithoutLengthUtf8(int index, java.lang.String value)` Encode a String as UTF-8 bytes in the buffer without a length prefix.
`void`	`setMemory(int index, int length, byte value)` Set a region of memory to a given byte value.
`void`	`verifyAlignment()` Verify that the underlying buffer is correctly aligned to prevent word tearing and other ordering issues.
`void`	`wrap(byte[] buffer)` Attach a view to a byte[] for providing direct access.
`void`	`wrap(byte[] buffer, int offset, int length)` Attach a view to a byte[] for providing direct access.
`void`	`wrap(java.nio.ByteBuffer buffer)` Attach a view to a `ByteBuffer` for providing direct access, the `ByteBuffer` can be heap based or direct.
`void`	`wrap(java.nio.ByteBuffer buffer, int offset, int length)` Attach a view to a `ByteBuffer` for providing direct access.
`void`	`wrap(DirectBuffer buffer)` Attach a view to an existing `DirectBuffer`
`void`	`wrap(DirectBuffer buffer, int offset, int length)` Attach a view to a `DirectBuffer` for providing direct access.
`void`	`wrap(long address, int length)` Attach a view to an off-heap memory region by address.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ALIGNMENT
```
public static final int ALIGNMENT
```
    Buffer alignment to ensure atomic word accesses.
    
    See Also:
    
    Constant Field Values
  - DISABLE_BOUNDS_CHECKS_PROP_NAME
```
public static final java.lang.String DISABLE_BOUNDS_CHECKS_PROP_NAME
```
    See Also:
    
    Constant Field Values
  - SHOULD_BOUNDS_CHECK
```
public static final boolean SHOULD_BOUNDS_CHECK
```
- Constructor Detail
  - UnsafeBuffer
```
public UnsafeBuffer(byte[] buffer)
```
    Attach a view to a byte[] for providing direct access.
    
    Parameters:
    
    buffer - to which the view is attached.
  - UnsafeBuffer
```
public UnsafeBuffer(byte[] buffer,
                    int offset,
                    int length)
```
    Attach a view to a byte[] for providing direct access.
    
    Parameters:
    
    buffer - to which the view is attached.
    
    offset - within the buffer to begin.
    
    length - of the buffer to be included.
  - UnsafeBuffer
```
public UnsafeBuffer(java.nio.ByteBuffer buffer)
```
    Attach a view to a ByteBuffer for providing direct access, the ByteBuffer can be heap based or direct.
    
    Parameters:
    
    buffer - to which the view is attached.
  - UnsafeBuffer
```
public UnsafeBuffer(java.nio.ByteBuffer buffer,
                    int offset,
                    int length)
```
    Attach a view to a ByteBuffer for providing direct access, the ByteBuffer can be heap based or direct.
    
    Parameters:
    
    buffer - to which the view is attached.
    
    offset - within the buffer to begin.
    
    length - of the buffer to be included.
  - UnsafeBuffer
```
public UnsafeBuffer(DirectBuffer buffer)
```
    Attach a view to an existing DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
  - UnsafeBuffer
```
public UnsafeBuffer(DirectBuffer buffer,
                    int offset,
                    int length)
```
    Attach a view to an existing DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
    
    offset - within the buffer to begin.
    
    length - of the buffer to be included.
  - UnsafeBuffer
```
public UnsafeBuffer(long address,
                    int length)
```
    Attach a view to an off-heap memory region by address.
    
    Parameters:
    
    address - where the memory begins off-heap
    
    length - of the buffer from the given address
- Method Detail
  - wrap
```
public void wrap(byte[] buffer)
```
    Description copied from interface: DirectBuffer
    
    Attach a view to a byte[] for providing direct access.
    
    Specified by:
    
    wrap in interface DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
  - wrap
```
public void wrap(byte[] buffer,
                 int offset,
                 int length)
```
    Description copied from interface: DirectBuffer
    
    Attach a view to a byte[] for providing direct access.
    
    Specified by:
    
    wrap in interface DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
    
    offset - at which the view begins.
    
    length - of the buffer included in the view
  - wrap
```
public void wrap(java.nio.ByteBuffer buffer)
```
    Description copied from interface: DirectBuffer
    
    Attach a view to a ByteBuffer for providing direct access, the ByteBuffer can be heap based or direct.
    
    Specified by:
    
    wrap in interface DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
  - wrap
```
public void wrap(java.nio.ByteBuffer buffer,
                 int offset,
                 int length)
```
    Description copied from interface: DirectBuffer
    
    Attach a view to a ByteBuffer for providing direct access.
    
    Specified by:
    
    wrap in interface DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
    
    offset - at which the view begins.
    
    length - of the buffer included in the view
  - wrap
```
public void wrap(DirectBuffer buffer)
```
    Description copied from interface: DirectBuffer
    
    Attach a view to an existing DirectBuffer
    
    Specified by:
    
    wrap in interface DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
  - wrap
```
public void wrap(DirectBuffer buffer,
                 int offset,
                 int length)
```
    Description copied from interface: DirectBuffer
    
    Attach a view to a DirectBuffer for providing direct access.
    
    Specified by:
    
    wrap in interface DirectBuffer
    
    Parameters:
    
    buffer - to which the view is attached.
    
    offset - at which the view begins.
    
    length - of the buffer included in the view
  - wrap
```
public void wrap(long address,
                 int length)
```
    Description copied from interface: DirectBuffer
    
    Attach a view to an off-heap memory region by address.
    
    Specified by:
    
    wrap in interface DirectBuffer
    
    Parameters:
    
    address - where the memory begins off-heap
    
    length - of the buffer from the given address
  - addressOffset
```
public long addressOffset()
```
    Description copied from interface: DirectBuffer
    
    Reads the underlying offset to to the memory address.
    
    Specified by:
    
    addressOffset in interface DirectBuffer
    
    Returns:
    
    the underlying offset to to the memory address.
  - byteArray
```
public byte[] byteArray()
```
    Description copied from interface: DirectBuffer
    
    Get the underlying byte[] if one exists.
    
    Specified by:
    
    byteArray in interface DirectBuffer
    
    Returns:
    
    the underlying byte[] if one exists.
  - byteBuffer
```
public java.nio.ByteBuffer byteBuffer()
```
    Description copied from interface: DirectBuffer
    
    Get the underlying ByteBuffer if one exists.
    
    Specified by:
    
    byteBuffer in interface DirectBuffer
    
    Returns:
    
    the underlying ByteBuffer if one exists.
  - setMemory
```
public void setMemory(int index,
                      int length,
                      byte value)
```
    Description copied from interface: MutableDirectBuffer
    
    Set a region of memory to a given byte value.
    
    Specified by:
    
    setMemory in interface MutableDirectBuffer
    
    Parameters:
    
    index - at which to start.
    
    length - of the run of bytes to set.
    
    value - the memory will be set to.
  - capacity
```
public int capacity()
```
    Description copied from interface: DirectBuffer
    
    Get the capacity of the underlying buffer.
    
    Specified by:
    
    capacity in interface DirectBuffer
    
    Returns:
    
    the capacity of the underlying buffer in bytes.
  - checkLimit
```
public void checkLimit(int limit)
```
    Description copied from interface: DirectBuffer
    
    Check that a given limit is not greater than the capacity of a buffer from a given offset.
    Can be overridden in a DirectBuffer subclass to enable an extensible buffer or handle retry after a flush.
    
    Specified by:
    
    checkLimit in interface DirectBuffer
    
    Parameters:
    
    limit - up to which access is required.
  - isExpandable
```
public boolean isExpandable()
```
    Description copied from interface: MutableDirectBuffer
    
    Is this buffer expandable to accommodate putting data into it beyond the current capacity?
    
    Specified by:
    
    isExpandable in interface MutableDirectBuffer
    
    Returns:
    
    true is the underlying storage can expand otherwise false.
  - verifyAlignment
```
public void verifyAlignment()
```
    Description copied from interface: AtomicBuffer
    
    Verify that the underlying buffer is correctly aligned to prevent word tearing and other ordering issues.
    
    Specified by:
    
    verifyAlignment in interface AtomicBuffer
  - getLong
```
public long getLong(int index,
                    java.nio.ByteOrder byteOrder)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getLong in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value for at a given index
  - putLong
```
public void putLong(int index,
                    long value,
                    java.nio.ByteOrder byteOrder)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putLong in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
    
    byteOrder - of the value when written
  - getLong
```
public long getLong(int index)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getLong in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - putLong
```
public void putLong(int index,
                    long value)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putLong in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - getLongVolatile
```
public long getLongVolatile(int index)
```
    Description copied from interface: AtomicBuffer
    
    Get the value at a given index with volatile semantics.
    
    Specified by:
    
    getLongVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - putLongVolatile
```
public void putLongVolatile(int index,
                            long value)
```
    Description copied from interface: AtomicBuffer
    
    Put a value to a given index with volatile semantics.
    
    Specified by:
    
    putLongVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - putLongOrdered
```
public void putLongOrdered(int index,
                           long value)
```
    Description copied from interface: AtomicBuffer
    
    Put a value to a given index with ordered store semantics.
    
    Specified by:
    
    putLongOrdered in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - addLongOrdered
```
public long addLongOrdered(int index,
                           long increment)
```
    Description copied from interface: AtomicBuffer
    
    Add a value to a given index with ordered store semantics. Use a negative increment to decrement.
    
    Specified by:
    
    addLongOrdered in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    increment - by which the value at the index will be adjusted.
    
    Returns:
    
    the previous value at the index
  - compareAndSetLong
```
public boolean compareAndSetLong(int index,
                                 long expectedValue,
                                 long updateValue)
```
    Description copied from interface: AtomicBuffer
    
    Atomic compare and set of a long given an expected value.
    
    Specified by:
    
    compareAndSetLong in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    expectedValue - at to be compared
    
    updateValue - to be exchanged
    
    Returns:
    
    set successful or not
  - getAndSetLong
```
public long getAndSetLong(int index,
                          long value)
```
    Description copied from interface: AtomicBuffer
    
    Atomically exchange a value at a location returning the previous contents.
    
    Specified by:
    
    getAndSetLong in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
    
    Returns:
    
    previous value at the index
  - getAndAddLong
```
public long getAndAddLong(int index,
                          long delta)
```
    Description copied from interface: AtomicBuffer
    
    Atomically add a delta to a value at a location returning the previous contents. To decrement a negative delta can be provided.
    
    Specified by:
    
    getAndAddLong in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    delta - to be added to the value at the index
    
    Returns:
    
    previous value
  - getInt
```
public int getInt(int index,
                  java.nio.ByteOrder byteOrder)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getInt in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value at a given index.
  - putInt
```
public void putInt(int index,
                   int value,
                   java.nio.ByteOrder byteOrder)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putInt in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
    
    byteOrder - of the value when written
  - getInt
```
public int getInt(int index)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getInt in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - putInt
```
public void putInt(int index,
                   int value)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putInt in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - getIntVolatile
```
public int getIntVolatile(int index)
```
    Description copied from interface: AtomicBuffer
    
    Get the value at a given index with volatile semantics.
    
    Specified by:
    
    getIntVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - putIntVolatile
```
public void putIntVolatile(int index,
                           int value)
```
    Description copied from interface: AtomicBuffer
    
    Put a value to a given index with volatile semantics.
    
    Specified by:
    
    putIntVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - putIntOrdered
```
public void putIntOrdered(int index,
                          int value)
```
    Description copied from interface: AtomicBuffer
    
    Put a value to a given index with ordered semantics.
    
    Specified by:
    
    putIntOrdered in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - addIntOrdered
```
public int addIntOrdered(int index,
                         int increment)
```
    Description copied from interface: AtomicBuffer
    
    Add a value to a given index with ordered store semantics. Use a negative increment to decrement.
    
    Specified by:
    
    addIntOrdered in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    increment - by which the value at the index will be adjusted.
    
    Returns:
    
    the previous value at the index
  - compareAndSetInt
```
public boolean compareAndSetInt(int index,
                                int expectedValue,
                                int updateValue)
```
    Description copied from interface: AtomicBuffer
    
    Atomic compare and set of a int given an expected value.
    
    Specified by:
    
    compareAndSetInt in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    expectedValue - at to be compared
    
    updateValue - to be exchanged
    
    Returns:
    
    successful or not
  - getAndSetInt
```
public int getAndSetInt(int index,
                        int value)
```
    Description copied from interface: AtomicBuffer
    
    Atomically exchange a value at a location returning the previous contents.
    
    Specified by:
    
    getAndSetInt in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
    
    Returns:
    
    previous value
  - getAndAddInt
```
public int getAndAddInt(int index,
                        int delta)
```
    Description copied from interface: AtomicBuffer
    
    Atomically add a delta to a value at a location returning the previous contents. To decrement a negative delta can be provided.
    
    Specified by:
    
    getAndAddInt in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    delta - to be added to the value at the index
    
    Returns:
    
    previous value
  - getDouble
```
public double getDouble(int index,
                        java.nio.ByteOrder byteOrder)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getDouble in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value at a given index.
  - putDouble
```
public void putDouble(int index,
                      double value,
                      java.nio.ByteOrder byteOrder)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putDouble in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
    
    byteOrder - of the value when written.
  - getDouble
```
public double getDouble(int index)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getDouble in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - putDouble
```
public void putDouble(int index,
                      double value)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putDouble in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
  - getFloat
```
public float getFloat(int index,
                      java.nio.ByteOrder byteOrder)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getFloat in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value at a given index.
  - putFloat
```
public void putFloat(int index,
                     float value,
                     java.nio.ByteOrder byteOrder)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putFloat in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
    
    byteOrder - of the value when written.
  - getFloat
```
public float getFloat(int index)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getFloat in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - putFloat
```
public void putFloat(int index,
                     float value)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putFloat in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
  - getShort
```
public short getShort(int index,
                      java.nio.ByteOrder byteOrder)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getShort in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value at a given index.
  - putShort
```
public void putShort(int index,
                     short value,
                     java.nio.ByteOrder byteOrder)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putShort in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
    
    byteOrder - of the value when written.
  - getShort
```
public short getShort(int index)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getShort in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - putShort
```
public void putShort(int index,
                     short value)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putShort in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
  - getShortVolatile
```
public short getShortVolatile(int index)
```
    Description copied from interface: AtomicBuffer
    
    Get the value at a given index with volatile semantics.
    
    Specified by:
    
    getShortVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - putShortVolatile
```
public void putShortVolatile(int index,
                             short value)
```
    Description copied from interface: AtomicBuffer
    
    Put a value to a given index with volatile semantics.
    
    Specified by:
    
    putShortVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - getByte
```
public byte getByte(int index)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getByte in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - putByte
```
public void putByte(int index,
                    byte value)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putByte in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
  - getByteVolatile
```
public byte getByteVolatile(int index)
```
    Description copied from interface: AtomicBuffer
    
    Get the value at a given index with volatile semantics.
    
    Specified by:
    
    getByteVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - putByteVolatile
```
public void putByteVolatile(int index,
                            byte value)
```
    Description copied from interface: AtomicBuffer
    
    Put a value to a given index with volatile semantics.
    
    Specified by:
    
    putByteVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - getBytes
```
public void getBytes(int index,
                     byte[] dst)
```
    Description copied from interface: DirectBuffer
    
    Get from the underlying buffer into a supplied byte array. This method will try to fill the supplied byte array.
    
    Specified by:
    
    getBytes in interface DirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dst - into which the dst will be copied.
  - getBytes
```
public void getBytes(int index,
                     byte[] dst,
                     int offset,
                     int length)
```
    Description copied from interface: DirectBuffer
    
    Get bytes from the underlying buffer into a supplied byte array.
    
    Specified by:
    
    getBytes in interface DirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dst - into which the bytes will be copied.
    
    offset - in the supplied buffer to start the copy
    
    length - of the supplied buffer to use.
  - getBytes
```
public void getBytes(int index,
                     MutableDirectBuffer dstBuffer,
                     int dstIndex,
                     int length)
```
    Description copied from interface: DirectBuffer
    
    Get bytes from this DirectBuffer into the provided MutableDirectBuffer at given indices.
    
    Specified by:
    
    getBytes in interface DirectBuffer
    
    Parameters:
    
    index - in this buffer to begin getting the bytes.
    
    dstBuffer - to which the bytes will be copied.
    
    dstIndex - in the channel buffer to which the byte copy will begin.
    
    length - of the bytes to be copied.
  - getBytes
```
public void getBytes(int index,
                     java.nio.ByteBuffer dstBuffer,
                     int length)
```
    Description copied from interface: DirectBuffer
    
    Get from the underlying buffer into a supplied ByteBuffer current Buffer.position(). The destination buffer will have its Buffer.position() advanced as a result.
    
    Specified by:
    
    getBytes in interface DirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dstBuffer - into which the bytes will be copied.
    
    length - of the supplied buffer to use.
  - getBytes
```
public void getBytes(int index,
                     java.nio.ByteBuffer dstBuffer,
                     int dstOffset,
                     int length)
```
    Description copied from interface: DirectBuffer
    
    Get from the underlying buffer into a supplied ByteBuffer at a offset. The destination buffer will not have its Buffer.position() advanced as a result.
    
    Specified by:
    
    getBytes in interface DirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dstBuffer - into which the bytes will be copied.
    
    dstOffset - in the target buffer.
    
    length - of the supplied buffer to use.
  - putBytes
```
public void putBytes(int index,
                     byte[] src)
```
    Description copied from interface: MutableDirectBuffer
    
    Put an array of src into the underlying buffer.
    
    Specified by:
    
    putBytes in interface MutableDirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    src - to be copied to the underlying buffer.
  - putBytes
```
public void putBytes(int index,
                     byte[] src,
                     int offset,
                     int length)
```
    Description copied from interface: MutableDirectBuffer
    
    Put an array into the underlying buffer.
    
    Specified by:
    
    putBytes in interface MutableDirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    src - to be copied to the underlying buffer.
    
    offset - in the supplied buffer to begin the copy.
    
    length - of the supplied buffer to copy.
  - putBytes
```
public void putBytes(int index,
                     java.nio.ByteBuffer srcBuffer,
                     int length)
```
    Description copied from interface: MutableDirectBuffer
    
    Put bytes into the underlying buffer for the view. Bytes will be copied from current Buffer.position() for a given length. The source buffer will have its Buffer.position() advanced as a result.
    
    Specified by:
    
    putBytes in interface MutableDirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    srcBuffer - to copy the bytes from.
    
    length - of the supplied buffer to copy.
  - putBytes
```
public void putBytes(int index,
                     java.nio.ByteBuffer srcBuffer,
                     int srcIndex,
                     int length)
```
    Description copied from interface: MutableDirectBuffer
    
    Put bytes into the underlying buffer for the view. Bytes will be copied from the buffer index to the buffer index + length. The source buffer will not have its Buffer.position() advanced as a result.
    
    Specified by:
    
    putBytes in interface MutableDirectBuffer
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    srcBuffer - to copy the bytes from (does not change position).
    
    srcIndex - in the source buffer from which the copy will begin.
    
    length - of the bytes to be copied.
  - putBytes
```
public void putBytes(int index,
                     DirectBuffer srcBuffer,
                     int srcIndex,
                     int length)
```
    Description copied from interface: MutableDirectBuffer
    
    Put bytes from a source DirectBuffer into this MutableDirectBuffer at given indices.
    
    Specified by:
    
    putBytes in interface MutableDirectBuffer
    
    Parameters:
    
    index - in this buffer to begin putting the bytes.
    
    srcBuffer - from which the bytes will be copied.
    
    srcIndex - in the source buffer from which the byte copy will begin.
    
    length - of the bytes to be copied.
  - getChar
```
public char getChar(int index,
                    java.nio.ByteOrder byteOrder)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getChar in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value at a given index.
  - putChar
```
public void putChar(int index,
                    char value,
                    java.nio.ByteOrder byteOrder)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putChar in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
    
    byteOrder - of the value when written.
  - getChar
```
public char getChar(int index)
```
    Description copied from interface: DirectBuffer
    
    Get the value at a given index.
    
    Specified by:
    
    getChar in interface DirectBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value at a given index.
  - putChar
```
public void putChar(int index,
                    char value)
```
    Description copied from interface: MutableDirectBuffer
    
    Put a value to a given index.
    
    Specified by:
    
    putChar in interface MutableDirectBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - to be written
  - getCharVolatile
```
public char getCharVolatile(int index)
```
    Description copied from interface: AtomicBuffer
    
    Get the value at a given index with volatile semantics.
    
    Specified by:
    
    getCharVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index
  - putCharVolatile
```
public void putCharVolatile(int index,
                            char value)
```
    Description copied from interface: AtomicBuffer
    
    Put a value to a given index with volatile semantics.
    
    Specified by:
    
    putCharVolatile in interface AtomicBuffer
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index
  - getStringUtf8
```
public java.lang.String getStringUtf8(int index)
```
    Description copied from interface: DirectBuffer
    
    Get a String from bytes encoded in UTF-8 format that is length prefixed.
    
    Specified by:
    
    getStringUtf8 in interface DirectBuffer
    
    Parameters:
    
    index - at which the String begins.
    
    Returns:
    
    the String as represented by the UTF-8 encoded bytes.
  - getStringUtf8
```
public java.lang.String getStringUtf8(int index,
                                      java.nio.ByteOrder byteOrder)
```
    Description copied from interface: DirectBuffer
    
    Get a String from bytes encoded in UTF-8 format that is length prefixed.
    
    Specified by:
    
    getStringUtf8 in interface DirectBuffer
    
    Parameters:
    
    index - at which the String begins.
    
    byteOrder - for the length at the beginning of the String.
    
    Returns:
    
    the String as represented by the UTF-8 encoded bytes.
  - getStringUtf8
```
public java.lang.String getStringUtf8(int index,
                                      int length)
```
    Description copied from interface: DirectBuffer
    
    Get part of String from bytes encoded in UTF-8 format that is length prefixed.
    
    Specified by:
    
    getStringUtf8 in interface DirectBuffer
    
    Parameters:
    
    index - at which the String begins.
    
    length - of the String in bytes to decode.
    
    Returns:
    
    the String as represented by the UTF-8 encoded bytes.
  - putStringUtf8
```
public int putStringUtf8(int index,
                         java.lang.String value)
```
    Description copied from interface: MutableDirectBuffer
    
    Encode a String as UTF-8 bytes to the buffer with a length prefix.
    
    Specified by:
    
    putStringUtf8 in interface MutableDirectBuffer
    
    Parameters:
    
    index - at which the String should be encoded.
    
    value - of the String to be encoded.
    
    Returns:
    
    the number of bytes put to the buffer.
  - putStringUtf8
```
public int putStringUtf8(int index,
                         java.lang.String value,
                         java.nio.ByteOrder byteOrder)
```
    Description copied from interface: MutableDirectBuffer
    
    Encode a String as UTF-8 bytes to the buffer with a length prefix.
    
    Specified by:
    
    putStringUtf8 in interface MutableDirectBuffer
    
    Parameters:
    
    index - at which the String should be encoded.
    
    value - of the String to be encoded.
    
    byteOrder - for the length prefix.
    
    Returns:
    
    the number of bytes put to the buffer.
  - putStringUtf8
```
public int putStringUtf8(int index,
                         java.lang.String value,
                         int maxEncodedSize)
```
    Description copied from interface: MutableDirectBuffer
    
    Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
    
    Specified by:
    
    putStringUtf8 in interface MutableDirectBuffer
    
    Parameters:
    
    index - at which the String should be encoded.
    
    value - of the String to be encoded.
    
    maxEncodedSize - to be checked before writing to the buffer.
    
    Returns:
    
    the number of bytes put to the buffer.
  - putStringUtf8
```
public int putStringUtf8(int index,
                         java.lang.String value,
                         java.nio.ByteOrder byteOrder,
                         int maxEncodedSize)
```
    Description copied from interface: MutableDirectBuffer
    
    Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
    
    Specified by:
    
    putStringUtf8 in interface MutableDirectBuffer
    
    Parameters:
    
    index - at which the String should be encoded.
    
    value - of the String to be encoded.
    
    byteOrder - for the length prefix.
    
    maxEncodedSize - to be checked before writing to the buffer.
    
    Returns:
    
    the number of bytes put to the buffer.
  - getStringWithoutLengthUtf8
```
public java.lang.String getStringWithoutLengthUtf8(int index,
                                                   int length)
```
    Description copied from interface: DirectBuffer
    
    Get an encoded UTF-8 String from the buffer that does not have a length prefix.
    
    Specified by:
    
    getStringWithoutLengthUtf8 in interface DirectBuffer
    
    Parameters:
    
    index - at which the String begins.
    
    length - of the String in bytes to decode.
    
    Returns:
    
    the String as represented by the UTF-8 encoded bytes.
  - putStringWithoutLengthUtf8
```
public int putStringWithoutLengthUtf8(int index,
                                      java.lang.String value)
```
    Description copied from interface: MutableDirectBuffer
    
    Encode a String as UTF-8 bytes in the buffer without a length prefix.
    
    Specified by:
    
    putStringWithoutLengthUtf8 in interface MutableDirectBuffer
    
    Parameters:
    
    index - at which the String begins.
    
    value - of the String to be encoded.
    
    Returns:
    
    the number of bytes encoded.
  - boundsCheck
```
public void boundsCheck(int index,
                        int length)
```
    Description copied from interface: DirectBuffer
    
    Check that a given length of bytes is within the bounds from a given index.
    
    Specified by:
    
    boundsCheck in interface DirectBuffer
    
    Parameters:
    
    index - from which to check.
    
    length - in bytes of the range to check.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(DirectBuffer that)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<DirectBuffer>

Class UnsafeBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALIGNMENT

DISABLE_BOUNDS_CHECKS_PROP_NAME

SHOULD_BOUNDS_CHECK

Constructor Detail

UnsafeBuffer

UnsafeBuffer

UnsafeBuffer

UnsafeBuffer

UnsafeBuffer

UnsafeBuffer

UnsafeBuffer

Method Detail

wrap

wrap

wrap

wrap

wrap

wrap

wrap

addressOffset

byteArray

byteBuffer

setMemory

capacity

checkLimit

isExpandable

verifyAlignment

getLong

putLong

getLong

putLong

getLongVolatile

putLongVolatile

putLongOrdered

addLongOrdered

compareAndSetLong

getAndSetLong

getAndAddLong

getInt

putInt

getInt

putInt

getIntVolatile

putIntVolatile

putIntOrdered

addIntOrdered

compareAndSetInt

getAndSetInt

getAndAddInt

getDouble

putDouble

getDouble

putDouble

getFloat

putFloat

getFloat

putFloat

getShort

putShort

getShort

putShort

getShortVolatile

putShortVolatile

getByte

putByte

getByteVolatile

putByteVolatile

getBytes

getBytes

getBytes

getBytes

getBytes

putBytes

putBytes