HeapMemory (Catalyst API Reference (1.0.0-beta1))

java.lang.Object
- net.kuujo.catalyst.buffer.util.HeapMemory

All Implemented Interfaces:

Memory
```
public class HeapMemory
extends Object
implements Memory
```
Java heap memory.

Author:

Jordan Halterman

Nested Class Summary
- Nested classes/interfaces inherited from interface net.kuujo.catalyst.buffer.util.Memory
  Memory.Util

Field Summary

Fields
Modifier and Type Field and Description

static long ARRAY_BASE_OFFSET

static long MAX_SIZE

Fields
Modifier and Type	Field and Description
`static long`	`ARRAY_BASE_OFFSET`
`static long`	`MAX_SIZE`

Constructor Summary

Constructors
Constructor and Description

HeapMemory(byte[] array, HeapMemoryAllocator allocator)

Constructors
Constructor and Description
`HeapMemory(byte[] array, HeapMemoryAllocator allocator)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`address()` Returns the memory address.
`long`	`address(long offset)` Returns the memory address for the given offset.
`static HeapMemory`	`allocate(long size)` Allocates heap memory via `HeapMemoryAllocator`.
`HeapMemoryAllocator`	`allocator()` Returns the memory allocator that allocated this memory.
`byte[]`	`array()` Returns the underlying byte array.
`void`	`clear()` Clears the memory.
`HeapMemory`	`copy()` Copies the memory to a distinct memory address.
`void`	`free()` Frees the memory.
`byte`	`getByte(long offset)` Fetches a byte from the given memory offset.
`char`	`getChar(long offset)` Fetches a character from the given memory offset.
`double`	`getDouble(long offset)` Fetches a double from the given memory offset.
`float`	`getFloat(long offset)` Fetches a float from the given memory offset.
`int`	`getInt(long offset)` Fetches an integer from the given memory offset.
`long`	`getLong(long offset)` Fetches a long from the given memory offset.
`short`	`getShort(long offset)` Fetches a short from the given memory offset.
`long`	`offset()` Returns the array base offset.
`void`	`putByte(long offset, byte b)` Stores a byte at the given memory offset.
`void`	`putChar(long offset, char c)` Stores a character at the given memory offset.
`void`	`putDouble(long offset, double d)` Stores a double at the given memory offset.
`void`	`putFloat(long offset, float f)` Stores a float at the given memory offset.
`void`	`putInt(long offset, int i)` Stores an integer at the given memory offset.
`void`	`putLong(long offset, long l)` Stores a long at the given memory offset.
`void`	`putShort(long offset, short s)` Stores a short at the given memory offset.
`HeapMemory`	`reset(byte[] array)` Resets the memory pointer.
`long`	`size()` Returns the memory count.
`sun.misc.Unsafe`	`unsafe()` Returns the native Unsafe memory object.
`static HeapMemory`	`wrap(byte[] bytes)` Wraps the given bytes in a `HeapMemory` object.

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

- Field Detail
  - ARRAY_BASE_OFFSET
```
public static final long ARRAY_BASE_OFFSET
```
  - MAX_SIZE
```
public static final long MAX_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HeapMemory
```
public HeapMemory(byte[] array,
                  HeapMemoryAllocator allocator)
```
- Method Detail
  - allocate
```
public static HeapMemory allocate(long size)
```
    Allocates heap memory via HeapMemoryAllocator.
    
    Parameters:
    
    size - The count of the memory to allocate.
    
    Returns:
    
    The allocated memory.
    
    Throws:
    
    IllegalArgumentException - If count is greater than the maximum allowed count for an array on the Java heap - Integer.MAX_VALUE - 5
  - wrap
```
public static HeapMemory wrap(byte[] bytes)
```
    Wraps the given bytes in a HeapMemory object.
    
    Parameters:
    
    bytes - The bytes to wrap.
    
    Returns:
    
    The wrapped bytes.
  - allocator
```
public HeapMemoryAllocator allocator()
```
    Description copied from interface: Memory
    
    Returns the memory allocator that allocated this memory.
    
    Specified by:
    
    allocator in interface Memory
    
    Returns:
    
    The memory allocator.
  - address
```
public final long address()
```
    Description copied from interface: Memory
    
    Returns the memory address.
    
    Specified by:
    
    address in interface Memory
    
    Returns:
    
    The memory address.
  - reset
```
public HeapMemory reset(byte[] array)
```
    Resets the memory pointer.
    
    Parameters:
    
    array - The memory array.
    
    Returns:
    
    The heap memory.
  - address
```
public final long address(long offset)
```
    Description copied from interface: Memory
    
    Returns the memory address for the given offset.
    
    Specified by:
    
    address in interface Memory
    
    Parameters:
    
    offset - The offset for which to return the address.
    
    Returns:
    
    The memory address for the given offset.
  - size
```
public long size()
```
    Description copied from interface: Memory
    
    Returns the memory count.
    
    Specified by:
    
    size in interface Memory
    
    Returns:
    
    The memory count.
  - unsafe
```
public sun.misc.Unsafe unsafe()
```
    Returns the native Unsafe memory object.
    
    Returns:
    
    The native Unsafe memory object.
  - array
```
public final byte[] array()
```
    Returns the underlying byte array.
    
    Returns:
    
    The underlying byte array.
  - offset
```
public final long offset()
```
    Returns the array base offset.
    
    Returns:
    
    The array base offset.
  - copy
```
public HeapMemory copy()
```
    Description copied from interface: Memory
    
    Copies the memory to a distinct memory address.
    
    Specified by:
    
    copy in interface Memory
    
    Returns:
    
    The copied memory descriptor.
  - getByte
```
public byte getByte(long offset)
```
    Description copied from interface: Memory
    
    Fetches a byte from the given memory offset.
    
    Specified by:
    
    getByte in interface Memory
    
    Parameters:
    
    offset - The offset from which to fetch the byte.
    
    Returns:
    
    The fetched byte.
  - getChar
```
public char getChar(long offset)
```
    Description copied from interface: Memory
    
    Fetches a character from the given memory offset.
    
    Specified by:
    
    getChar in interface Memory
    
    Parameters:
    
    offset - The offset from which to fetch the character.
    
    Returns:
    
    The fetched character.
  - getShort
```
public short getShort(long offset)
```
    Description copied from interface: Memory
    
    Fetches a short from the given memory offset.
    
    Specified by:
    
    getShort in interface Memory
    
    Parameters:
    
    offset - The offset from which to fetch the short.
    
    Returns:
    
    The fetched short.
  - getInt
```
public int getInt(long offset)
```
    Description copied from interface: Memory
    
    Fetches an integer from the given memory offset.
    
    Specified by:
    
    getInt in interface Memory
    
    Parameters:
    
    offset - The offset from which to fetch the integer.
    
    Returns:
    
    The fetched integer.
  - getLong
```
public long getLong(long offset)
```
    Description copied from interface: Memory
    
    Fetches a long from the given memory offset.
    
    Specified by:
    
    getLong in interface Memory
    
    Parameters:
    
    offset - The offset from which to fetch the long.
    
    Returns:
    
    The fetched long.
  - getFloat
```
public float getFloat(long offset)
```
    Description copied from interface: Memory
    
    Fetches a float from the given memory offset.
    
    Specified by:
    
    getFloat in interface Memory
    
    Parameters:
    
    offset - The offset from which to fetch the float.
    
    Returns:
    
    The fetched float.
  - getDouble
```
public double getDouble(long offset)
```
    Description copied from interface: Memory
    
    Fetches a double from the given memory offset.
    
    Specified by:
    
    getDouble in interface Memory
    
    Parameters:
    
    offset - The offset from which to fetch the double.
    
    Returns:
    
    The fetched double.
  - putByte
```
public void putByte(long offset,
                    byte b)
```
    Description copied from interface: Memory
    
    Stores a byte at the given memory offset.
    
    Specified by:
    
    putByte in interface Memory
    
    Parameters:
    
    offset - The offset at which to store the byte.
    
    b - The byte to store.
  - putChar
```
public void putChar(long offset,
                    char c)
```
    Description copied from interface: Memory
    
    Stores a character at the given memory offset.
    
    Specified by:
    
    putChar in interface Memory
    
    Parameters:
    
    offset - The offset at which to store the character.
    
    c - The character to store.
  - putShort
```
public void putShort(long offset,
                     short s)
```
    Description copied from interface: Memory
    
    Stores a short at the given memory offset.
    
    Specified by:
    
    putShort in interface Memory
    
    Parameters:
    
    offset - The offset at which to store the short.
    
    s - The short to store.
  - putInt
```
public void putInt(long offset,
                   int i)
```
    Description copied from interface: Memory
    
    Stores an integer at the given memory offset.
    
    Specified by:
    
    putInt in interface Memory
    
    Parameters:
    
    offset - The offset at which to store the integer.
    
    i - The integer to store.
  - putLong
```
public void putLong(long offset,
                    long l)
```
    Description copied from interface: Memory
    
    Stores a long at the given memory offset.
    
    Specified by:
    
    putLong in interface Memory
    
    Parameters:
    
    offset - The offset at which to store the long.
    
    l - The long to store.
  - putFloat
```
public void putFloat(long offset,
                     float f)
```
    Description copied from interface: Memory
    
    Stores a float at the given memory offset.
    
    Specified by:
    
    putFloat in interface Memory
    
    Parameters:
    
    offset - The offset at which to store the float.
    
    f - The float to store.
  - putDouble
```
public void putDouble(long offset,
                      double d)
```
    Description copied from interface: Memory
    
    Stores a double at the given memory offset.
    
    Specified by:
    
    putDouble in interface Memory
    
    Parameters:
    
    offset - The offset at which to store the double.
    
    d - The double to store.
  - clear
```
public void clear()
```
    Description copied from interface: Memory
    
    Clears the memory.
    
    Specified by:
    
    clear in interface Memory
  - free
```
public void free()
```
    Description copied from interface: Memory
    
    Frees the memory.
    
    Specified by:
    
    free in interface Memory

Class HeapMemory

Nested Class Summary

Nested classes/interfaces inherited from interface net.kuujo.catalyst.buffer.util.Memory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARRAY_BASE_OFFSET

MAX_SIZE

Constructor Detail

HeapMemory

Method Detail

allocate

wrap

allocator

address

reset

address

size

unsafe

array

offset

copy

getByte

getChar

getShort

getInt

getLong

getFloat

getDouble

putByte

putChar

putShort

putInt

putLong

putFloat

putDouble

clear

free