openlr.collection

Class OpenAbstractCollection

java.lang.Object

cern.colt.PersistentObject

cern.colt.map.AbstractMap

openlr.collection.OpenAbstractCollection

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

OpenLongHashSet, OpenLongIntHashMap

public abstract class OpenAbstractCollection
extends AbstractMap

Overrides many methods for performance reasons only.

Author:

TomTom International B.V.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte	FREE The Constant FREE.
protected int	freeEntries The number of table entries in state==FREE.
protected static byte	FULL The Constant FULL.
protected static byte	REMOVED The Constant REMOVED.
protected byte[]	state The state of each hash table entry (FREE, FULL, REMOVED).
protected long[]	table The hash table keys.

Fields inherited from class cern.colt.map.AbstractMap

defaultCapacity, defaultMaxLoadFactor, defaultMinLoadFactor, distinct, highWaterMark, lowWaterMark, maxLoadFactor, minLoadFactor

Constructor Summary

Constructors

Constructor and Description
OpenAbstractCollection()

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(long key) Returns true if the receiver contains the specified key.
void	ensureCapacity(int minCapacity) Ensures that the receiver can hold at least the specified number of associations without needing to allocate new internal memory.
boolean	forEachKey(LongProcedure procedure) Applies a procedure to each key of the receiver, if any.
protected int	indexOfInsertion(long key)
protected int	indexOfKey(long key)
void	trimToSize() Trims the capacity of the receiver to be the receiver's current size.

Methods inherited from class cern.colt.map.AbstractMap

chooseGrowCapacity, chooseHighWaterMark, chooseLowWaterMark, chooseMeanCapacity, chooseShrinkCapacity, clear, isEmpty, nextPrime, setUp, size

Methods inherited from class cern.colt.PersistentObject

clone

Methods inherited from class java.lang.Object

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

Field Detail

FREE

protected static final byte FREE

The Constant FREE.

See Also:

Constant Field Values

FULL

protected static final byte FULL

The Constant FULL.

See Also:

Constant Field Values

REMOVED

protected static final byte REMOVED

The Constant REMOVED.

See Also:

Constant Field Values

table

protected long[] table

The hash table keys.

state

protected byte[] state

The state of each hash table entry (FREE, FULL, REMOVED).

freeEntries

protected int freeEntries

The number of table entries in state==FREE.

Constructor Detail

OpenAbstractCollection

public OpenAbstractCollection()

Method Detail

containsKey

public final boolean containsKey(long key)

Returns true if the receiver contains the specified key.

Parameters:

key - the key

Returns:

true if the receiver contains the specified key.

ensureCapacity

public final void ensureCapacity(int minCapacity)

Ensures that the receiver can hold at least the specified number of associations without needing to allocate new internal memory. If necessary, allocates new internal memory and increases the capacity of the receiver.

This method never need be called; it is for performance tuning only. Calling this method before put()ing a large number of associations boosts performance, because the receiver will grow only once instead of potentially many times and hash collisions get less probable.

Overrides:

ensureCapacity in class AbstractMap

Parameters:

minCapacity - the desired minimum capacity.

forEachKey

public final boolean forEachKey(LongProcedure procedure)

Applies a procedure to each key of the receiver, if any. Note: Iterates over the keys in no particular order. Subclasses can define a particular order, for example, "sorted by key". All methods which can be expressed in terms of this method (most methods can) must guarantee to use the same order defined by this method, even if it is no particular order. This is necessary so that, for example, methods keys and values will yield association pairs, not two uncorrelated lists.

Parameters:

procedure - the procedure to be applied. Stops iteration if the procedure returns false, otherwise continues.

Returns:

false if the procedure stopped before all keys where iterated over, true otherwise.

indexOfInsertion

protected final int indexOfInsertion(long key)

Parameters:

key - the key to be added to the receiver.

Returns:

the index where the key would need to be inserted, if it is not already contained. Returns -index-1 if the key is already contained at slot index. Therefore, if the returned index < 0, then it is already contained at slot -index-1. If the returned index >= 0, then it is NOT already contained and should be inserted at slot index.

indexOfKey

protected final int indexOfKey(long key)

Parameters:

key - the key to be searched in the receiver.

Returns:

the index where the key is contained in the receiver, returns -1 if the key was not found.

trimToSize

public final void trimToSize()

Trims the capacity of the receiver to be the receiver's current size. Releases any superfluous internal memory. An application can use this operation to minimize the storage of the receiver.

Overrides:

trimToSize in class AbstractMap