Package gnu.trove

Class TObjectShortHashMap<K>

java.lang.Object
gnu.trove.THash
gnu.trove.TObjectHash<K>
gnu.trove.TObjectShortHashMap<K>
All Implemented Interfaces:
TObjectHashingStrategy<K>, Externalizable, Serializable, Cloneable
public class TObjectShortHashMap<K> extends TObjectHash<K> implements Externalizable
An open addressed Map implementation for Object keys and short values. Created: Sun Nov 4 08:52:45 2001
Author:
Eric D. Friedman
See Also:

  • Field Details

    • _values

      protected transient short[] _values
      the values of the map

  • Constructor Details

    • TObjectShortHashMap

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

    • TObjectShortHashMap

      public TObjectShortHashMap(int initialCapacity)
      Creates a new TObjectShortHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
      Parameters:
      initialCapacity - an int value

    • TObjectShortHashMap

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

    • TObjectShortHashMap

      public TObjectShortHashMap(TObjectHashingStrategy<K> strategy)
      Creates a new TObjectShortHashMap instance with the default capacity and load factor.
      Parameters:
      strategy - used to compute hash codes and to compare keys.

    • TObjectShortHashMap

      public TObjectShortHashMap(int initialCapacity, TObjectHashingStrategy<K> strategy)
      Creates a new TObjectShortHashMap 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.

    • TObjectShortHashMap

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

    • iterator

      public TObjectShortIterator<K> iterator()
      Returns:
      an iterator over the entries in this map

    • setUp

      protected int setUp(int initialCapacity)
      initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
      Overrides:
      setUp in class TObjectHash<K>
      Parameters:
      initialCapacity - an int value
      Returns:
      the actual capacity chosen

    • put

      public short put(K key, short value)
      Inserts a key/value pair into the map.
      Parameters:
      key - an Object value
      value - an short value
      Returns:
      the previous value associated with key, or (short)0 if none was found.

    • putIfAbsent

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

    • putAll

      public void putAll(TObjectShortHashMap<K> 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 short get(K key)
      retrieves the value for key
      Parameters:
      key - an Object 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 short remove(K key)
      Deletes a key/value pair from the map.
      Parameters:
      key - an Object value
      Returns:
      an short 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

    • clone

      public TObjectShortHashMap<K> clone()
      Overrides:
      clone in class TObjectHash<K>
      Returns:
      a shallow clone of this collection

    • removeAt

      protected void removeAt(int index)
      removes the mapping at index from the map.
      Overrides:
      removeAt in class TObjectHash<K>
      Parameters:
      index - an int value

    • getValues

      public short[] getValues()
      Returns the values of the map.
      Returns:
      a Collection value

    • keys

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

    • keys

      public K[] keys(K[] 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 runtime type is allocated for this purpose.
      Returns:
      a Set value

    • containsValue

      public boolean containsValue(short val)
      checks for the presence of val in the values of the map.
      Parameters:
      val - an short value
      Returns:
      a boolean value

    • containsKey

      public boolean containsKey(K key)
      checks for the present of key in the keys of the map.
      Parameters:
      key - an Object value
      Returns:
      a boolean value

    • forEachKey

      public boolean forEachKey(TObjectProcedure<K> procedure)
      Executes procedure for each key in the map.
      Parameters:
      procedure - a TObjectProcedure value
      Returns:
      false if the loop over the keys terminated because the procedure returned false for some key.

    • forEachValue

      public boolean forEachValue(TShortProcedure procedure)
      Executes procedure for each value in the map.
      Parameters:
      procedure - a TShortProcedure value
      Returns:
      false if the loop over the values terminated because the procedure returned false for some value.

    • forEachEntry

      public boolean forEachEntry(TObjectShortProcedure<K> procedure)
      Executes procedure for each key/value entry in the map.
      Parameters:
      procedure - a TOObjectShortProcedure value
      Returns:
      false if the loop over the entries terminated because the procedure returned false for some entry.

    • retainEntries

      public boolean retainEntries(TObjectShortProcedure<K> 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(TShortFunction function)
      Transform the values in this map using function.
      Parameters:
      function - a TShortFunction value

    • increment

      public boolean increment(K key)
      Increments the primitive value mapped to key by 1
      Parameters:
      key - the key of the value to increment
      Returns:
      true if a mapping was found and modified.

    • adjustValue

      public boolean adjustValue(K key, short amount)
      Adjusts the primitive value mapped to key.
      Parameters:
      key - the key of the value to increment
      amount - the amount to adjust the value by.
      Returns:
      true if a mapping was found and modified.

    • adjustOrPutValue

      public short adjustOrPutValue(K key, short adjust_amount, short put_amount)
      Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.
      Parameters:
      key - the key of the value to increment
      adjust_amount - the amount to adjust the value by
      put_amount - the value put into the map if the key is not initial present
      Returns:
      the value present in the map after the adjustment or put operation
      Since:
      2.0b1

    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Overrides:
      writeExternal in class TObjectHash<K>
      Throws:
      IOException

    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Overrides:
      readExternal in class TObjectHash<K>
      Throws:
      IOException
      ClassNotFoundException

    • toString

      public String toString()
      Overrides:
      toString in class Object