FSTStruct (fast-serialization 1.27 API)

java.lang.Object
- de.ruedigermoeller.heapoff.structs.FSTStruct

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StructArray, StructInt, StructMap, StructString
```
public class FSTStruct
extends Object
implements Serializable
```
Copyright (c) 2012, Ruediger Moeller. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Date: 01.07.13 Time: 20:20 To change this template use File | Settings | File Templates.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

byte[] ___bytes

int ___elementSize

FSTStructFactory ___fac

long ___offset

static long bufoff

static sun.misc.Unsafe unsafe

Fields
Modifier and Type	Field and Description
`byte[]`	`___bytes`
`int`	`___elementSize`
`FSTStructFactory`	`___fac`
`long`	`___offset`
`static long`	`bufoff`
`static sun.misc.Unsafe`	`unsafe`

Constructor Summary

Constructors
Constructor and Description

FSTStruct()

Constructors
Constructor and Description
`FSTStruct()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addOffset(long off)`
`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)
`FSTStruct`	`cast()`
`<T extends FSTStruct> T`	`cast(Class<T> to)`
`FSTStruct`	`createCopy()` returns a complete copy of this object allocating a new byte[] capable of holding the data.
`FSTStruct`	`detach()` important: iterators, array access and access to substructures of a struct always return pointers, which are cached per thread.
`protected long`	`getAbsoluteOffset()`
`byte[]`	`getBase()`
`byte`	`getByte()`
`void`	`getBytes(byte[] target, int startIndex)`
`int`	`getByteSize()`
`char`	`getChar()`
`int`	`getClzId()`
`double`	`getDouble()`
`int`	`getElementInArraySize()`
`FSTStructFactory`	`getFac()`
`float`	`getFloat()`
`int`	`getIndexInBase()` Deprecated. use getOffset see getOffset
`int`	`getInt()`
`long`	`getLong()`
`int`	`getOffset()`
`Class`	`getPointedClass()`
`short`	`getShort()`
`protected sun.misc.Unsafe`	`getUnsafe()`
`boolean`	`isIdenticTo(FSTStruct other)`
`boolean`	`isNull()`
`boolean`	`isOffHeap()`
`boolean`	`isStructArrayPointer()`
`void`	`next()` Warning: no bounds checking.
`void`	`next(int offset)` Warning: no bounds checking.
`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(byte[] base)`
`void`	`setByte(byte i)`
`void`	`setBytes(byte[] source, int sourceIndex, int len)`
`void`	`setInt(int i)`
`void`	`setLong(long i)`
`void`	`setShort(short i)`

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

- Field Detail
  - unsafe
```
public static sun.misc.Unsafe unsafe
```
  - bufoff
```
public static long bufoff
```
  - ___offset
```
public transient long ___offset
```
  - ___bytes
```
public transient byte[] ___bytes
```
  - ___fac
```
public transient FSTStructFactory ___fac
```
  - ___elementSize
```
public transient int ___elementSize
```
- Constructor Detail
  - FSTStruct
```
public FSTStruct()
```
- Method Detail
  - getUnsafe
```
protected sun.misc.Unsafe getUnsafe()
```
  - 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 int getOffset()
```
    Returns:
    the start index of this struct within the underlying byte array. getByteSize returns len
  - getIndexInBase
```
public int 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(byte[] base)
```
  - getBase
```
public byte[] 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(byte[] base,
          int index)
```
    set this struct pointer to base array at given index
    
    Parameters:
    base -
    index -
  - isIdenticTo
```
public boolean isIdenticTo(FSTStruct other)
```
  - isOffHeap
```
public boolean isOffHeap()
```
  - getElementInArraySize
```
public int getElementInArraySize()
```
  - isStructArrayPointer
```
public boolean isStructArrayPointer()
```
  - isNull
```
public boolean isNull()
```
  - detach
```
public FSTStruct detach()
```
    important: iterators, array access and access to substructures of a struct always return pointers, which are cached per thread. 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). Cost of detach is like an object creation in case it is in the cache.
  - next
```
public final void next()
```
    Warning: no bounds checking. Moving the pointer outside the underlying byte[] will cause access violations
  - next
```
public final void next(int offset)
```
    Warning: no bounds checking. Moving the pointer outside the underlying byte[] will cause access violations
  - previous
```
public final void previous()
```
    Warning: no bounds checking. Moving the pointer outside the underlying byte[] will cause access violations
  - cast
```
public <T extends FSTStruct> T cast(Class<T> to)
```
  - cast
```
public FSTStruct 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 startIndex)
```
  - setBytes
```
public void setBytes(byte[] source,
            int sourceIndex,
            int len)
```
  - createCopy
```
public FSTStruct createCopy()
```
    returns a complete copy of this object allocating a new byte[] capable of holding the data.
    
    Returns:

Class FSTStruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unsafe

bufoff

___offset

___bytes

___fac

___elementSize

Constructor Detail

FSTStruct

Method Detail

getUnsafe

setAbsoluteOffset

getAbsoluteOffset

getOffset

getIndexInBase

getByteSize

getPointedClass

getClzId

pointsToNull

addOffset

setBase

getBase

getFac

baseOn

baseOn

isIdenticTo

isOffHeap

getElementInArraySize

isStructArrayPointer

isNull

detach

next

next

previous

cast

cast

getByte

setByte

getChar

getShort

setShort

getInt

setInt

getLong

setLong

getFloat

getDouble

getBytes

setBytes

createCopy