MappedResizeableBuffer (Agrona)

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

All Implemented Interfaces:

AutoCloseable
```
public class MappedResizeableBuffer
extends Object
implements AutoCloseable
```
Supports regular, byte ordered, and atomic (memory ordered) access to an underlying buffer.
This buffer is resizable and based upon an underlying FileChannel. The channel is not closed when the buffer is closed.
Note: The resize method is not threadsafe. Concurrent access should only occur after a successful resize.

Constructor Summary

Constructors
Constructor and Description
`MappedResizeableBuffer(FileChannel fileChannel, FileChannel.MapMode mapMode, long offset, long initialLength)` Attach a view to an off-heap memory region by address.
`MappedResizeableBuffer(FileChannel fileChannel, long offset, long initialLength)` 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(long index, int increment)` Add a value to a given index with ordered store semantics.
`long`	`addLongOrdered(long index, long increment)` Add a value to a given index with ordered store semantics.
`long`	`addressOffset()` Address offset in memory at which the mapping begins.
`void`	`boundsCheck(long index, int length)` Check that a given length of bytes is within the bounds from a given index.
`long`	`capacity()` Capacity of the buffer in bytes.
`void`	`checkLimit(long limit)` Check if limit exceeds the capacity.
`void`	`close()`
`boolean`	`compareAndSetInt(long index, int expectedValue, int updateValue)` Atomic compare and set of a long given an expected value.
`boolean`	`compareAndSetLong(long index, long expectedValue, long updateValue)` Atomic compare and set of a long given an expected value.
`FileChannel`	`fileChannel()` `FileChannel` that this buffer is mapping over.
`int`	`getAndAddInt(long index, int delta)` Atomically add a delta to a value at a location returning the previous contents.
`long`	`getAndAddLong(long index, long delta)` Atomically add a delta to a value at a location returning the previous contents.
`int`	`getAndSetInt(long index, int value)` Atomically exchange a value at a location returning the previous contents.
`long`	`getAndSetLong(long index, long value)` Atomically exchange a value at a location returning the previous contents.
`byte`	`getByte(long index)` Get the value at a given index.
`void`	`getBytes(long index, byte[] dst)` Get from the underlying buffer into a supplied byte array.
`void`	`getBytes(long index, byte[] dst, long offset, int length)` Get bytes from the underlying buffer into a supplied byte array.
`void`	`getBytes(long index, ByteBuffer dstBuffer, int length)` Get from the underlying buffer into a supplied `ByteBuffer` current `Buffer.position()`.
`byte`	`getByteVolatile(long index)` Get the value at a given index with volatile semantics.
`char`	`getChar(long index)` Get the value at a given index.
`char`	`getChar(long index, ByteOrder byteOrder)` Get the value at a given index.
`char`	`getCharVolatile(long index)` Get the value at a given index with volatile semantics.
`double`	`getDouble(long index)` Get the value at a given index.
`double`	`getDouble(long index, ByteOrder byteOrder)` Get the value at a given index.
`float`	`getFloat(long index)` Get the value at a given index.
`float`	`getFloat(long index, ByteOrder byteOrder)` Get the value at a given index.
`int`	`getInt(long index)` Get the value at a given index.
`int`	`getInt(long index, ByteOrder byteOrder)` Get the value at a given index.
`int`	`getIntVolatile(long index)` Get the value at a given index with volatile semantics.
`long`	`getLong(long index)` Get the value at a given index.
`long`	`getLong(long index, ByteOrder byteOrder)` Get the value at a given index.
`long`	`getLongVolatile(long index)` Get the value at a given index with volatile semantics.
`short`	`getShort(long index)` Get the value at a given index.
`short`	`getShort(long index, ByteOrder byteOrder)` Get the value at a given index.
`short`	`getShortVolatile(long index)` Get the value at a given index with volatile semantics.
`String`	`getStringUtf8(long offset)` Get a String from bytes encoded in UTF-8 format that is length prefixed.
`String`	`getStringUtf8(long offset, ByteOrder byteOrder)` Get a String from bytes encoded in UTF-8 format that is length prefixed.
`String`	`getStringUtf8(long offset, int length)` Get part of String from bytes encoded in UTF-8 format that is length prefixed.
`String`	`getStringWithoutLengthUtf8(long offset, int length)` Get an encoded UTF-8 String from the buffer that does not have a length prefix.
`FileChannel.MapMode`	`mapMode()` The `FileChannel.MapMode` that will be used when mapping the file.
`void`	`putByte(long index, byte value)` Put a value to a given index.
`void`	`putBytes(long index, byte[] src)` Put an array of src into the underlying buffer.
`void`	`putBytes(long index, byte[] src, long offset, int length)` Put an array into the underlying buffer.
`void`	`putBytes(long index, ByteBuffer srcBuffer, int length)` Put bytes into the underlying buffer for the view.
`void`	`putBytes(long index, ByteBuffer srcBuffer, long srcIndex, int length)` Put bytes into the underlying buffer for the view.
`void`	`putBytes(long index, DirectBuffer srcBuffer, int srcIndex, int length)` Put bytes from a source `DirectBuffer` into this `MutableDirectBuffer` at given indices.
`void`	`putByteVolatile(long index, byte value)` Put a value to a given index with volatile semantics.
`void`	`putChar(long index, char value)` Put a value to a given index.
`void`	`putChar(long index, char value, ByteOrder byteOrder)` Put a value to a given index.
`void`	`putCharVolatile(long index, char value)` Put a value to a given index with volatile semantics.
`void`	`putDouble(long index, double value)` Put a value to a given index.
`void`	`putDouble(long index, double value, ByteOrder byteOrder)` Put a value to a given index.
`void`	`putFloat(long index, float value)` Put a value to a given index.
`void`	`putFloat(long index, float value, ByteOrder byteOrder)` Put a value to a given index.
`void`	`putInt(long index, int value)` Put a value to a given index.
`void`	`putInt(long index, int value, ByteOrder byteOrder)` Put a value to a given index.
`void`	`putIntOrdered(long index, int value)` Put a value to a given index with ordered store semantics.
`void`	`putIntVolatile(long index, int value)` Put a value to a given index with volatile semantics.
`void`	`putLong(long index, long value)` Put a value to a given index.
`void`	`putLong(long index, long value, ByteOrder byteOrder)` Put a value to a given index.
`void`	`putLongOrdered(long index, long value)` Put a value to a given index with ordered store semantics.
`void`	`putLongVolatile(long index, long value)` Put a value to a given index with volatile semantics.
`void`	`putShort(long index, short value)` Put a value to a given index.
`void`	`putShort(long index, short value, ByteOrder byteOrder)` Put a value to a given index.
`void`	`putShortVolatile(long index, short value)` Put a value to a given index with volatile semantics.
`int`	`putStringUtf8(long offset, String value)` Encode a String as UTF-8 bytes to the buffer with a length prefix.
`int`	`putStringUtf8(long offset, String value, ByteOrder byteOrder)` Encode a String as UTF-8 bytes to the buffer with a length prefix.
`int`	`putStringUtf8(long offset, String value, 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(long offset, 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(long offset, String value)` Encode a String as UTF-8 bytes in the buffer without a length prefix.
`void`	`resize(long newLength)` Resize the buffer.
`void`	`setMemory(long index, int length, byte value)` Set a region of memory to a given byte value.
`String`	`toString()`
`void`	`verifyAlignment()` Verify that the underlying buffer is correctly aligned to prevent word tearing and other ordering issues.
`void`	`wrap(FileChannel fileChannel, FileChannel.MapMode mapMode, long offset, long length)` Remap the buffer based on a new file, mapping mode, offset, and a length
`void`	`wrap(FileChannel fileChannel, long offset, long length)` Remap the buffer based on a new file, offset, and a length
`void`	`wrap(long offset, long length)` Remap the buffer using the existing file based on a new offset and length

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

- Constructor Detail
  - MappedResizeableBuffer
```
public MappedResizeableBuffer(FileChannel fileChannel,
                              long offset,
                              long initialLength)
```
    Attach a view to an off-heap memory region by address. Defaults to FileChannel.MapMode.READ_WRITE.
    
    Parameters:
    
    fileChannel - the file to map
    
    offset - the offset of the file to start the mapping
    
    initialLength - of the buffer from the given address
  - MappedResizeableBuffer
```
public MappedResizeableBuffer(FileChannel fileChannel,
                              FileChannel.MapMode mapMode,
                              long offset,
                              long initialLength)
```
    Attach a view to an off-heap memory region by address.
    
    Parameters:
    
    fileChannel - the file to map
    
    mapMode - for the mapping
    
    offset - the offset of the file to start the mapping
    
    initialLength - of the buffer from the given address
- Method Detail
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - resize
```
public void resize(long newLength)
```
    Resize the buffer.
    
    Parameters:
    
    newLength - in bytes.
  - wrap
```
public void wrap(long offset,
                 long length)
```
    Remap the buffer using the existing file based on a new offset and length
    
    Parameters:
    
    offset - the offset of the file to start the mapping
    
    length - of the buffer from the given address
  - wrap
```
public void wrap(FileChannel fileChannel,
                 long offset,
                 long length)
```
    Remap the buffer based on a new file, offset, and a length
    
    Parameters:
    
    fileChannel - the file to map
    
    offset - the offset of the file to start the mapping
    
    length - of the buffer from the given address
  - wrap
```
public void wrap(FileChannel fileChannel,
                 FileChannel.MapMode mapMode,
                 long offset,
                 long length)
```
    Remap the buffer based on a new file, mapping mode, offset, and a length
    
    Parameters:
    
    fileChannel - the file to map
    
    mapMode - for the file when mapping.
    
    offset - the offset of the file to start the mapping
    
    length - of the buffer from the given address
  - addressOffset
```
public long addressOffset()
```
    Address offset in memory at which the mapping begins.
    
    Returns:
    
    the address offset in memory at which the mapping begins.
  - fileChannel
```
public FileChannel fileChannel()
```
    FileChannel that this buffer is mapping over.
    
    Returns:
    
    the FileChannel that this buffer is mapping over.
  - mapMode
```
public FileChannel.MapMode mapMode()
```
    The FileChannel.MapMode that will be used when mapping the file.
    
    Returns:
    
    FileChannel.MapMode that will be used when mapping the file.
  - setMemory
```
public void setMemory(long index,
                      int length,
                      byte value)
```
    Set a region of memory to a given byte value.
    
    Parameters:
    
    index - at which to start.
    
    length - of the run of bytes to set.
    
    value - the memory will be set to.
  - capacity
```
public long capacity()
```
    Capacity of the buffer in bytes.
    
    Returns:
    
    capacity of the buffer in bytes.
  - checkLimit
```
public void checkLimit(long limit)
```
    Check if limit exceeds the capacity.
    
    Parameters:
    
    limit - to check.
  - verifyAlignment
```
public void verifyAlignment()
```
    Verify that the underlying buffer is correctly aligned to prevent word tearing and other ordering issues.
    
    Throws:
    
    IllegalStateException - if the alignment is not correct.
  - getLong
```
public long getLong(long index,
                    ByteOrder byteOrder)
```
    Get the value at a given index.
    
    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(long index,
                    long value,
                    ByteOrder byteOrder)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    byteOrder - of the value when written.
  - getLong
```
public long getLong(long index)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putLong
```
public void putLong(long index,
                    long value)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getLongVolatile
```
public long getLongVolatile(long index)
```
    Get the value at a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putLongVolatile
```
public void putLongVolatile(long index,
                            long value)
```
    Put a value to a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - putLongOrdered
```
public void putLongOrdered(long index,
                           long value)
```
    Put a value to a given index with ordered store semantics.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - addLongOrdered
```
public long addLongOrdered(long index,
                           long increment)
```
    Add a value to a given index with ordered store semantics. Use a negative increment to decrement.
    
    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(long index,
                                 long expectedValue,
                                 long updateValue)
```
    Atomic compare and set of a long given an expected value.
    
    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(long index,
                          long value)
```
    Atomically exchange a value at a location returning the previous contents.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    Returns:
    
    previous value at the index.
  - getAndAddLong
```
public long getAndAddLong(long index,
                          long delta)
```
    Atomically add a delta to a value at a location returning the previous contents. To decrement a negative delta can be provided.
    
    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(long index,
                  ByteOrder byteOrder)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value for at a given index.
  - putInt
```
public void putInt(long index,
                   int value,
                   ByteOrder byteOrder)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    byteOrder - of the value when written.
  - getInt
```
public int getInt(long index)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putInt
```
public void putInt(long index,
                   int value)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getIntVolatile
```
public int getIntVolatile(long index)
```
    Get the value at a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putIntVolatile
```
public void putIntVolatile(long index,
                           int value)
```
    Put a value to a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - putIntOrdered
```
public void putIntOrdered(long index,
                          int value)
```
    Put a value to a given index with ordered store semantics.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - addIntOrdered
```
public int addIntOrdered(long index,
                         int increment)
```
    Add a value to a given index with ordered store semantics. Use a negative increment to decrement.
    
    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(long index,
                                int expectedValue,
                                int updateValue)
```
    Atomic compare and set of a long given an expected value.
    
    Parameters:
    
    index - in bytes for where to put.
    
    expectedValue - at to be compared.
    
    updateValue - to be exchanged.
    
    Returns:
    
    set successful or not.
  - getAndSetInt
```
public int getAndSetInt(long index,
                        int value)
```
    Atomically exchange a value at a location returning the previous contents.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    Returns:
    
    previous value at the index.
  - getAndAddInt
```
public int getAndAddInt(long index,
                        int delta)
```
    Atomically add a delta to a value at a location returning the previous contents. To decrement a negative delta can be provided.
    
    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(long index,
                        ByteOrder byteOrder)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value for at a given index.
  - putDouble
```
public void putDouble(long index,
                      double value,
                      ByteOrder byteOrder)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    byteOrder - of the value when written.
  - getDouble
```
public double getDouble(long index)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putDouble
```
public void putDouble(long index,
                      double value)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getFloat
```
public float getFloat(long index,
                      ByteOrder byteOrder)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value for at a given index.
  - putFloat
```
public void putFloat(long index,
                     float value,
                     ByteOrder byteOrder)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    byteOrder - of the value when written.
  - getFloat
```
public float getFloat(long index)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putFloat
```
public void putFloat(long index,
                     float value)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getShort
```
public short getShort(long index,
                      ByteOrder byteOrder)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value for at a given index.
  - putShort
```
public void putShort(long index,
                     short value,
                     ByteOrder byteOrder)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    byteOrder - of the value when written.
  - getShort
```
public short getShort(long index)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putShort
```
public void putShort(long index,
                     short value)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getShortVolatile
```
public short getShortVolatile(long index)
```
    Get the value at a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putShortVolatile
```
public void putShortVolatile(long index,
                             short value)
```
    Put a value to a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getByte
```
public byte getByte(long index)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putByte
```
public void putByte(long index,
                    byte value)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getByteVolatile
```
public byte getByteVolatile(long index)
```
    Get the value at a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putByteVolatile
```
public void putByteVolatile(long index,
                            byte value)
```
    Put a value to a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getBytes
```
public void getBytes(long index,
                     byte[] dst)
```
    Get from the underlying buffer into a supplied byte array. This method will try to fill the supplied byte array.
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dst - into which the dst will be copied.
  - getBytes
```
public void getBytes(long index,
                     byte[] dst,
                     long offset,
                     int length)
```
    Get bytes from the underlying buffer into a supplied byte array.
    
    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(long index,
                     ByteBuffer dstBuffer,
                     int length)
```
    Get from the underlying buffer into a supplied ByteBuffer current Buffer.position().
    The destination buffer will have its Buffer.position() advanced as a result.
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    dstBuffer - into which the bytes will be copied.
    
    length - of the supplied buffer to use.
  - putBytes
```
public void putBytes(long index,
                     byte[] src)
```
    Put an array of src into the underlying buffer.
    
    Parameters:
    
    index - in the underlying buffer to start from.
    
    src - to be copied to the underlying buffer.
  - putBytes
```
public void putBytes(long index,
                     byte[] src,
                     long offset,
                     int length)
```
    Put an array into the underlying buffer.
    
    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(long index,
                     ByteBuffer srcBuffer,
                     int length)
```
    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.
    
    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(long index,
                     ByteBuffer srcBuffer,
                     long srcIndex,
                     int length)
```
    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.
    
    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(long index,
                     DirectBuffer srcBuffer,
                     int srcIndex,
                     int length)
```
    Put bytes from a source DirectBuffer into this MutableDirectBuffer at given indices.
    
    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(long index,
                    ByteOrder byteOrder)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    byteOrder - of the value to be read.
    
    Returns:
    
    the value for at a given index.
  - putChar
```
public void putChar(long index,
                    char value,
                    ByteOrder byteOrder)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
    
    byteOrder - of the value when written.
  - getChar
```
public char getChar(long index)
```
    Get the value at a given index.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putChar
```
public void putChar(long index,
                    char value)
```
    Put a value to a given index.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getCharVolatile
```
public char getCharVolatile(long index)
```
    Get the value at a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes from which to get.
    
    Returns:
    
    the value for at a given index.
  - putCharVolatile
```
public void putCharVolatile(long index,
                            char value)
```
    Put a value to a given index with volatile semantics.
    
    Parameters:
    
    index - in bytes for where to put.
    
    value - for at a given index.
  - getStringUtf8
```
public String getStringUtf8(long offset)
```
    Get a String from bytes encoded in UTF-8 format that is length prefixed.
    
    Parameters:
    
    offset - at which the String begins.
    
    Returns:
    
    the String as represented by the UTF-8 encoded bytes.
  - getStringUtf8
```
public String getStringUtf8(long offset,
                            ByteOrder byteOrder)
```
    Get a String from bytes encoded in UTF-8 format that is length prefixed.
    
    Parameters:
    
    offset - 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 String getStringUtf8(long offset,
                            int length)
```
    Get part of String from bytes encoded in UTF-8 format that is length prefixed.
    
    Parameters:
    
    offset - 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(long offset,
                         String value)
```
    Encode a String as UTF-8 bytes to the buffer with a length prefix.
    
    Parameters:
    
    offset - 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(long offset,
                         String value,
                         ByteOrder byteOrder)
```
    Encode a String as UTF-8 bytes to the buffer with a length prefix.
    
    Parameters:
    
    offset - 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(long offset,
                         String value,
                         int maxEncodedSize)
```
    Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
    
    Parameters:
    
    offset - 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.
    
    Throws:
    
    IllegalArgumentException - if the encoded bytes are greater than maxEncodedLength.
  - putStringUtf8
```
public int putStringUtf8(long offset,
                         String value,
                         ByteOrder byteOrder,
                         int maxEncodedSize)
```
    Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
    
    Parameters:
    
    offset - 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.
    
    Throws:
    
    IllegalArgumentException - if the encoded bytes are greater than maxEncodedLength.
  - getStringWithoutLengthUtf8
```
public String getStringWithoutLengthUtf8(long offset,
                                         int length)
```
    Get an encoded UTF-8 String from the buffer that does not have a length prefix.
    
    Parameters:
    
    offset - 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(long offset,
                                      String value)
```
    Encode a String as UTF-8 bytes in the buffer without a length prefix.
    
    Parameters:
    
    offset - at which the String begins.
    
    value - of the String to be encoded.
    
    Returns:
    
    the number of bytes encoded.
  - boundsCheck
```
public void boundsCheck(long index,
                        int length)
```
    Check that a given length of bytes is within the bounds from a given index.
    
    Parameters:
    
    index - from which to check.
    
    length - in bytes of the range to check.
    
    Throws:
    
    IndexOutOfBoundsException - if the length goes outside the capacity range.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MappedResizeableBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MappedResizeableBuffer

MappedResizeableBuffer

Method Detail

close

resize

wrap

wrap

wrap

addressOffset

fileChannel

mapMode

setMemory

capacity

checkLimit

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

putBytes

putBytes

putBytes

putBytes

putBytes

getChar

putChar

getChar

putChar

getCharVolatile

putCharVolatile

getStringUtf8

getStringUtf8

getStringUtf8

putStringUtf8

putStringUtf8

putStringUtf8