GNU Trove

gnu.trove
Class TShortObjectHashMap

java.lang.Object
  extended bygnu.trove.THash
      extended bygnu.trove.TPrimitiveHash
          extended bygnu.trove.TShortHash
              extended bygnu.trove.TShortObjectHashMap
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, TShortHashingStrategy

public class TShortObjectHashMap
extends TShortHash
implements java.io.Serializable

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

Version:
$Id: TShortObjectHashMap.java,v 1.2 2005/03/26 17:52:56 ericdf Exp $
Author:
Eric D. Friedman
See Also:
Serialized Form

Field Summary
protected  java.lang.Object[] _values
          the values of the map
 
Fields inherited from class gnu.trove.TShortHash
_hashingStrategy, _set
 
Fields inherited from class gnu.trove.TPrimitiveHash
_states, FREE, FULL, REMOVED
 
Fields inherited from class gnu.trove.THash
_free, _loadFactor, _maxSize, _size, DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR
 
Constructor Summary
TShortObjectHashMap()
          Creates a new TShortObjectHashMap instance with the default capacity and load factor.
TShortObjectHashMap(int initialCapacity)
          Creates a new TShortObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TShortObjectHashMap(int initialCapacity, float loadFactor)
          Creates a new TShortObjectHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TShortObjectHashMap(int initialCapacity, float loadFactor, TShortHashingStrategy strategy)
          Creates a new TShortObjectHashMap instance with a prime value at or near the specified capacity and load factor.
TShortObjectHashMap(int initialCapacity, TShortHashingStrategy strategy)
          Creates a new TShortObjectHashMap instance whose capacity is the next highest prime above initialCapacity + 1 unless that value is already prime.
TShortObjectHashMap(TShortHashingStrategy strategy)
          Creates a new TShortObjectHashMap instance with the default capacity and load factor.
 
Method Summary
 void clear()
          Empties the map.
 java.lang.Object clone()
           
 boolean containsKey(short key)
          checks for the present of key in the keys of the map.
 boolean containsValue(java.lang.Object val)
          checks for the presence of val in the values of the map.
 boolean equals(java.lang.Object other)
          Compares this map with another map for equality of their stored entries.
 boolean forEachEntry(TShortObjectProcedure procedure)
          Executes procedure for each key/value entry in the map.
 boolean forEachKey(TShortProcedure procedure)
          Executes procedure for each key in the map.
 boolean forEachValue(TObjectProcedure procedure)
          Executes procedure for each value in the map.
 java.lang.Object get(short key)
          retrieves the value for key
 java.lang.Object[] getValues()
          Returns the values of the map.
 int hashCode()
           
 TShortObjectIterator iterator()
           
 short[] keys()
          returns the keys of the map.
 java.lang.Object put(short key, java.lang.Object value)
          Inserts a key/value pair into the map.
protected  void rehash(int newCapacity)
          rehashes the map to the new capacity.
 java.lang.Object remove(short key)
          Deletes a key/value pair from the map.
protected  void removeAt(int index)
          removes the mapping at index from the map.
 boolean retainEntries(TShortObjectProcedure procedure)
          Retains only those entries in the map for which the procedure returns a true value.
protected  int setUp(int initialCapacity)
          initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
 void transformValues(TObjectFunction function)
          Transform the values in this map using function.
 
Methods inherited from class gnu.trove.TShortHash
computeHashCode, contains, forEach, index, insertionIndex
 
Methods inherited from class gnu.trove.TPrimitiveHash
capacity
 
Methods inherited from class gnu.trove.THash
compact, ensureCapacity, isEmpty, postInsertHook, size, trimToSize
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_values

protected transient java.lang.Object[] _values
the values of the map

Constructor Detail

TShortObjectHashMap

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


TShortObjectHashMap

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

Parameters:
initialCapacity - an int value

TShortObjectHashMap

public TShortObjectHashMap(int initialCapacity,
                           float loadFactor)
Creates a new TShortObjectHashMap 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

TShortObjectHashMap

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

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

TShortObjectHashMap

public TShortObjectHashMap(int initialCapacity,
                           TShortHashingStrategy strategy)
Creates a new TShortObjectHashMap 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.

TShortObjectHashMap

public TShortObjectHashMap(int initialCapacity,
                           float loadFactor,
                           TShortHashingStrategy strategy)
Creates a new TShortObjectHashMap 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

clone

public java.lang.Object clone()
Overrides:
clone in class TShortHash
Returns:
a deep clone of this collection

iterator

public TShortObjectIterator iterator()
Returns:
a TShortObjectIterator with access to this map's keys and values

setUp

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

Overrides:
setUp in class TShortHash
Parameters:
initialCapacity - an int value
Returns:
the actual capacity chosen

put

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

Parameters:
key - an short value
value - an Object value
Returns:
the previous value associated with key, or null if none was found.

rehash

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

Specified by:
rehash in class THash
Parameters:
newCapacity - an int value

get

public java.lang.Object get(short key)
retrieves the value for key

Parameters:
key - an short value
Returns:
the value of key or null if no such mapping exists.

clear

public void clear()
Empties the map.

Overrides:
clear in class THash

remove

public java.lang.Object remove(short key)
Deletes a key/value pair from the map.

Parameters:
key - an short value
Returns:
an Object value, or null if no mapping for key exists

equals

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

Parameters:
other - an Object value
Returns:
a boolean value

hashCode

public int hashCode()

removeAt

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

Overrides:
removeAt in class TShortHash
Parameters:
index - an int value

getValues

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

Returns:
a Collection value

keys

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

Returns:
a Set value

containsValue

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

Parameters:
val - an Object value
Returns:
a boolean value

containsKey

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

Parameters:
key - an short value
Returns:
a boolean value

forEachKey

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

Parameters:
procedure - a TShortProcedure 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.

forEachEntry

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

Parameters:
procedure - a TOShortObjectProcedure value
Returns:
false if the loop over the entries terminated because the procedure returned false for some entry.

retainEntries

public boolean retainEntries(TShortObjectProcedure 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.

transformValues

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

Parameters:
function - a TObjectFunction value

GNU Trove

GNU Trove is copyright © 2001-2005 Eric D. Friedman. All Rights Reserved.