gnu.trove

Class TIntObjectHashMap

public class TIntObjectHashMap extends TIntHash implements Serializable

An open addressed Map implementation for int keys and Object values. Created: Sun Nov 4 08:52:45 2001

Version: $Id: TIntObjectHashMap.java,v 1.14 2003/03/19 04:17:04 ericdf Exp $

Author: Eric D. Friedman

Nested Class Summary
static classTIntObjectHashMap.EqProcedure
classTIntObjectHashMap.HashProcedure
Field Summary
protected Object[]_values
the values of the map
Constructor Summary
TIntObjectHashMap()
Creates a new TIntObjectHashMap instance with the default capacity and load factor.
TIntObjectHashMap(int initialCapacity)
Creates a new TIntObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TIntObjectHashMap(int initialCapacity, float loadFactor)
Creates a new TIntObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TIntObjectHashMap(TIntHashingStrategy strategy)
Creates a new TIntObjectHashMap instance with the default capacity and load factor.
TIntObjectHashMap(int initialCapacity, TIntHashingStrategy strategy)
Creates a new TIntObjectHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TIntObjectHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy)
Creates a new TIntObjectHashMap instance with a prime value at or near the specified capacity and load factor.
Method Summary
voidclear()
Empties the map.
Objectclone()
booleancontainsKey(int key)
checks for the present of key in the keys of the map.
booleancontainsValue(Object val)
checks for the presence of val in the values of the map.
booleanequals(Object other)
Compares this map with another map for equality of their stored entries.
booleanforEachEntry(TIntObjectProcedure procedure)
Executes procedure for each key/value entry in the map.
booleanforEachKey(TIntProcedure procedure)
Executes procedure for each key in the map.
booleanforEachValue(TObjectProcedure procedure)
Executes procedure for each value in the map.
Objectget(int key)
retrieves the value for key
Object[]getValues()
Returns the values of the map.
inthashCode()
TIntObjectIteratoriterator()
int[]keys()
returns the keys of the map.
Objectput(int key, Object value)
Inserts a key/value pair into the map.
voidreadObject(ObjectInputStream stream)
protected voidrehash(int newCapacity)
rehashes the map to the new capacity.
Objectremove(int key)
Deletes a key/value pair from the map.
protected voidremoveAt(int index)
removes the mapping at index from the map.
booleanretainEntries(TIntObjectProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.
protected intsetUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
voidtransformValues(TObjectFunction function)
Transform the values in this map using function.
voidwriteObject(ObjectOutputStream stream)

Field Detail

_values

protected transient Object[] _values
the values of the map

Constructor Detail

TIntObjectHashMap

public TIntObjectHashMap()
Creates a new TIntObjectHashMap instance with the default capacity and load factor.

TIntObjectHashMap

public TIntObjectHashMap(int initialCapacity)
Creates a new TIntObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

Parameters: initialCapacity an int value

TIntObjectHashMap

public TIntObjectHashMap(int initialCapacity, float loadFactor)
Creates a new TIntObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

Parameters: initialCapacity an int value loadFactor a float value

TIntObjectHashMap

public TIntObjectHashMap(TIntHashingStrategy strategy)
Creates a new TIntObjectHashMap instance with the default capacity and load factor.

Parameters: strategy used to compute hash codes and to compare keys.

TIntObjectHashMap

public TIntObjectHashMap(int initialCapacity, TIntHashingStrategy strategy)
Creates a new TIntObjectHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.

Parameters: initialCapacity an int value strategy used to compute hash codes and to compare keys.

TIntObjectHashMap

public TIntObjectHashMap(int initialCapacity, float loadFactor, TIntHashingStrategy strategy)
Creates a new TIntObjectHashMap instance with a prime value at or near the specified capacity and load factor.

Parameters: initialCapacity used to find a prime capacity for the table. loadFactor used to calculate the threshold over which rehashing takes place. strategy used to compute hash codes and to compare keys.

Method Detail

clear

public void clear()
Empties the map.

clone

public Object clone()

Returns: a deep clone of this collection

containsKey

public boolean containsKey(int key)
checks for the present of key in the keys of the map.

Parameters: key an int value

Returns: a boolean value

containsValue

public boolean containsValue(Object val)
checks for the presence of val in the values of the map.

Parameters: val an Object value

Returns: a boolean value

equals

public boolean equals(Object other)
Compares this map with another map for equality of their stored entries.

Parameters: other an Object value

Returns: a boolean value

forEachEntry

public boolean forEachEntry(TIntObjectProcedure procedure)
Executes procedure for each key/value entry in the map.

Parameters: procedure a TOIntObjectProcedure value

Returns: false if the loop over the entries terminated because the procedure returned false for some entry.

forEachKey

public boolean forEachKey(TIntProcedure procedure)
Executes procedure for each key in the map.

Parameters: procedure a TIntProcedure value

Returns: false if the loop over the keys terminated because the procedure returned false for some key.

forEachValue

public boolean forEachValue(TObjectProcedure procedure)
Executes procedure for each value in the map.

Parameters: procedure a TObjectProcedure value

Returns: false if the loop over the values terminated because the procedure returned false for some value.

get

public Object get(int key)
retrieves the value for key

Parameters: key an int value

Returns: the value of key or null if no such mapping exists.

getValues

public Object[] getValues()
Returns the values of the map.

Returns: a Collection value

hashCode

public int hashCode()

iterator

public TIntObjectIterator iterator()

Returns: a TIntObjectIterator with access to this map's keys and values

keys

public int[] keys()
returns the keys of the map.

Returns: a Set value

put

public Object put(int key, Object value)
Inserts a key/value pair into the map.

Parameters: key an int value value an Object value

Returns: the previous value associated with key, or null if none was found.

readObject

private void readObject(ObjectInputStream stream)

rehash

protected void rehash(int newCapacity)
rehashes the map to the new capacity.

Parameters: newCapacity an int value

remove

public Object remove(int key)
Deletes a key/value pair from the map.

Parameters: key an int value

Returns: an Object value

removeAt

protected void removeAt(int index)
removes the mapping at index from the map.

Parameters: index an int value

retainEntries

public boolean retainEntries(TIntObjectProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.

Parameters: procedure determines which entries to keep

Returns: true if the map was modified.

setUp

protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.

Parameters: initialCapacity an int value

Returns: the actual capacity chosen

transformValues

public void transformValues(TObjectFunction function)
Transform the values in this map using function.

Parameters: function a TObjectFunction value

writeObject

private void writeObject(ObjectOutputStream stream)