Package gnu.trove

Class TShortObjectHashMap<V>

All Implemented Interfaces:
TShortHashingStrategy, Externalizable, Serializable, Cloneable

public class TShortObjectHashMap<V> extends TShortHash implements Externalizable
An open addressed Map implementation for short keys and Object values. Created: Sun Nov 4 08:52:45 2001
Author:
Eric D. Friedman
See Also:
  • Field Details

    • _values

      protected transient V[] _values
      the values of the map
  • Constructor Details

    • 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 Details

    • clone

      public TShortObjectHashMap<V> clone()
      Overrides:
      clone in class TShortHash
      Returns:
      a deep clone of this collection
    • iterator

      public TShortObjectIterator<V> 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 V put(short key, V 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.
    • putIfAbsent

      public V putIfAbsent(short key, V value)
      Inserts a key/value pair into the map if the specified key is not already associated with a value.
      Parameters:
      key - an short value
      value - an Object value
      Returns:
      the previous value associated with key, or null if none was found.
    • putAll

      public void putAll(TShortObjectHashMap<V> map)
      Put all the entries from the given map into this map.
      Parameters:
      map - The map from which entries will be obtained to put into this map.
    • 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 V get(short key)
      retrieves the value for key
      Parameters:
      key - an short value
      Returns:
      the value of key or (short)0 if no such mapping exists.
    • clear

      public void clear()
      Empties the map.
      Overrides:
      clear in class THash
    • remove

      public V remove(short key)
      Deletes a key/value pair from the map.
      Parameters:
      key - an short value
      Returns:
      an Object value or (short)0 if no such mapping exists.
    • equals

      public boolean equals(Object other)
      Compares this map with another map for equality of their stored entries.
      Overrides:
      equals in class Object
      Parameters:
      other - an Object value
      Returns:
      a boolean value
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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 Object[] getValues()
      Returns the values of the map.
      Returns:
      a Collection value
      See Also:
    • getValues

      public <T> T[] getValues(T[] a)
      Return the values of the map; the runtime type of the returned array is that of the specified array.
      Parameters:
      a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
      Returns:
      an array containing the elements of this collection
      Throws:
      ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.
      NullPointerException - if the specified array is null.
      See Also:
    • keys

      public short[] keys()
      returns the keys of the map.
      Returns:
      a Set value
    • keys

      public short[] keys(short[] a)
      returns the keys of the map.
      Parameters:
      a - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
      Returns:
      a Set value
    • containsValue

      public boolean containsValue(V 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<V> 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<V> 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<V> 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<V,V> function)
      Transform the values in this map using function.
      Parameters:
      function - a TObjectFunction value
    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Overrides:
      writeExternal in class THash
      Throws:
      IOException
    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Overrides:
      readExternal in class THash
      Throws:
      IOException
      ClassNotFoundException
    • toString

      public String toString()
      Overrides:
      toString in class Object