org.apache.lucene.util.collections
Class ObjectToIntMap<K>

java.lang.Object
  org.apache.lucene.util.collections.ObjectToIntMap<K>

public class ObjectToIntMap<K>
extends Object

An Array-based hashtable which maps Objects of generic type T to primitive int values.
The hashtable is constructed with a given capacity, or 16 as a default. In case there's not enough room for new pairs, the hashtable grows.
Capacity is adjusted to a power of 2, and there are 2 * capacity entries for the hash. The pre allocated arrays (for keys, values) are at length of capacity + 1, when index 0 is used as 'Ground' or 'NULL'.
The arrays are allocated ahead of hash operations, and form an 'empty space' list, to which the key,value pair is allocated.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

ObjectToIntMap()
Constructs a map with default capacity.

ObjectToIntMap(int capacity)
Constructs a map with given capacity.

Method Summary

protected int	calcBaseHashIndex(K key) Calculating the baseHash index using the internal hashFactor.
void	clear() Empties the map.
boolean	containsKey(K key) Checks if a given key exists in the map.
boolean	containsValue(int o) Checks if the given object exists in the map. This method iterates over the collection, trying to find an equal object.
boolean	equals(Object o)
protected int	find(K key) Find the actual index of a given key.
int	get(K key) Returns the int mapped with the given key.
protected void	grow() Grows the map.
int	hashCode()
boolean	isEmpty()
IntIterator	iterator() Returns a new iterator for the mapped objects.
Iterator<K>	keyIterator()
int	put(K key, int e) Inserts the <key,value> pair into the map.
int	remove(K key) Removes a <key,value> pair from the map and returns the mapped value, or 0 if the none existed.
int	size()
int[]	toArray() Translates the mapped pairs' values into an array of Objects
int[]	toArray(int[] a) Translates the mapped pairs' values into an array of T
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectToIntMap

public ObjectToIntMap()

Constructs a map with default capacity.

ObjectToIntMap

public ObjectToIntMap(int capacity)

Constructs a map with given capacity. Capacity is adjusted to a native power of 2, with minimum of 16.

Parameters:

capacity - minimum capacity for the map.

Method Detail

calcBaseHashIndex

protected int calcBaseHashIndex(K key)

Calculating the baseHash index using the internal hashFactor.

Parameters:

key -

clear

public void clear()

Empties the map. Generates the "Empty" space list for later allocation.

containsKey

public boolean containsKey(K key)

Checks if a given key exists in the map.

Parameters:

key - that is checked against the map data.

Returns:

true if the key exists in the map. false otherwise.

containsValue

public boolean containsValue(int o)

Checks if the given object exists in the map.
This method iterates over the collection, trying to find an equal object.

Parameters:

o - object that is checked against the map data.

Returns:

true if the object exists in the map (in .equals() meaning). false otherwise.

find

protected int find(K key)

Find the actual index of a given key.

Parameters:

key -

Returns:

index of the key. zero if the key wasn't found.

get

public int get(K key)

Returns the int mapped with the given key.

Parameters:

key - int who's mapped object we're interested in.

Returns:

an object mapped by the given key. null if the key wasn't found.

grow

protected void grow()

Grows the map. Allocates a new map of double the capacity, and fast-insert the old key-value pairs.

isEmpty

public boolean isEmpty()

Returns:

true if the map is empty. false otherwise.

iterator

public IntIterator iterator()

Returns a new iterator for the mapped objects.

keyIterator

public Iterator<K> keyIterator()

put

public int put(K key,
               int e)

Inserts the <key,value> pair into the map. If the key already exists, this method updates the mapped value to the given one, returning the old mapped value.

Returns:

the old mapped value, or 0 if the key didn't exist.

remove

public int remove(K key)

Removes a <key,value> pair from the map and returns the mapped value, or 0 if the none existed.

Parameters:

key - used to find the value to remove

Returns:

the removed value or 0 if none existed.

size

public int size()

Returns:

number of pairs currently in the map

toArray

public int[] toArray()

Translates the mapped pairs' values into an array of Objects

Returns:

an object array of all the values currently in the map.

toArray

public int[] toArray(int[] a)

Translates the mapped pairs' values into an array of T

Parameters:

a - the array into which the elements of the list are to be stored, if it is big enough; otherwise, use as much space as it can.

Returns:

an array containing the elements of the list

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object