com.alexkasko.unsafe.offheapstruct

Interface OffHeapStructCollection

All Superinterfaces:

Iterable<byte[]>, OffHeapDisposable, OffHeapDisposableIterable<byte[]>

All Known Implementing Classes:

OffHeapStructArray, OffHeapStructArrayList

public interface OffHeapStructCollection
extends OffHeapDisposableIterable<byte[]>

Base interface for off-heap struct (memory areas of equal sizes) collection.

Author:

alexkasko Date: 7/3/13

Method Summary

Methods

Modifier and Type	Method and Description
void	get(long index, byte[] buffer) Copies struct on specified index into specified buffer
void	get(long index, int srcPos, byte[] dest, int destPos, int length) Copies struct part on specified index into specified buffer
byte	getByte(long index, int offset) Gets byte from struct on specified index with specified offset
int	getInt(long index, int offset) Gets four bytes as int from struct on specified index with specified offset
long	getLong(long index, int offset) Gets long from struct on specified index with specified offset
short	getShort(long index, int offset) Gets two bytes as short from struct on specified index with specified offset
short	getUnsignedByte(long index, int offset) Gets one byte (stored as one signed byte) from struct on specified index with specified offset, converts it to unsigned and returns it as short
long	getUnsignedInt(long index, int offset) Gets unsigned int (stored as 4 bytes) and returns it as long from struct on specified index with specified offset
int	getUnsignedShort(long index, int offset) Gets unsigned short (stored as two bytes) from struct on specified index with specified offset and returns it as int
void	putByte(long index, int offset, byte value) Puts byte into struct onto specified index with specified offset
void	putInt(long index, int offset, int value) Puts int into struct onto specified index with specified offset as four bytes
void	putLong(long index, int offset, long value) Puts long into struct onto specified index with specified offset as eight bytes
void	putShort(long index, int offset, short value) Puts short into struct onto specified index with specified offset as two bytes
void	putUnsignedByte(long index, int offset, short value) Puts short with value from 0 to 255 inclusive into struct onto specified index with specified offset as one signed byte
void	putUnsignedInt(long index, int offset, long value) Puts long value from 0 to 4294967295 inclusive into struct onto specified index with specified offset as four bytes
void	putUnsignedShort(long index, int offset, int value) Puts int with value from 0 to 65535 inclusive into struct onto specified index with specified offset as two bytes
void	set(long index, byte[] struct) Copies specified struct contents onto specified index
long	size() Returns number of elements in this array
int	structLength() Returns length of the single struct in bytes

Methods inherited from interface com.alexkasko.unsafe.offheap.OffHeapDisposableIterable

iterator

Methods inherited from interface com.alexkasko.unsafe.offheap.OffHeapDisposable

free

Method Detail

structLength

int structLength()

Returns length of the single struct in bytes

Returns:

length of the single struct in bytes

size

long size()

Returns number of elements in this array

Returns:

number of elements in this array

get

void get(long index,
       byte[] buffer)

Copies struct on specified index into specified buffer

Parameters:

index - array index

buffer - buffer to copy struct into

get

void get(long index,
       int srcPos,
       byte[] dest,
       int destPos,
       int length)

Copies struct part on specified index into specified buffer

Parameters:

index - array index

srcPos - struct position in collection

dest - buffer to copy struct into

destPos - position in buffer

length - number of bytes to copy

set

void set(long index,
       byte[] struct)

Copies specified struct contents onto specified index

Parameters:

index - array index

struct - struct to copy into array

getByte

byte getByte(long index,
           int offset)

Gets byte from struct on specified index with specified offset

Parameters:

index - array index

offset - byte array index

Returns:

byte

putByte

void putByte(long index,
           int offset,
           byte value)

Puts byte into struct onto specified index with specified offset

Parameters:

index - array index

offset - byte array index

value - value

getUnsignedByte

short getUnsignedByte(long index,
                    int offset)

Gets one byte (stored as one signed byte) from struct on specified index with specified offset, converts it to unsigned and returns it as short

Parameters:

index - array index

offset - byte array index

Returns:

unsigned byte as short

putUnsignedByte

void putUnsignedByte(long index,
                   int offset,
                   short value)

Puts short with value from 0 to 255 inclusive into struct onto specified index with specified offset as one signed byte

Parameters:

index - array index

offset - byte array index

value - unsigned byte

getShort

short getShort(long index,
             int offset)

Gets two bytes as short from struct on specified index with specified offset

Parameters:

index - array index

offset - byte array offset

Returns:

short value

putShort

void putShort(long index,
            int offset,
            short value)

Puts short into struct onto specified index with specified offset as two bytes

Parameters:

index - array index

offset - byte array offset

value - short value

getUnsignedShort

int getUnsignedShort(long index,
                   int offset)

Gets unsigned short (stored as two bytes) from struct on specified index with specified offset and returns it as int

Parameters:

index - array index

offset - byte array offset

Returns:

unsigned short as int

putUnsignedShort

void putUnsignedShort(long index,
                    int offset,
                    int value)

Puts int with value from 0 to 65535 inclusive into struct onto specified index with specified offset as two bytes

Parameters:

index - array index

offset - byte array offset

value - unsigned short as int

getInt

int getInt(long index,
         int offset)

Gets four bytes as int from struct on specified index with specified offset

Parameters:

index - array index

offset - byte array offset

Returns:

int value

putInt

void putInt(long index,
          int offset,
          int value)

Puts int into struct onto specified index with specified offset as four bytes

Parameters:

index - array index

offset - byte array offset

value - int value

getUnsignedInt

long getUnsignedInt(long index,
                  int offset)

Gets unsigned int (stored as 4 bytes) and returns it as long from struct on specified index with specified offset

Parameters:

index - array index

offset - byte array offset

Returns:

unsigned int as long

putUnsignedInt

void putUnsignedInt(long index,
                  int offset,
                  long value)

Puts long value from 0 to 4294967295 inclusive into struct onto specified index with specified offset as four bytes

Parameters:

index - array index

offset - byte array offset

value - unsigned int as long

getLong

long getLong(long index,
           int offset)

Gets long from struct on specified index with specified offset

Parameters:

index - array index

offset - byte array offset

Returns:

long value

putLong

void putLong(long index,
           int offset,
           long value)

Puts long into struct onto specified index with specified offset as eight bytes

Parameters:

index - array index

offset - byte array offset

value - long value