net.sf.joafip.store.entity

Class StoreHeader

java.lang.Object

net.sf.joafip.store.entity.heaprecordable.AbstractHeapRecordable

net.sf.joafip.store.entity.StoreHeader

All Implemented Interfaces:

IHeapRecordable

@NotStorableClass
public class StoreHeader
extends AbstractHeapRecordable

the store header record

Author:

luc peuvrier

Field Summary

Fields inherited from class net.sf.joafip.store.entity.heaprecordable.AbstractHeapRecordable

heapRecordableManager, helperBinaryConversion, logger

Constructor Summary

Constructors

Constructor and Description
StoreHeader(HeapRecordableManager heapRecordableManager, HelperBinaryConversion helperBinaryConversion)

Method Summary

Methods

Modifier and Type	Method and Description
int	byteSize()
void	clear() clear to put in same state as for construction
DataRecordIdentifier	getClassNameListRootDataRecordIdentifier() get the data record identifier for class name list root node
DataRecordIdentifier	getGarbageCandidateInProcess()
DataRecordIdentifier	getGarbageCandidateRootDataRecordIdentifier() get the data record identifier for garbage candidate tree root node
EnumGarbageCollectorState	getGarbageCollectorState()
boolean	getGarbageManagement()
DataRecordIdentifier	getGarbageReferenceLinkRootDataRecordIdentifier() get the data record identifier for garbage reference link tree root node
DataRecordIdentifier	getToGarbageRootDataRecordIdentifier() get the data record identifier for to garbage tree root node
DataRecordIdentifier	getToVisitByCollectorRootDataRecordIdentifier()
DataRecordIdentifier	getVisitedByCollectorRootDataRecordIdentifier()
void	marshall(byte[] binary) from object state to binary form
void	setClassNameListRootDataRecordIdentifier(DataRecordIdentifier classNameListRootDataRecordIdentifier) set the data record identifier for class name list root node
void	setGarbageCandidateInProcess(DataRecordIdentifier garbageCandidateInProcess)
void	setGarbageCandidateRootDataRecordIdentifier(DataRecordIdentifier garbageCandidateRootDataRecordIdentifier) set the data record identifier for garbage candidate tree root node
void	setGarbageCollectorState(EnumGarbageCollectorState garbageCollectorState)
void	setGarbageManagement(boolean garbageManagement)
void	setGarbageReferenceLinkRootDataRecordIdentifier(DataRecordIdentifier garbageReferenceLinkRootDataRecordIdentifier) set the data record identifier for garbage reference link tree root node
void	setToGarbageRootDataRecordIdentifier(DataRecordIdentifier toGarbageRootDataRecordIdentifier) set the data record identifier for to garbage tree root node
void	setToVisitByCollectorRootDataRecordIdentifier(DataRecordIdentifier toVisitByCollectorRootDataRecordIdentifier)
void	setVisitedByCollectorRootDataRecordIdentifier(DataRecordIdentifier visitedByCollectorRootDataRecordIdentifier)
void	unmarshall(byte[] binary) from binary form to object state

Methods inherited from class net.sf.joafip.store.entity.heaprecordable.AbstractHeapRecordable

checkLoaded, compareTo, equals, getDataRecordIdentifier, hashCode, isStateChanged, setDataRecordIdentifier, setStateHaveChanged, setSynchronizedWithFile, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreHeader

public StoreHeader(HeapRecordableManager heapRecordableManager,
           HelperBinaryConversion helperBinaryConversion)

Method Detail

clear

public void clear()

clear to put in same state as for construction

Overrides:

clear in class AbstractHeapRecordable

byteSize

public int byteSize()

Returns:

byte size of binary coding of object state

marshall

public void marshall(byte[] binary)
              throws HeapRecordableException

Description copied from interface: IHeapRecordable

from object state to binary form

Parameters:

binary - where write the object state

Throws:

HeapRecordableException

unmarshall

public void unmarshall(byte[] binary)
                throws HeapRecordableException

Description copied from interface: IHeapRecordable

from binary form to object state

Parameters:

binary - where read the object state

Throws:

HeapRecordableException

getClassNameListRootDataRecordIdentifier

public DataRecordIdentifier getClassNameListRootDataRecordIdentifier()
                                                              throws StoreException

get the data record identifier for class name list root node

Returns:

the data record identifier for class name list root node

Throws:

HeapRecordableException

StoreException

setClassNameListRootDataRecordIdentifier

public void setClassNameListRootDataRecordIdentifier(DataRecordIdentifier classNameListRootDataRecordIdentifier)
                                              throws StoreException

set the data record identifier for class name list root node

Parameters:

classNameListRootDataRecordIdentifier - the data record identifier for class name list root node

Throws:

StoreException

getGarbageCandidateRootDataRecordIdentifier

public DataRecordIdentifier getGarbageCandidateRootDataRecordIdentifier()
                                                                 throws StoreException

get the data record identifier for garbage candidate tree root node

Returns:

the data record identifier for garbage candidate tree root node

Throws:

StoreException

setGarbageCandidateRootDataRecordIdentifier

public void setGarbageCandidateRootDataRecordIdentifier(DataRecordIdentifier garbageCandidateRootDataRecordIdentifier)
                                                 throws StoreException

set the data record identifier for garbage candidate tree root node

Parameters:

garbageCandidateRootDataRecordIdentifier - the data record identifier for garbage candidate tree root node

Throws:

StoreException

getToGarbageRootDataRecordIdentifier

public DataRecordIdentifier getToGarbageRootDataRecordIdentifier()
                                                          throws StoreException

get the data record identifier for to garbage tree root node

Returns:

the data record identifier for to garbage tree root node

Throws:

StoreException

setToGarbageRootDataRecordIdentifier

public void setToGarbageRootDataRecordIdentifier(DataRecordIdentifier toGarbageRootDataRecordIdentifier)
                                          throws StoreException

set the data record identifier for to garbage tree root node

Parameters:

garbageCandidateRootDataRecordIdentifier - the data record identifier for to garbage tree root node

Throws:

StoreException

getGarbageReferenceLinkRootDataRecordIdentifier

public DataRecordIdentifier getGarbageReferenceLinkRootDataRecordIdentifier()
                                                                     throws StoreException

get the data record identifier for garbage reference link tree root node

Returns:

the data record identifier for garbage reference link tree root node

Throws:

StoreException

setGarbageReferenceLinkRootDataRecordIdentifier

public void setGarbageReferenceLinkRootDataRecordIdentifier(DataRecordIdentifier garbageReferenceLinkRootDataRecordIdentifier)
                                                     throws StoreException

set the data record identifier for garbage reference link tree root node

Parameters:

garbageReferenceLinkRootDataRecordIdentifier - the data record identifier for to garbage reference link tree root node

Throws:

StoreException

getGarbageCandidateInProcess

public DataRecordIdentifier getGarbageCandidateInProcess()
                                                  throws StoreException

Throws:

StoreException

setGarbageCandidateInProcess

public void setGarbageCandidateInProcess(DataRecordIdentifier garbageCandidateInProcess)
                                  throws StoreException

Throws:

StoreException

getToVisitByCollectorRootDataRecordIdentifier

public DataRecordIdentifier getToVisitByCollectorRootDataRecordIdentifier()
                                                                   throws StoreException

Throws:

StoreException

setToVisitByCollectorRootDataRecordIdentifier

public void setToVisitByCollectorRootDataRecordIdentifier(DataRecordIdentifier toVisitByCollectorRootDataRecordIdentifier)
                                                   throws StoreException

Throws:

StoreException

getVisitedByCollectorRootDataRecordIdentifier

public DataRecordIdentifier getVisitedByCollectorRootDataRecordIdentifier()
                                                                   throws StoreException

Throws:

StoreException

setVisitedByCollectorRootDataRecordIdentifier

public void setVisitedByCollectorRootDataRecordIdentifier(DataRecordIdentifier visitedByCollectorRootDataRecordIdentifier)
                                                   throws StoreException

Throws:

StoreException

getGarbageCollectorState

public EnumGarbageCollectorState getGarbageCollectorState()
                                                   throws StoreException

Throws:

StoreException

setGarbageCollectorState

public void setGarbageCollectorState(EnumGarbageCollectorState garbageCollectorState)
                              throws StoreException

Throws:

StoreException

setGarbageManagement

public void setGarbageManagement(boolean garbageManagement)
                          throws StoreException

Throws:

StoreException

getGarbageManagement

public boolean getGarbageManagement()
                             throws StoreException

Throws:

StoreException