org.nustaq.offheap.structs.structtypes

Class StructArray<E extends FSTStruct>

java.lang.Object

org.nustaq.offheap.structs.FSTStruct

org.nustaq.offheap.structs.structtypes.StructArray<E>

Type Parameters:

E -

All Implemented Interfaces:

Serializable

public class StructArray<E extends FSTStruct>
extends FSTStruct

An array whose elements are stored 'off heap'. Note that in current version (and documentation below) 'off-heap' means that objects are stored in flat byte arrays. Those byte arrays are actually allocated on the regular java heap. This is not exactly the definition of "off-heap" as this term usually means that raw 'Unsafe' memory is allocated. However using some tweaks it might be possible to back FSTStructs by real off-heap in a furture version if the need arises.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StructArray.StructArrIterator<T extends FSTStruct>

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	elems
protected E	template

Fields inherited from class org.nustaq.offheap.structs.FSTStruct

___bytes, ___elementSize, ___fac, ___offset, tracker

Constructor Summary

Constructors

Constructor and Description
StructArray(int size, E template) initializes with a template.

Method Summary

Modifier and Type	Method and Description
void	___setTemplate(E template)
void	clear(int currentIndex) only avaiable at top level
E	createPointer(int index)
protected Object	elems(int i) accessor to the elements
protected void	elems(int i, Object val) accessor to elements
protected int	elemsLen() length of this struct array
protected Object	elemsPointer()
protected int	elemsStructIndex()
E	get(int i)
int	getStructElemClassId()
int	getStructElemSize()
E	getTemplate() this will be avaiable for top level struct arrays only, embedded structarrays will return null;
StructArray.StructArrIterator<E>	iterator()
void	set(int i, E value)
int	size()
String	toString()

Methods inherited from class org.nustaq.offheap.structs.FSTStruct

addOffset, asByteBufferTemporary, baseOn, baseOn, baseOn, baseOn, cast, cast, createCopy, detach, detachTo, equals, finishChangeTracking, getAbsoluteOffset, getBase, getByte, getBytes, getBytes, getByteSize, getChar, getClzId, getDouble, getElementInArraySize, getFac, getFieldValues, getFloat, getIndexInBase, getInt, getLong, getOffset, getPointedClass, getShort, hashCode, isChangeTracking, isIdenticTo, isNull, isOffHeap, isStructArrayPointer, next, next, onHeapHashcode, pointsToNull, previous, setAbsoluteOffset, setBase, setByte, setBytes, setBytes, setBytes, setInt, setLong, setShort, startChangeTracking, toOffHeap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

elems

protected Object[] elems

template

protected transient E extends FSTStruct template

Constructor Detail

StructArray

public StructArray(int size,
                   E template)

initializes with a template. When off heaped, all elements are filled with a copy of that template. Warning: if this is used, this class behaves different off-heap compared to on-heap. On Heap the template element is ignored.

Parameters:

size -

template -

Method Detail

getTemplate

public E getTemplate()

this will be avaiable for top level struct arrays only, embedded structarrays will return null;

Returns:

elems

protected Object elems(int i)

accessor to the elements

Parameters:

i -

Returns:

elems

protected void elems(int i,
                     Object val)

accessor to elements

Parameters:

i -

val -

elemsLen

protected int elemsLen()

length of this struct array

Returns:

elemsPointer

protected Object elemsPointer()

Returns:

a volatile warpper object to the '0' element of the structs array. Need to call detach() to get a permanent reference

elemsStructIndex

protected int elemsStructIndex()

get

public E get(int i)

set

public void set(int i,
                E value)

size

public int size()

iterator

public StructArray.StructArrIterator<E> iterator()

createPointer

public E createPointer(int index)

toString

public String toString()

Overrides:

toString in class Object

getStructElemSize

public int getStructElemSize()

getStructElemClassId

public int getStructElemClassId()

clear

public void clear(int currentIndex)

only avaiable at top level

Parameters:

currentIndex -

___setTemplate

public void ___setTemplate(E template)