net.kuujo.catalyst.buffer.util

Interface Memory

All Known Implementing Classes:

DirectMemory, HeapMemory, MappedMemory, NativeMemory

public interface Memory

Memory allocator.

Author:

Jordan Halterman

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Memory.Util Memory utilities.

Method Summary

Modifier and Type	Method and Description
long	address() Returns the memory address.
long	address(long offset) Returns the memory address for the given offset.
MemoryAllocator	allocator() Returns the memory allocator that allocated this memory.
void	clear() Clears the memory.
Memory	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.
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.
long	size() Returns the memory count.

Method Detail

allocator

MemoryAllocator allocator()

Returns the memory allocator that allocated this memory.

Returns:

The memory allocator.

address

long address()

Returns the memory address.

Returns:

The memory address.

address

long address(long offset)

Returns the memory address for the given offset.

Parameters:

offset - The offset for which to return the address.

Returns:

The memory address for the given offset.

size

long size()

Returns the memory count.

Returns:

The memory count.

getByte

byte getByte(long offset)

Fetches a byte from the given memory offset.

Parameters:

offset - The offset from which to fetch the byte.

Returns:

The fetched byte.

getChar

char getChar(long offset)

Fetches a character from the given memory offset.

Parameters:

offset - The offset from which to fetch the character.

Returns:

The fetched character.

getShort

short getShort(long offset)

Fetches a short from the given memory offset.

Parameters:

offset - The offset from which to fetch the short.

Returns:

The fetched short.

getInt

int getInt(long offset)

Fetches an integer from the given memory offset.

Parameters:

offset - The offset from which to fetch the integer.

Returns:

The fetched integer.

getLong

long getLong(long offset)

Fetches a long from the given memory offset.

Parameters:

offset - The offset from which to fetch the long.

Returns:

The fetched long.

getFloat

float getFloat(long offset)

Fetches a float from the given memory offset.

Parameters:

offset - The offset from which to fetch the float.

Returns:

The fetched float.

getDouble

double getDouble(long offset)

Fetches a double from the given memory offset.

Parameters:

offset - The offset from which to fetch the double.

Returns:

The fetched double.

putByte

void putByte(long offset,
             byte b)

Stores a byte at the given memory offset.

Parameters:

offset - The offset at which to store the byte.

b - The byte to store.

putChar

void putChar(long offset,
             char c)

Stores a character at the given memory offset.

Parameters:

offset - The offset at which to store the character.

c - The character to store.

putShort

void putShort(long offset,
              short s)

Stores a short at the given memory offset.

Parameters:

offset - The offset at which to store the short.

s - The short to store.

putInt

void putInt(long offset,
            int i)

Stores an integer at the given memory offset.

Parameters:

offset - The offset at which to store the integer.

i - The integer to store.

putLong

void putLong(long offset,
             long l)

Stores a long at the given memory offset.

Parameters:

offset - The offset at which to store the long.

l - The long to store.

putFloat

void putFloat(long offset,
              float f)

Stores a float at the given memory offset.

Parameters:

offset - The offset at which to store the float.

f - The float to store.

putDouble

void putDouble(long offset,
               double d)

Stores a double at the given memory offset.

Parameters:

offset - The offset at which to store the double.

d - The double to store.

copy

Memory copy()

Copies the memory to a distinct memory address.

Returns:

The copied memory descriptor.

clear

void clear()

Clears the memory.

free

void free()

Frees the memory.