HeapMemoryAccessor (hazelcast-client-protocol 1.5.0-2 API)

All Superinterfaces:

ByteAccessStrategy<Object>

All Known Subinterfaces:

ConcurrentHeapMemoryAccessor, GlobalMemoryAccessor

All Known Implementing Classes:

AlignmentAwareMemoryAccessor, StandardMemoryAccessor
```
public interface HeapMemoryAccessor
extends ByteAccessStrategy<Object>
```
Accessor of Java heap memory. Heap must be addressed as an offset from a given object's base address.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY_BOOLEAN_BASE_OFFSET` Base offset of boolean[]
`static int`	`ARRAY_BOOLEAN_INDEX_SCALE` Index scale of boolean[]
`static int`	`ARRAY_BYTE_BASE_OFFSET` Base offset of byte[]
`static int`	`ARRAY_BYTE_INDEX_SCALE` Index scale of byte[]
`static int`	`ARRAY_CHAR_BASE_OFFSET` Base offset of char[]
`static int`	`ARRAY_CHAR_INDEX_SCALE` Index scale of char[]
`static int`	`ARRAY_DOUBLE_BASE_OFFSET` Base offset of double[]
`static int`	`ARRAY_DOUBLE_INDEX_SCALE` Index scale of double[]
`static int`	`ARRAY_FLOAT_BASE_OFFSET` Base offset of float[]
`static int`	`ARRAY_FLOAT_INDEX_SCALE` Index scale of float[]
`static int`	`ARRAY_INT_BASE_OFFSET` Base offset of int[]
`static int`	`ARRAY_INT_INDEX_SCALE` Index scale of int[]
`static int`	`ARRAY_LONG_BASE_OFFSET` Base offset of long[]
`static int`	`ARRAY_LONG_INDEX_SCALE` Index scale of long[]
`static int`	`ARRAY_OBJECT_BASE_OFFSET` Base offset of any type of Object[]
`static int`	`ARRAY_OBJECT_INDEX_SCALE` Index scale of any type of Object[]
`static int`	`ARRAY_SHORT_BASE_OFFSET` Base offset of short[]
`static int`	`ARRAY_SHORT_INDEX_SCALE` Index scale of short[]

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`arrayBaseOffset(Class<?> arrayClass)` Gets the base offset of the array typed with given class.
`int`	`arrayIndexScale(Class<?> arrayClass)` Gets the index scale of the array typed with given class.
`void`	`copyMemory(Object srcObj, long srcOffset, Object destObj, long destOffset, long lengthBytes)` Copies memory from source to destination.
`boolean`	`getBoolean(Object base, long offset)` Returns the boolean value at the supplied offset from the supplied object's base address.
`byte`	`getByte(Object base, long offset)` Returns the byte value at the supplied offset from the supplied object's base address.
`char`	`getChar(Object base, long offset)` Returns the char value at the supplied offset from the supplied object's base address.
`double`	`getDouble(Object base, long offset)` Returns the double value at the supplied offset from the supplied object's base address.
`float`	`getFloat(Object base, long offset)` Returns the float value at the supplied offset from the supplied object's base address.
`int`	`getInt(Object base, long offset)` Returns the int value at the supplied offset from the supplied object's base address.
`long`	`getLong(Object base, long offset)` Returns the long value at the supplied offset from the supplied object's base address.
`Object`	`getObject(Object base, long offset)` Returns the object reference at the supplied offset from the supplied object's base address.
`short`	`getShort(Object base, long offset)` Returns the short value at the supplied offset from the supplied object's base address.
`long`	`objectFieldOffset(Field field)` Gets the offset of given field.
`void`	`putBoolean(Object base, long offset, boolean x)` Puts the supplied boolean value at the supplied offset from the supplied object's base address.
`void`	`putByte(Object base, long offset, byte x)` Puts the supplied byte value at the supplied offset from the supplied object's base address.
`void`	`putChar(Object base, long offset, char x)` Puts the supplied char value at the supplied offset from the supplied object's base address.
`void`	`putDouble(Object base, long offset, double x)` Puts the supplied double value at the supplied offset from the supplied object's base address.
`void`	`putFloat(Object base, long offset, float x)` Puts the supplied float value at the supplied offset from the supplied object's base address.
`void`	`putInt(Object base, long offset, int x)` Puts the supplied int value at the supplied offset from the supplied object's base address.
`void`	`putLong(Object base, long offset, long x)` Puts the supplied long value at the supplied offset from the supplied object's base address.
`void`	`putObject(Object base, long offset, Object x)` Puts the supplied object reference at the supplied offset from the supplied object's base address.
`void`	`putShort(Object base, long offset, short x)` Puts the supplied short value at the supplied offset from the supplied object's base address.

- Field Detail
  - ARRAY_BOOLEAN_BASE_OFFSET
```
static final int ARRAY_BOOLEAN_BASE_OFFSET
```
    Base offset of boolean[]
  - ARRAY_BYTE_BASE_OFFSET
```
static final int ARRAY_BYTE_BASE_OFFSET
```
    Base offset of byte[]
  - ARRAY_SHORT_BASE_OFFSET
```
static final int ARRAY_SHORT_BASE_OFFSET
```
    Base offset of short[]
  - ARRAY_CHAR_BASE_OFFSET
```
static final int ARRAY_CHAR_BASE_OFFSET
```
    Base offset of char[]
  - ARRAY_INT_BASE_OFFSET
```
static final int ARRAY_INT_BASE_OFFSET
```
    Base offset of int[]
  - ARRAY_FLOAT_BASE_OFFSET
```
static final int ARRAY_FLOAT_BASE_OFFSET
```
    Base offset of float[]
  - ARRAY_LONG_BASE_OFFSET
```
static final int ARRAY_LONG_BASE_OFFSET
```
    Base offset of long[]
  - ARRAY_DOUBLE_BASE_OFFSET
```
static final int ARRAY_DOUBLE_BASE_OFFSET
```
    Base offset of double[]
  - ARRAY_OBJECT_BASE_OFFSET
```
static final int ARRAY_OBJECT_BASE_OFFSET
```
    Base offset of any type of Object[]
  - ARRAY_BOOLEAN_INDEX_SCALE
```
static final int ARRAY_BOOLEAN_INDEX_SCALE
```
    Index scale of boolean[]
  - ARRAY_BYTE_INDEX_SCALE
```
static final int ARRAY_BYTE_INDEX_SCALE
```
    Index scale of byte[]
  - ARRAY_SHORT_INDEX_SCALE
```
static final int ARRAY_SHORT_INDEX_SCALE
```
    Index scale of short[]
  - ARRAY_CHAR_INDEX_SCALE
```
static final int ARRAY_CHAR_INDEX_SCALE
```
    Index scale of char[]
  - ARRAY_INT_INDEX_SCALE
```
static final int ARRAY_INT_INDEX_SCALE
```
    Index scale of int[]
  - ARRAY_FLOAT_INDEX_SCALE
```
static final int ARRAY_FLOAT_INDEX_SCALE
```
    Index scale of float[]
  - ARRAY_LONG_INDEX_SCALE
```
static final int ARRAY_LONG_INDEX_SCALE
```
    Index scale of long[]
  - ARRAY_DOUBLE_INDEX_SCALE
```
static final int ARRAY_DOUBLE_INDEX_SCALE
```
    Index scale of double[]
  - ARRAY_OBJECT_INDEX_SCALE
```
static final int ARRAY_OBJECT_INDEX_SCALE
```
    Index scale of any type of Object[]
- Method Detail
  - objectFieldOffset
```
long objectFieldOffset(Field field)
```
    Gets the offset of given field.
    
    Parameters:
    
    field - the field whose offset is requested
    
    Returns:
    
    the offset of given field
  - arrayBaseOffset
```
int arrayBaseOffset(Class<?> arrayClass)
```
    Gets the base offset of the array typed with given class.
    
    Parameters:
    
    arrayClass - the type of the array whose base offset is requested
    
    Returns:
    
    the base offset of the array typed with given class
  - arrayIndexScale
```
int arrayIndexScale(Class<?> arrayClass)
```
    Gets the index scale of the array typed with given class.
    
    Parameters:
    
    arrayClass - the type of the array whose index scale is requested
    
    Returns:
    
    the index scale of the array typed with given class
  - copyMemory
```
void copyMemory(Object srcObj,
                long srcOffset,
                Object destObj,
                long destOffset,
                long lengthBytes)
```
    Copies memory from source to destination. Source and destination addresses are specified in the form (baseObject, offset) such that the offset is added to the object's base address on Java heap.
    
    Parameters:
    
    srcObj - source object
    
    srcOffset - source offset
    
    destObj - destination object
    
    destOffset - destination offset
    
    lengthBytes - number of bytes to be copied
  - getObject
```
Object getObject(Object base,
                 long offset)
```
    Returns the object reference at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putObject
```
void putObject(Object base,
               long offset,
               Object x)
```
    Puts the supplied object reference at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getBoolean
```
boolean getBoolean(Object base,
                   long offset)
```
    Returns the boolean value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putBoolean
```
void putBoolean(Object base,
                long offset,
                boolean x)
```
    Puts the supplied boolean value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getByte
```
byte getByte(Object base,
             long offset)
```
    Returns the byte value at the supplied offset from the supplied object's base address.
    
    Specified by:
    
    getByte in interface ByteAccessStrategy<Object>
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
    
    Returns:
    
    - byte from resource
  - putByte
```
void putByte(Object base,
             long offset,
             byte x)
```
    Puts the supplied byte value at the supplied offset from the supplied object's base address.
    
    Specified by:
    
    putByte in interface ByteAccessStrategy<Object>
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getChar
```
char getChar(Object base,
             long offset)
```
    Returns the char value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putChar
```
void putChar(Object base,
             long offset,
             char x)
```
    Puts the supplied char value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getShort
```
short getShort(Object base,
               long offset)
```
    Returns the short value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putShort
```
void putShort(Object base,
              long offset,
              short x)
```
    Puts the supplied short value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getInt
```
int getInt(Object base,
           long offset)
```
    Returns the int value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putInt
```
void putInt(Object base,
            long offset,
            int x)
```
    Puts the supplied int value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getFloat
```
float getFloat(Object base,
               long offset)
```
    Returns the float value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putFloat
```
void putFloat(Object base,
              long offset,
              float x)
```
    Puts the supplied float value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getLong
```
long getLong(Object base,
             long offset)
```
    Returns the long value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putLong
```
void putLong(Object base,
             long offset,
             long x)
```
    Puts the supplied long value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written
  - getDouble
```
double getDouble(Object base,
                 long offset)
```
    Returns the double value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the object whose base address to use for the operation
    
    offset - offset from object's base to the accessed location
  - putDouble
```
void putDouble(Object base,
               long offset,
               double x)
```
    Puts the supplied double value at the supplied offset from the supplied object's base address.
    
    Parameters:
    
    base - the owner object where the referenced object will be written to
    
    offset - offset from object's base to the accessed location
    
    x - the referenced object to be written

Interface HeapMemoryAccessor

Field Summary

Method Summary

Field Detail

ARRAY_BOOLEAN_BASE_OFFSET

ARRAY_BYTE_BASE_OFFSET

ARRAY_SHORT_BASE_OFFSET

ARRAY_CHAR_BASE_OFFSET

ARRAY_INT_BASE_OFFSET

ARRAY_FLOAT_BASE_OFFSET

ARRAY_LONG_BASE_OFFSET

ARRAY_DOUBLE_BASE_OFFSET

ARRAY_OBJECT_BASE_OFFSET

ARRAY_BOOLEAN_INDEX_SCALE

ARRAY_BYTE_INDEX_SCALE

ARRAY_SHORT_INDEX_SCALE

ARRAY_CHAR_INDEX_SCALE

ARRAY_INT_INDEX_SCALE

ARRAY_FLOAT_INDEX_SCALE

ARRAY_LONG_INDEX_SCALE

ARRAY_DOUBLE_INDEX_SCALE

ARRAY_OBJECT_INDEX_SCALE

Method Detail

objectFieldOffset

arrayBaseOffset

arrayIndexScale

copyMemory

getObject

putObject

getBoolean

putBoolean

getByte

putByte

getChar

putChar

getShort

putShort

getInt

putInt

getFloat

putFloat

getLong

putLong

getDouble

putDouble