FSTStruct (fst 2.29 API)

java.lang.Object
- org.nustaq.offheap.structs.FSTStruct

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StructArray, StructByteString, StructInt, StructString
```
public class FSTStruct
extends Object
implements Serializable
```
Date: 01.07.13 Time: 20:20 * Base class of all structs. Inherit this to define your own structs. Refer to the documentation in the wiki regarding limitations of struct classes/members

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

Bytez ___bytes

int ___elementSize

FSTStructFactory ___fac

long ___offset

FSTStructChange tracker

Fields
Modifier and Type	Field and Description
`Bytez`	`___bytes`
`int`	`___elementSize`
`FSTStructFactory`	`___fac`
`long`	`___offset`
`FSTStructChange`	`tracker`

Constructor Summary

Constructors
Constructor and Description

FSTStruct()

Constructors
Constructor and Description
`FSTStruct()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addOffset(long off)`
`ByteBuffer`	`asByteBufferTemporary()`
`void`	`baseOn(byte[] base, int index)` set this struct pointer to base array at given index
`void`	`baseOn(byte[] base, long offset, FSTStructFactory fac)` set this struct pointer to base array at given offset (=bufoff+index)
`void`	`baseOn(Bytez base, int index)`
`void`	`baseOn(Bytez base, long offset, FSTStructFactory fac)`
`<T extends FSTStruct> T`	`cast()`
`<T extends FSTStruct> T`	`cast(Class<T> to)`
`FSTStruct`	`createCopy()` returns a complete copy of this object allocating a new Bytez capable of holding the data.
`<T extends FSTStruct> T`	`detach()` important: iterators, array access and access to substructures of a struct always return pointers, which are cached per thread (one instance only!).
`<T extends FSTStruct> T`	`detachTo(T pointer)` move offsets and memorybase to given pointer and return the pointer.
`boolean`	`equals(Object obj)`
`FSTStructChange`	`finishChangeTracking()` works only if change tracking is enabled
`protected long`	`getAbsoluteOffset()`
`Bytez`	`getBase()`
`byte`	`getByte()`
`void`	`getBytes(byte[] target, int startIndexInTarget, int len)`
`void`	`getBytes(Bytez target, int startIndexInTarget)`
`int`	`getByteSize()`
`char`	`getChar()`
`int`	`getClzId()`
`double`	`getDouble()`
`int`	`getElementInArraySize()`
`FSTStructFactory`	`getFac()`
`Object`	`getFieldValues()`
`float`	`getFloat()`
`long`	`getIndexInBase()` Deprecated. use getOffset see getOffset
`int`	`getInt()`
`long`	`getLong()`
`long`	`getOffset()`
`Class`	`getPointedClass()`
`short`	`getShort()`
`int`	`hashCode()`
`boolean`	`isChangeTracking()`
`boolean`	`isIdenticTo(FSTStruct other)`
`boolean`	`isNull()`
`boolean`	`isOffHeap()`
`boolean`	`isStructArrayPointer()`
`void`	`next()` Warning: no bounds checking.
`void`	`next(int offset)` Warning: no bounds checking.
`int`	`onHeapHashcode()`
`boolean`	`pointsToNull()`
`void`	`previous()` Warning: no bounds checking.
`protected void`	`setAbsoluteOffset(long off)` must include bytearray offset in case of unsafe use
`protected void`	`setBase(Bytez base)`
`void`	`setByte(byte i)`
`void`	`setBytes(byte[] source, int sourceIndex, int len)`
`void`	`setBytes(ByteSource source, long sourceIndex, int len)`
`void`	`setBytes(Bytez source, long sourceIndex, int len)`
`void`	`setInt(int i)`
`void`	`setLong(long i)`
`void`	`setShort(short i)`
`FSTStruct`	`startChangeTracking()` works only if change tracking is enabled
`FSTStruct`	`toOffHeap()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ___offset
```
public transient long ___offset
```
  - ___bytes
```
public transient Bytez ___bytes
```
  - ___fac
```
public transient FSTStructFactory ___fac
```
  - ___elementSize
```
public transient int ___elementSize
```
  - tracker
```
public transient FSTStructChange tracker
```
- Constructor Detail
  - FSTStruct
```
public FSTStruct()
```
- Method Detail
  - setAbsoluteOffset
```
protected void setAbsoluteOffset(long off)
```
    must include bytearray offset in case of unsafe use
    
    Parameters:
    
    off -
  - getAbsoluteOffset
```
protected long getAbsoluteOffset()
```
    Returns:
    
    internal offset, use getIndexInBase to get the start index of the struct within the base byte array
  - getOffset
```
public long getOffset()
```
    Returns:
    
    the start index of this struct within the underlying byte array. getByteSize returns len. In case of offheap, the address of the first valid byte is returned
  - getIndexInBase
```
public long getIndexInBase()
```
    Deprecated. use getOffset see getOffset
  - getByteSize
```
public int getByteSize()
```
    Returns:
    
    the number of bytes used by the struct pointed to
  - getPointedClass
```
public Class getPointedClass()
```
  - getClzId
```
public int getClzId()
```
  - pointsToNull
```
public boolean pointsToNull()
```
  - addOffset
```
protected void addOffset(long off)
```
  - setBase
```
protected void setBase(Bytez base)
```
  - getBase
```
public Bytez getBase()
```
    Returns:
    
    the underlying byte array.
  - getFac
```
public FSTStructFactory getFac()
```
  - baseOn
```
public void baseOn(byte[] base,
                   long offset,
                   FSTStructFactory fac)
```
    set this struct pointer to base array at given offset (=bufoff+index)
    
    Parameters:
    
    base -
    
    offset - direct offset to byte array element (=FSTStruct.bufoff+array index)
  - baseOn
```
public void baseOn(Bytez base,
                   long offset,
                   FSTStructFactory fac)
```
  - baseOn
```
public void baseOn(byte[] base,
                   int index)
```
    set this struct pointer to base array at given index
    
    Parameters:
    
    base -
    
    index -
  - baseOn
```
public void baseOn(Bytez base,
                   int index)
```
  - isIdenticTo
```
public boolean isIdenticTo(FSTStruct other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - onHeapHashcode
```
public int onHeapHashcode()
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - isOffHeap
```
public boolean isOffHeap()
```
  - getElementInArraySize
```
public int getElementInArraySize()
```
  - isStructArrayPointer
```
public boolean isStructArrayPointer()
```
  - isNull
```
public boolean isNull()
```
  - detach
```
public <T extends FSTStruct> T detach()
```
    important: iterators, array access and access to substructures of a struct always return pointers, which are cached per thread (one instance only!). To keep a pointer to a struct (e.g. search struct array and find an element which should be kept as result) you need to detach it (removed from cache). This method allocates a pointer.
  - detachTo
```
public <T extends FSTStruct> T detachTo(T pointer)
```
    move offsets and memorybase to given pointer and return the pointer. Eases dereferencing of nested structs without object creation. If the given pointer is null, a new one will be created (alloc)
```
   MyStruct st = FSTStructFactory.getInstance().createEmptyStructPointer(FSTStruct.class);
   otherStruct.getEmbeddedMyStruct().to(st);
 
```
  - next
```
public final void next()
```
    Warning: no bounds checking. Moving the pointer outside the underlying Bytez will cause access violations
  - next
```
public final void next(int offset)
```
    Warning: no bounds checking. Moving the pointer outside the underlying Bytez will cause access violations
  - previous
```
public final void previous()
```
    Warning: no bounds checking. Moving the pointer outside the underlying Bytez will cause access violations
  - cast
```
public <T extends FSTStruct> T cast(Class<T> to)
```
  - cast
```
public <T extends FSTStruct> T cast()
```
    Returns:
    
    a volatile pointer of the exact type this points to
  - getByte
```
public byte getByte()
```
  - setByte
```
public void setByte(byte i)
```
  - getChar
```
public char getChar()
```
  - getShort
```
public short getShort()
```
  - setShort
```
public void setShort(short i)
```
  - getInt
```
public int getInt()
```
  - setInt
```
public void setInt(int i)
```
  - getLong
```
public long getLong()
```
  - setLong
```
public void setLong(long i)
```
  - getFloat
```
public float getFloat()
```
  - getDouble
```
public double getDouble()
```
  - getBytes
```
public void getBytes(byte[] target,
                     int startIndexInTarget,
                     int len)
```
  - getBytes
```
public void getBytes(Bytez target,
                     int startIndexInTarget)
```
  - setBytes
```
public void setBytes(byte[] source,
                     int sourceIndex,
                     int len)
```
  - setBytes
```
public void setBytes(ByteSource source,
                     long sourceIndex,
                     int len)
```
  - setBytes
```
public void setBytes(Bytez source,
                     long sourceIndex,
                     int len)
```
  - createCopy
```
public FSTStruct createCopy()
```
    returns a complete copy of this object allocating a new Bytez capable of holding the data.
    
    Returns:
  - startChangeTracking
```
public FSTStruct startChangeTracking()
```
    works only if change tracking is enabled
  - finishChangeTracking
```
public FSTStructChange finishChangeTracking()
```
    works only if change tracking is enabled
  - isChangeTracking
```
public boolean isChangeTracking()
```
  - toOffHeap
```
public FSTStruct toOffHeap()
```
  - getFieldValues
```
public Object getFieldValues()
```
  - asByteBufferTemporary
```
public ByteBuffer asByteBufferTemporary()
```
    Returns:
    
    a temporary per thread instance of ByteBuffer pointing to this structs data. The length of the buffer is same as the length of this struct. The instance returned is valid until the currentThread calls this method next time. Can be used to feed e.g. NIO api. Use ByteBuffer.duplicate() to obtain a non-temporary instance
    
    Throws:
    
    NoSuchFieldException
    
    IllegalAccessException

Class FSTStruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

___offset

___bytes

___fac

___elementSize

tracker

Constructor Detail

FSTStruct

Method Detail

setAbsoluteOffset

getAbsoluteOffset

getOffset

getIndexInBase

getByteSize

getPointedClass

getClzId

pointsToNull

addOffset

setBase

getBase

getFac

baseOn

baseOn

baseOn

baseOn

isIdenticTo

hashCode

onHeapHashcode

equals

isOffHeap

getElementInArraySize

isStructArrayPointer

isNull

detach

detachTo

next

next

previous

cast

cast

getByte

setByte

getChar

getShort

setShort

getInt

setInt

getLong

setLong

getFloat

getDouble

getBytes

getBytes

setBytes

setBytes

setBytes

createCopy

startChangeTracking

finishChangeTracking

isChangeTracking

toOffHeap

getFieldValues

asByteBufferTemporary