Class Object2ObjectLinkedOpenCustomHashMap<K,​V>

java.lang.Object
All Implemented Interfaces:
Function<K,​V>, Hash, Object2ObjectFunction<K,​V>, Object2ObjectMap<K,​V>, Object2ObjectSortedMap<K,​V>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<K,​V>, java.util.Map<K,​V>, java.util.SortedMap<K,​V>

public class Object2ObjectLinkedOpenCustomHashMap<K,​V>
extends AbstractObject2ObjectSortedMap<K,​V>
implements java.io.Serializable, java.lang.Cloneable, Hash
A type-specific linked hash map with with a fast, small-footprint implementation.

Instances of this class use a hash table to represent a map. The table is filled up to a specified load factor, and then doubled in size to accommodate new entries. If the table is emptied below one fourth of the load factor, it is halved in size; however, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create maps with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would interfere with the iteration process.

Note that clear() does not modify the hash table size. Rather, a family of trimming methods lets you control the size of the table; this is particularly useful if you reuse instances of this class.

Entries returned by the type-specific Object2ObjectMap.entrySet() method implement the suitable type-specific Pair interface; only values are mutable.

Iterators generated by this map will enumerate pairs in the same order in which they have been added to the map (addition of pairs whose key is already present in the map does not change the iteration order). Note that this order has nothing in common with the natural order of the keys. The order is kept by means of a doubly linked list, represented via an array of longs parallel to the table.

This class implements the interface of a sorted map, so to allow easy access of the iteration order: for instance, you can get the first key in iteration order with firstKey() without having to create an iterator; however, this class partially violates the SortedMap contract because all submap methods throw an exception and comparator() returns always null.

Additional methods, such as getAndMoveToFirst(), make it easy to use instances of this class as a cache (e.g., with LRU policy).

The iterators provided by the views of this class using are type-specific list iterators, and can be started at any element which is a key of the map, or a NoSuchElementException exception will be thrown. If, however, the provided element is not the first or last key in the map, the first access to the list index will require linear time, as in the worst case the entire key set must be scanned in iteration order to retrieve the positional index of the starting key. If you use just the methods of a type-specific BidirectionalIterator, however, all operations will be performed in constant time.

See Also:
Hash, HashCommon, Serialized Form
  • Constructor Details

    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(int expected, float f, Hash.Strategy<? super K> strategy)
      Creates a new hash map.

      The actual table size will be the least power of two greater than expected/f.

      Parameters:
      expected - the expected number of elements in the hash map.
      f - the load factor.
      strategy - the strategy.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(int expected, Hash.Strategy<? super K> strategy)
      Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.
      Parameters:
      expected - the expected number of elements in the hash map.
      strategy - the strategy.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(Hash.Strategy<? super K> strategy)
      Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.
      Parameters:
      strategy - the strategy.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(java.util.Map<? extends K,​? extends V> m, float f, Hash.Strategy<? super K> strategy)
      Creates a new hash map copying a given one.
      Parameters:
      m - a Map to be copied into the new hash map.
      f - the load factor.
      strategy - the strategy.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(java.util.Map<? extends K,​? extends V> m, Hash.Strategy<? super K> strategy)
      Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.
      Parameters:
      m - a Map to be copied into the new hash map.
      strategy - the strategy.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(Object2ObjectMap<K,​V> m, float f, Hash.Strategy<? super K> strategy)
      Creates a new hash map copying a given type-specific one.
      Parameters:
      m - a type-specific map to be copied into the new hash map.
      f - the load factor.
      strategy - the strategy.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(Object2ObjectMap<K,​V> m, Hash.Strategy<? super K> strategy)
      Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.
      Parameters:
      m - a type-specific map to be copied into the new hash map.
      strategy - the strategy.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(K[] k, V[] v, float f, Hash.Strategy<? super K> strategy)
      Creates a new hash map using the elements of two parallel arrays.
      Parameters:
      k - the array of keys of the new hash map.
      v - the array of corresponding values in the new hash map.
      f - the load factor.
      strategy - the strategy.
      Throws:
      java.lang.IllegalArgumentException - if k and v have different lengths.
    • Object2ObjectLinkedOpenCustomHashMap

      public Object2ObjectLinkedOpenCustomHashMap​(K[] k, V[] v, Hash.Strategy<? super K> strategy)
      Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.
      Parameters:
      k - the array of keys of the new hash map.
      v - the array of corresponding values in the new hash map.
      strategy - the strategy.
      Throws:
      java.lang.IllegalArgumentException - if k and v have different lengths.
  • Method Details

    • strategy

      public Hash.Strategy<? super K> strategy()
      Returns the hashing strategy.
      Returns:
      the hashing strategy of this custom hash map.
    • putAll

      public void putAll​(java.util.Map<? extends K,​? extends V> m)
      Description copied from class: AbstractObject2ObjectMap
      Specified by:
      putAll in interface java.util.Map<K,​V>
      Overrides:
      putAll in class AbstractObject2ObjectMap<K,​V>
    • put

      public V put​(K k, V v)
      Description copied from interface: Object2ObjectMap
      Adds a pair to the map (optional operation).

      This default implementation just delegates to the corresponding function method.

      Specified by:
      put in interface Function<K,​V>
      Specified by:
      put in interface java.util.Map<K,​V>
      Specified by:
      put in interface Object2ObjectFunction<K,​V>
      Specified by:
      put in interface Object2ObjectMap<K,​V>
      Parameters:
      k - the key.
      v - the value.
      Returns:
      the old value, or the default return value if no value was present for the given key.
      See Also:
      Function.put(Object,Object)
    • remove

      public V remove​(java.lang.Object k)
      Description copied from interface: Object2ObjectMap
      Removes the mapping with the given key (optional operation).

      This default implementation just delegates to the corresponding type-specific–function method.

      Specified by:
      remove in interface Function<K,​V>
      Specified by:
      remove in interface java.util.Map<K,​V>
      Specified by:
      remove in interface Object2ObjectFunction<K,​V>
      Specified by:
      remove in interface Object2ObjectMap<K,​V>
      Parameters:
      k - the key.
      Returns:
      the old value, or the default return value if no value was present for the given key.
      See Also:
      Function.remove(Object)
    • removeFirst

      public V removeFirst()
      Removes the mapping associated with the first key in iteration order.
      Returns:
      the value previously associated with the first key in iteration order.
      Throws:
      java.util.NoSuchElementException - is this map is empty.
    • removeLast

      public V removeLast()
      Removes the mapping associated with the last key in iteration order.
      Returns:
      the value previously associated with the last key in iteration order.
      Throws:
      java.util.NoSuchElementException - is this map is empty.
    • getAndMoveToFirst

      public V getAndMoveToFirst​(K k)
      Returns the value to which the given key is mapped; if the key is present, it is moved to the first position of the iteration order.
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or the default return value if no value was present for the given key.
    • getAndMoveToLast

      public V getAndMoveToLast​(K k)
      Returns the value to which the given key is mapped; if the key is present, it is moved to the last position of the iteration order.
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or the default return value if no value was present for the given key.
    • putAndMoveToFirst

      public V putAndMoveToFirst​(K k, V v)
      Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
      Parameters:
      k - the key.
      v - the value.
      Returns:
      the old value, or the default return value if no value was present for the given key.
    • putAndMoveToLast

      public V putAndMoveToLast​(K k, V v)
      Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.
      Parameters:
      k - the key.
      v - the value.
      Returns:
      the old value, or the default return value if no value was present for the given key.
    • get

      public V get​(java.lang.Object k)
      Description copied from interface: Object2ObjectFunction
      Returns the value to which the given key is mapped.
      Specified by:
      get in interface Function<K,​V>
      Specified by:
      get in interface java.util.Map<K,​V>
      Specified by:
      get in interface Object2ObjectFunction<K,​V>
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or the default return value if no value was present for the given key.
      See Also:
      Function.get(Object)
    • containsKey

      public boolean containsKey​(java.lang.Object k)
      Description copied from class: AbstractObject2ObjectMap
      Returns true if this function contains a mapping for the specified key.
      Specified by:
      containsKey in interface Function<K,​V>
      Specified by:
      containsKey in interface java.util.Map<K,​V>
      Specified by:
      containsKey in interface Object2ObjectMap<K,​V>
      Overrides:
      containsKey in class AbstractObject2ObjectMap<K,​V>
      Parameters:
      k - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
      Map.containsKey(Object)
    • containsValue

      public boolean containsValue​(java.lang.Object v)
      Description copied from class: AbstractObject2ObjectMap
      Specified by:
      containsValue in interface java.util.Map<K,​V>
      Overrides:
      containsValue in class AbstractObject2ObjectMap<K,​V>
    • clear

      public void clear()
      Description copied from interface: Object2ObjectMap
      Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
      Specified by:
      clear in interface Function<K,​V>
      Specified by:
      clear in interface java.util.Map<K,​V>
      Specified by:
      clear in interface Object2ObjectMap<K,​V>
      See Also:
      Map.clear()
    • size

      public int size()
      Description copied from interface: Object2ObjectMap
      Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
      Specified by:
      size in interface Function<K,​V>
      Specified by:
      size in interface java.util.Map<K,​V>
      Specified by:
      size in interface Object2ObjectMap<K,​V>
      Returns:
      the number of key-value mappings in this map.
      See Also:
      Size64
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface java.util.Map<K,​V>
      Overrides:
      isEmpty in class AbstractObject2ObjectMap<K,​V>
    • firstKey

      public K firstKey()
      Returns the first key of this map in iteration order.
      Specified by:
      firstKey in interface java.util.SortedMap<K,​V>
      Returns:
      the first key in iteration order.
    • lastKey

      public K lastKey()
      Returns the last key of this map in iteration order.
      Specified by:
      lastKey in interface java.util.SortedMap<K,​V>
      Returns:
      the last key in iteration order.
    • tailMap

      public Object2ObjectSortedMap<K,​V> tailMap​(K from)
      Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
      Specified by:
      tailMap in interface Object2ObjectSortedMap<K,​V>
      Specified by:
      tailMap in interface java.util.SortedMap<K,​V>
      See Also:
      SortedMap.tailMap(Object)
      Implementation Specification:
      This implementation just throws an UnsupportedOperationException.
    • headMap

      public Object2ObjectSortedMap<K,​V> headMap​(K to)
      Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
      Specified by:
      headMap in interface Object2ObjectSortedMap<K,​V>
      Specified by:
      headMap in interface java.util.SortedMap<K,​V>
      See Also:
      SortedMap.headMap(Object)
      Implementation Specification:
      This implementation just throws an UnsupportedOperationException.
    • subMap

      public Object2ObjectSortedMap<K,​V> subMap​(K from, K to)
      Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
      Specified by:
      subMap in interface Object2ObjectSortedMap<K,​V>
      Specified by:
      subMap in interface java.util.SortedMap<K,​V>
      See Also:
      SortedMap.subMap(Object,Object)
      Implementation Specification:
      This implementation just throws an UnsupportedOperationException.
    • comparator

      public java.util.Comparator<? super K> comparator()
      Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
      Specified by:
      comparator in interface Object2ObjectSortedMap<K,​V>
      Specified by:
      comparator in interface java.util.SortedMap<K,​V>
      See Also:
      SortedMap.comparator()
      Implementation Specification:
      This implementation just returns null.
    • object2ObjectEntrySet

      public Object2ObjectSortedMap.FastSortedEntrySet<K,​V> object2ObjectEntrySet()
      Description copied from interface: Object2ObjectSortedMap
      Returns a type-specific sorted-set view of the mappings contained in this map.
      Specified by:
      object2ObjectEntrySet in interface Object2ObjectMap<K,​V>
      Specified by:
      object2ObjectEntrySet in interface Object2ObjectSortedMap<K,​V>
      Returns:
      a type-specific sorted-set view of the mappings contained in this map.
      See Also:
      Object2ObjectSortedMap.entrySet()
    • keySet

      public ObjectSortedSet<K> keySet()
      Description copied from class: AbstractObject2ObjectSortedMap
      Returns a type-specific-set view of the keys of this map.

      The view is backed by the set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

      The view is backed by the sorted set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

      Specified by:
      keySet in interface java.util.Map<K,​V>
      Specified by:
      keySet in interface Object2ObjectMap<K,​V>
      Specified by:
      keySet in interface Object2ObjectSortedMap<K,​V>
      Specified by:
      keySet in interface java.util.SortedMap<K,​V>
      Overrides:
      keySet in class AbstractObject2ObjectSortedMap<K,​V>
      Returns:
      a sorted set view of the keys of this map; it may be safely cast to a type-specific interface.
      See Also:
      Map.keySet()
    • values

      public ObjectCollection<V> values()
      Description copied from class: AbstractObject2ObjectSortedMap
      Returns a type-specific-set view of the values of this map.

      The view is backed by the set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

      The view is backed by the sorted set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

      Specified by:
      values in interface java.util.Map<K,​V>
      Specified by:
      values in interface Object2ObjectMap<K,​V>
      Specified by:
      values in interface Object2ObjectSortedMap<K,​V>
      Specified by:
      values in interface java.util.SortedMap<K,​V>
      Overrides:
      values in class AbstractObject2ObjectSortedMap<K,​V>
      Returns:
      a type-specific collection view of the values contained in this map.
      See Also:
      Map.values()
    • trim

      public boolean trim()
      Rehashes the map, making the table as small as possible.

      This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.

      If the table size is already the minimum possible, this method does nothing.

      Returns:
      true if there was enough memory to trim the map.
      See Also:
      trim(int)
    • trim

      public boolean trim​(int n)
      Rehashes this map if the table is too large.

      Let N be the smallest table size that can hold max(n,size()) entries, still satisfying the load factor. If the current table size is smaller than or equal to N, this method does nothing. Otherwise, it rehashes this map in a table of size N.

      This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.

      Parameters:
      n - the threshold for the trimming.
      Returns:
      true if there was enough memory to trim the map.
      See Also:
      trim()
    • clone

      Returns a deep copy of this map.

      This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.

      Returns:
      a deep copy of this map.
    • hashCode

      public int hashCode()
      Returns a hash code for this map. This method overrides the generic method provided by the superclass. Since equals() is not overriden, it is important that the value returned by this method is the same value as the one returned by the overriden method.
      Specified by:
      hashCode in interface java.util.Map<K,​V>
      Overrides:
      hashCode in class AbstractObject2ObjectMap<K,​V>
      Returns:
      a hash code for this map.