one.microstream.persistence.internal

Class DefaultObjectRegistry

java.lang.Object

one.microstream.persistence.internal.DefaultObjectRegistry

All Implemented Interfaces:

PersistenceObjectIdLookup, PersistenceObjectLookup, PersistenceObjectRegistry, PersistenceSwizzlingLookup, one.microstream.util.Cloneable<PersistenceObjectRegistry>

public final class DefaultObjectRegistry
extends Object
implements PersistenceObjectRegistry

Method Summary

Modifier and Type	Method and Description
long	capacity()
void	clear() Clears all entries except those that are essential for a correctly executed program (e.g.
void	clearAll() Clears all entries, including those that are essential for a correctly executed program (e.g.
DefaultObjectRegistry	Clone() Useful for PersistenceContextDispatcher.
boolean	consolidate() Consolidate internal data structures, e.g.
boolean	containsObjectId(long objectId)
one.microstream.collections.types.XGettingTable<String,one.microstream.hashing.HashStatisticsBucketBased>	createHashStatistics()
static float	defaultHashDensity()
boolean	ensureCapacity(long desiredCapacity) Makes sure the internal storage structure is prepared to provide a PersistenceObjectRegistry.capacity() of at least the passed capacity value.
float	hashDensity()
int	hashRange()
boolean	isEmpty()
boolean	isValid(long objectId, Object object)
static boolean	isValidCapacity(long desiredCapacity)
static boolean	isValidHashDensity(float desiredHashDensity)
<A extends PersistenceAcceptor> A	iterateEntries(A acceptor)
Object	lookupObject(long objectId)
long	lookupObjectId(Object object)
long	minimumCapacity()
static DefaultObjectRegistry	New()
static DefaultObjectRegistry	New(float hashDensity)
static DefaultObjectRegistry	New(float hashDensity, long minimumCapacity)
static DefaultObjectRegistry	New(long minimumCapacity)
Object	optionalRegisterObject(long objectId, Object object)
static void	printEntryInstanceSizeInfo()
boolean	registerConstant(long objectId, Object constant)
boolean	registerObject(long objectId, Object object)
boolean	setConfiguration(float hashDensity, long minimumCapacity)
boolean	setHashDensity(float hashDensity)
boolean	setMinimumCapacity(long minimumCapacity)
long	size()
void	truncate() Truncates all entries except those that are essential for a correctly executed program (e.g.
void	truncateAll() Truncates all entries, including those that are essential for a correctly executed program (e.g.
void	validate(long objectId, Object object)
static long	validateCapacity(long desiredCapacity)
static float	validateHashDensity(float desiredHashDensity)

Methods inherited from class java.lang.Object

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

Method Detail

defaultHashDensity

public static final float defaultHashDensity()

isValidHashDensity

public static final boolean isValidHashDensity(float desiredHashDensity)

validateHashDensity

public static final float validateHashDensity(float desiredHashDensity)

isValidCapacity

public static final boolean isValidCapacity(long desiredCapacity)

validateCapacity

public static final long validateCapacity(long desiredCapacity)

New

public static DefaultObjectRegistry New()

Specified by:

New in interface PersistenceObjectRegistry

New

public static DefaultObjectRegistry New(long minimumCapacity)

New

public static DefaultObjectRegistry New(float hashDensity)

New

public static DefaultObjectRegistry New(float hashDensity,
                                        long minimumCapacity)

Parameters:

hashDensity - reasonable values are within [0.75; 2.00].

minimumCapacity - the initial minimum capacity

Returns:

the newly created DefaultObjectRegistry

Clone

public final DefaultObjectRegistry Clone()

Description copied from interface: PersistenceObjectRegistry

Useful for PersistenceContextDispatcher.

Specified by:

Clone in interface PersistenceObjectRegistry

Specified by:

Clone in interface one.microstream.util.Cloneable<PersistenceObjectRegistry>

Returns:

A Clone of this instance as described in Cloneable.

hashRange

public final int hashRange()

Specified by:

hashRange in interface PersistenceObjectRegistry

hashDensity

public final float hashDensity()

Specified by:

hashDensity in interface PersistenceObjectRegistry

minimumCapacity

public final long minimumCapacity()

Specified by:

minimumCapacity in interface PersistenceObjectRegistry

capacity

public final long capacity()

Specified by:

capacity in interface PersistenceObjectRegistry

Returns:

the current size potential before a (maybe costly) rebuild becomes necessary.

size

public final long size()

Specified by:

size in interface PersistenceObjectRegistry

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface PersistenceObjectRegistry

setHashDensity

public final boolean setHashDensity(float hashDensity)

Specified by:

setHashDensity in interface PersistenceObjectRegistry

setConfiguration

public final boolean setConfiguration(float hashDensity,
                                      long minimumCapacity)

Specified by:

setConfiguration in interface PersistenceObjectRegistry

setMinimumCapacity

public final boolean setMinimumCapacity(long minimumCapacity)

Specified by:

setMinimumCapacity in interface PersistenceObjectRegistry

ensureCapacity

public final boolean ensureCapacity(long desiredCapacity)

Description copied from interface: PersistenceObjectRegistry

Makes sure the internal storage structure is prepared to provide a PersistenceObjectRegistry.capacity() of at least the passed capacity value.

Specified by:

ensureCapacity in interface PersistenceObjectRegistry

Parameters:

desiredCapacity - the new minimum capacity

Returns:

whether a rebuild of internal storage structures was necessary.

containsObjectId

public final boolean containsObjectId(long objectId)

Specified by:

containsObjectId in interface PersistenceObjectRegistry

lookupObjectId

public final long lookupObjectId(Object object)

Specified by:

lookupObjectId in interface PersistenceObjectIdLookup

Specified by:

lookupObjectId in interface PersistenceObjectRegistry

lookupObject

public final Object lookupObject(long objectId)

Specified by:

lookupObject in interface PersistenceObjectLookup

Specified by:

lookupObject in interface PersistenceObjectRegistry

isValid

public final boolean isValid(long objectId,
                             Object object)

Specified by:

isValid in interface PersistenceObjectRegistry

validate

public final void validate(long objectId,
                           Object object)

Specified by:

validate in interface PersistenceObjectRegistry

registerObject

public final boolean registerObject(long objectId,
                                    Object object)

Specified by:

registerObject in interface PersistenceObjectRegistry

optionalRegisterObject

public final Object optionalRegisterObject(long objectId,
                                           Object object)

Specified by:

optionalRegisterObject in interface PersistenceObjectRegistry

registerConstant

public final boolean registerConstant(long objectId,
                                      Object constant)

Specified by:

registerConstant in interface PersistenceObjectRegistry

iterateEntries

public final <A extends PersistenceAcceptor> A iterateEntries(A acceptor)

Specified by:

iterateEntries in interface PersistenceObjectRegistry

consolidate

public final boolean consolidate()

Description copied from interface: PersistenceObjectRegistry

Consolidate internal data structures, e.g. by removing orphan entries and empty hash chains. Depending on the implementation and the size of the registry, this can take a considerable amount of time.

Specified by:

consolidate in interface PersistenceObjectRegistry

Returns:

whether a rebuild was required.

clear

public final void clear()

Description copied from interface: PersistenceObjectRegistry

Clears all entries except those that are essential for a correctly executed program (e.g. constants).
Clearing means to leave the current capacity as it is and just to actually clear its entries.

NOTE:
This method is currently only intended to be used for testing since calling it can cause inconsistencies if there still exist uncleared lazy references.

Specified by:

clear in interface PersistenceObjectRegistry

clearAll

public final void clearAll()

Description copied from interface: PersistenceObjectRegistry

Clears all entries, including those that are essential for a correctly executed program (e.g. constants), effectively leaving a completely empty registry.
Clearing means to leave the current capacity as it is and just to actually clear its entries.

NOTE:
This method is currently only intended to be used for testing since calling it can cause inconsistencies if there still exist uncleared lazy references.

Specified by:

clearAll in interface PersistenceObjectRegistry

truncate

public final void truncate()

Description copied from interface: PersistenceObjectRegistry

Truncates all entries except those that are essential for a correctly executed program (e.g. constants). Truncating means to quickly empty the registry by reinitializing the internal storage structures with a new and minimal capacity.

NOTE:
This method is currently only intended to be used for testing since calling it can cause inconsistencies if there still exist uncleared lazy references.

Specified by:

truncate in interface PersistenceObjectRegistry

truncateAll

public final void truncateAll()

Description copied from interface: PersistenceObjectRegistry

Truncates all entries, including those that are essential for a correctly executed program (e.g. constants), effectively leaving a completely empty registry.
Truncating means to quickly empty the registry by reinitializing the internal storage structures with a new and minimal capacity.

NOTE:
This method is currently only intended to be used for testing since calling it can cause inconsistencies if there still exist uncleared lazy references.

Specified by:

truncateAll in interface PersistenceObjectRegistry

createHashStatistics

public final one.microstream.collections.types.XGettingTable<String,one.microstream.hashing.HashStatisticsBucketBased> createHashStatistics()

Specified by:

createHashStatistics in interface PersistenceObjectRegistry

printEntryInstanceSizeInfo

public static final void printEntryInstanceSizeInfo()