AbstractFileStorable (JOAFIP "Abstract" Parent Project 4.0.0b9)

java.lang.Object
- net.sf.joafip.kvstore.entity.AbstractFileStorable

All Implemented Interfaces:

IFileStorable

Direct Known Subclasses:

AbstractPageRecord, HeapHeader, HeapRecord
```
@NotStorableClass
public abstract class AbstractFileStorable
extends Object
implements IFileStorable
```
all that is common to storable in file using FileForStorable:
- the FileForStorable manager to use
- position of data in file
- flags for first creation and state change
- primitive type read and write in file
- crc32 compute and check for data integrity check
by extension make able to create mutable or immutable object, immutable are for file record unique representation, mutable make able to change the file record represented
Author:

luc peuvrier

Field Summary

Fields
Modifier and Type	Field and Description
`protected IFileForStorable`	`fileForStorable` to read/write this in file
`protected boolean`	`justCreated` true if just created in memory, never read from file
`protected JoafipLogger`	`logger`
`protected int`	`numberOfByteReadWrote` current number of byte read or wrote
`protected long`	`positionInFile` position in file of this in marshallized forms
`protected boolean`	`valueChangedToSave` true if this value changed, creation implies no value to save since not read and not write

Constructor Summary

Constructors
Constructor and Description

AbstractFileStorable(IFileForStorable fileForStorable, long positionInFile)

Constructors
Constructor and Description
`AbstractFileStorable(IFileForStorable fileForStorable, long positionInFile)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` initial state:no value to save since not read and not write
`boolean`	`equals(Object obj)`
`long`	`getPositionInFile()`
`int`	`hashCode()`
`boolean`	`isJustCreated()`
`boolean`	`isValueChangedToSave()` to know if the value state change
`protected abstract void`	`marshallImpl()` marshaling implementation for write `#crc32` is set to zero
`protected void`	`readAndCheckCrc32(int offset)`
`protected boolean`	`readBoolean()`
`protected byte`	`readByte()`
`protected void`	`readBytes(byte[] destination)` read bytes
`protected byte[]`	`readBytes(int length)` read bytes
`protected int`	`readFileAppendToIoBuffer(int newSize)` read extending ioBuffer
`protected int`	`readFileToIoBuffer(int size)`
`void`	`readFromFile()` read this file storable from file
`protected int`	`readInteger()`
`protected long`	`readLong()` unmarshal from byte array current `#dataByteArrayIndex` index to long `#dataByteArrayIndex` is updated to next data to read position
`void`	`setValueIsChangedValueToSave()` set this record have value changed, so to save
`void`	`setValueIsNotChanged()`
`protected abstract int`	`toMarshallSize()`
`String`	`toString()`
`protected abstract void`	`unmarshallImpl()` Unmarshalling implementation for read `#crc32` is set to zero
`protected abstract void`	`valueChangedAction()`
`protected void`	`writeBoolean(boolean value)`
`protected void`	`writeByte(byte value)`
`protected void`	`writeBytes(byte[] dataByteArray)` write bytes
`protected void`	`writeCrc32(int offset)`
`protected void`	`writeInteger(int value)`
`protected void`	`writeLong(long value)` Marshal long value to byte array current `#dataByteArrayIndex` index `#dataByteArrayIndex` is updated to next data to write position
`void`	`writeToFile()` write this file storable to file
`byte[]`	`writeToFileGetWrited()`

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

Methods inherited from interface net.sf.joafip.kvstore.entity.IFileStorable
getPreviousRecordPositionInFile, getRecordSize

- Field Detail
  - logger
```
protected final JoafipLogger logger
```
  - positionInFile
```
protected final long positionInFile
```
    position in file of this in marshallized forms
  - fileForStorable
```
protected final IFileForStorable fileForStorable
```
    to read/write this in file
  - numberOfByteReadWrote
```
protected transient int numberOfByteReadWrote
```
    current number of byte read or wrote
  - valueChangedToSave
```
protected boolean valueChangedToSave
```
    true if this value changed, creation implies no value to save since not read and not write
  - justCreated
```
protected boolean justCreated
```
    true if just created in memory, never read from file
- Constructor Detail
  - AbstractFileStorable
```
public AbstractFileStorable(IFileForStorable fileForStorable,
                    long positionInFile)
```
    Parameters:
    fileForStorable -
    positionInFile -
- Method Detail
  - clear
```
public void clear()
```
    Description copied from interface: IFileStorable
    
    initial state:no value to save since not read and not write
    
    Specified by:
    
    clear in interface IFileStorable
  - getPositionInFile
```
public long getPositionInFile()
```
    Specified by:
    
    getPositionInFile in interface IFileStorable
    
    Returns:
    position in file of this file storable
  - readFromFile
```
public void readFromFile()
                  throws HeapException
```
    Description copied from interface: IFileStorable
    
    read this file storable from file
    
    Specified by:
    
    readFromFile in interface IFileStorable
    
    Throws:
    
    HeapException
  - writeToFile
```
public void writeToFile()
                 throws HeapException
```
    Description copied from interface: IFileStorable
    
    write this file storable to file
    
    Specified by:
    
    writeToFile in interface IFileStorable
    
    Throws:
    
    HeapException
  - writeToFileGetWrited
```
public byte[] writeToFileGetWrited()
                            throws HeapException
```
    Specified by:
    
    writeToFileGetWrited in interface IFileStorable
    
    Throws:
    
    HeapException
  - toMarshallSize
```
protected abstract int toMarshallSize()
                               throws HeapException
```
    Returns:
    number of byte to marshal
    
    Throws:
    
    HeapException
  - unmarshallImpl
```
protected abstract void unmarshallImpl()
                                throws HeapException
```
    Unmarshalling implementation for read
    #crc32 is set to zero
    
    Throws:
    
    HeapException
  - marshallImpl
```
protected abstract void marshallImpl()
                              throws HeapException
```
    marshaling implementation for write
    #crc32 is set to zero
    
    Throws:
    
    HeapException
  - isJustCreated
```
public boolean isJustCreated()
```
    Specified by:
    
    isJustCreated in interface IFileStorable
    
    Returns:
    true if just created ( not read from file and not setted )
  - isValueChangedToSave
```
public boolean isValueChangedToSave()
```
    Description copied from interface: IFileStorable
    
    to know if the value state change
    
    Specified by:
    
    isValueChangedToSave in interface IFileStorable
    
    Returns:
    true if value changed
  - setValueIsChangedValueToSave
```
public void setValueIsChangedValueToSave()
                                  throws HeapException
```
    Description copied from interface: IFileStorable
    
    set this record have value changed, so to save
    
    Specified by:
    
    setValueIsChangedValueToSave in interface IFileStorable
    
    Throws:
    
    HeapException
  - valueChangedAction
```
protected abstract void valueChangedAction()
                                    throws HeapException
```
    Throws:
    
    HeapException
  - setValueIsNotChanged
```
public void setValueIsNotChanged()
```
    Specified by:
    
    setValueIsNotChanged in interface IFileStorable
  - readFileToIoBuffer
```
protected int readFileToIoBuffer(int size)
                          throws HeapException
```
    Throws:
    
    HeapException
  - readFileAppendToIoBuffer
```
protected int readFileAppendToIoBuffer(int newSize)
                                throws HeapException
```
    read extending ioBuffer
    
    Parameters:
    newSize - ioBuffer new size
    
    Returns:
    
    Throws:
    
    HeapException
  - readAndCheckCrc32
```
protected void readAndCheckCrc32(int offset)
                          throws HeapException
```
    Throws:
    
    HeapException
  - readBytes
```
protected byte[] readBytes(int length)
                    throws HeapException
```
    read bytes
    
    Parameters:
    length - number of bytes to read
    
    Returns:
    the bytes read
    
    Throws:
    
    HeapException
  - readBytes
```
protected void readBytes(byte[] destination)
                  throws HeapException
```
    read bytes
    
    Parameters:
    length - number of bytes to read
    
    Throws:
    
    HeapException
  - readLong
```
protected long readLong()
                 throws HeapException
```
    unmarshal from byte array current #dataByteArrayIndex index to long
    #dataByteArrayIndex is updated to next data to read position
    
    Parameters:
    dataByteArray -
    
    Returns:
    the unmarshaled value
    
    Throws:
    
    HeapException
  - readInteger
```
protected int readInteger()
                   throws HeapException
```
    Throws:
    
    HeapException
  - readBoolean
```
protected boolean readBoolean()
                       throws HeapException
```
    Throws:
    
    HeapException
  - readByte
```
protected byte readByte()
                 throws HeapException
```
    Throws:
    
    HeapException
  - writeBytes
```
protected void writeBytes(byte[] dataByteArray)
                   throws HeapException
```
    write bytes
    
    Parameters:
    dataByteArray - bytes to write
    
    Throws:
    
    HeapException
  - writeLong
```
protected void writeLong(long value)
                  throws HeapException
```
    Marshal long value to byte array current #dataByteArrayIndex index
    #dataByteArrayIndex is updated to next data to write position
    
    Parameters:
    value - the value to marshal
    
    Throws:
    
    HeapException
  - writeInteger
```
protected void writeInteger(int value)
                     throws HeapException
```
    Throws:
    
    HeapException
  - writeCrc32
```
protected void writeCrc32(int offset)
                   throws HeapException
```
    Throws:
    
    HeapException
  - writeBoolean
```
protected void writeBoolean(boolean value)
                     throws HeapException
```
    Throws:
    
    HeapException
  - writeByte
```
protected void writeByte(byte value)
                  throws HeapException
```
    Throws:
    
    HeapException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractFileStorable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.joafip.kvstore.entity.IFileStorable

Field Detail

logger

positionInFile

fileForStorable

numberOfByteReadWrote

valueChangedToSave

justCreated

Constructor Detail

AbstractFileStorable

Method Detail

clear

getPositionInFile

readFromFile

writeToFile

writeToFileGetWrited

toMarshallSize

unmarshallImpl

marshallImpl

isJustCreated

isValueChangedToSave

setValueIsChangedValueToSave

valueChangedAction

setValueIsNotChanged

readFileToIoBuffer

readFileAppendToIoBuffer

readAndCheckCrc32

readBytes

readBytes

readLong

readInteger

readBoolean

readByte

writeBytes

writeLong

writeInteger

writeCrc32

writeBoolean

writeByte

hashCode

equals

toString