net.sf.joafip.store.service.garbage.recordmgr

Class GarbageCandidateRecordManager

java.lang.Object

net.sf.joafip.store.service.garbage.recordmgr.GarbageCandidateRecordManager

@NotStorableClass
public class GarbageCandidateRecordManager
extends Object

manage garbage candidate record in file

Author:

luc peuvrier

Constructor Summary

Constructors

Constructor and Description
GarbageCandidateRecordManager(StoreHeader storeHeader, HeapRecordableManager heapRecordableManager, HelperBinaryConversion helperBinaryConversion)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCandidate(DataRecordIdentifier dataRecordIdentifier) add a data record identifier garbage candidate to the list ( sorted red black tree )
boolean	containsCandidate(DataRecordIdentifier dataRecordIdentifier) FOR TEST ONLY
void	getAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
List<DataRecordIdentifierRBTNode>	getCandidate() for test purpose only
int	getNumberOfGarbageCandidate() get number of garbage candidate in the list
boolean	isEmpty()
DataRecordIdentifier	pollFirstCandidate() Retrieves and removes the first garbage candidate record identifier
boolean	removeCandidate(DataRecordIdentifier dataRecordIdentifier) remove a data record identifier of garbage candidate from the list if exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GarbageCandidateRecordManager

public GarbageCandidateRecordManager(StoreHeader storeHeader,
                             HeapRecordableManager heapRecordableManager,
                             HelperBinaryConversion helperBinaryConversion)

Method Detail

addCandidate

public boolean addCandidate(DataRecordIdentifier dataRecordIdentifier)
                     throws GarbageException

add a data record identifier garbage candidate to the list ( sorted red black tree )

Parameters:

dataRecordIdentifier - data record identifier of garbage candidate

Returns:

true if added, else false ( already exist )

Throws:

GarbageException

removeCandidate

public boolean removeCandidate(DataRecordIdentifier dataRecordIdentifier)
                        throws GarbageException

remove a data record identifier of garbage candidate from the list if exist.

Parameters:

dataRecordIdentifier - data record identifier for candidate to remove if exist

Returns:

true if removed

Throws:

GarbageException

pollFirstCandidate

public DataRecordIdentifier pollFirstCandidate()
                                        throws GarbageException

Retrieves and removes the first garbage candidate record identifier

Returns:

the first garbage candidate record identifier, null if none ( empty to garbage tree)

Throws:

GarbageException

getNumberOfGarbageCandidate

public int getNumberOfGarbageCandidate()
                                throws GarbageException

get number of garbage candidate in the list

Returns:

number of garbage candidate

Throws:

GarbageException

isEmpty

public boolean isEmpty()
                throws GarbageException

Returns:

true if garbage candidate list is empty

Throws:

GarbageException

containsCandidate

@Fortest
public boolean containsCandidate(DataRecordIdentifier dataRecordIdentifier)
                          throws GarbageException

FOR TEST ONLY

Parameters:

dataRecordIdentifier -

Returns:

Throws:

GarbageException

getCandidate

@Fortest
public List<DataRecordIdentifierRBTNode> getCandidate()
                                               throws GarbageException

for test purpose only

Returns:

list of garbage candidate

Throws:

GarbageException

getAllDataRecordIdentifiers

public void getAllDataRecordIdentifiers(Set<DataRecordIdentifier> setToUpdate)
                                 throws GarbageException

Throws:

GarbageException