Class Reference2ShortArrayMap<K>

java.lang.Object
All Implemented Interfaces:
Function<K,​java.lang.Short>, Reference2ShortFunction<K>, Reference2ShortMap<K>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<K,​java.lang.Short>, java.util.function.ToIntFunction<K>, java.util.Map<K,​java.lang.Short>

public class Reference2ShortArrayMap<K>
extends AbstractReference2ShortMap<K>
implements java.io.Serializable, java.lang.Cloneable
A simple, brute-force implementation of a map based on two parallel backing arrays.

The main purpose of this implementation is that of wrapping cleanly the brute-force approach to the storage of a very small number of pairs: just put them into two parallel arrays and scan linearly to find an item.

See Also:
Serialized Form
  • Constructor Details

    • Reference2ShortArrayMap

      public Reference2ShortArrayMap​(java.lang.Object[] key, short[] value)
      Creates a new empty array map with given key and value backing arrays. The resulting map will have as many entries as the given arrays.

      It is responsibility of the caller that the elements of key are distinct.

      Parameters:
      key - the key array.
      value - the value array (it must have the same length as key).
    • Reference2ShortArrayMap

      public Reference2ShortArrayMap()
      Creates a new empty array map.
    • Reference2ShortArrayMap

      public Reference2ShortArrayMap​(int capacity)
      Creates a new empty array map of given capacity.
      Parameters:
      capacity - the initial capacity.
    • Reference2ShortArrayMap

      public Reference2ShortArrayMap​(Reference2ShortMap<K> m)
      Creates a new empty array map copying the entries of a given map.
      Parameters:
      m - a map.
    • Reference2ShortArrayMap

      public Reference2ShortArrayMap​(java.util.Map<? extends K,​? extends java.lang.Short> m)
      Creates a new empty array map copying the entries of a given map.
      Parameters:
      m - a map.
    • Reference2ShortArrayMap

      public Reference2ShortArrayMap​(java.lang.Object[] key, short[] value, int size)
      Creates a new array map with given key and value backing arrays, using the given number of elements.

      It is responsibility of the caller that the first size elements of key are distinct.

      Parameters:
      key - the key array.
      value - the value array (it must have the same length as key).
      size - the number of valid elements in key and value.
  • Method Details

    • reference2ShortEntrySet

      public Reference2ShortMap.FastEntrySet<K> reference2ShortEntrySet()
      Description copied from interface: Reference2ShortMap
      Returns a type-specific set view of the mappings contained in this map.

      This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Map.entrySet() so that it returns an ObjectSet of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).

      Specified by:
      reference2ShortEntrySet in interface Reference2ShortMap<K>
      Returns:
      a type-specific set view of the mappings contained in this map.
      See Also:
      Map.entrySet()
    • getShort

      public short getShort​(java.lang.Object k)
      Description copied from interface: Reference2ShortFunction
      Returns the value to which the given key is mapped.
      Specified by:
      getShort in interface Reference2ShortFunction<K>
      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)
    • size

      public int size()
      Description copied from interface: Reference2ShortMap
      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,​java.lang.Short>
      Specified by:
      size in interface java.util.Map<K,​java.lang.Short>
      Specified by:
      size in interface Reference2ShortMap<K>
      Returns:
      the number of key-value mappings in this map.
      See Also:
      Size64
    • clear

      public void clear()
      Description copied from interface: Reference2ShortMap
      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,​java.lang.Short>
      Specified by:
      clear in interface java.util.Map<K,​java.lang.Short>
      Specified by:
      clear in interface Reference2ShortMap<K>
      See Also:
      Map.clear()
    • containsKey

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

      public boolean containsValue​(short v)
      Description copied from class: AbstractReference2ShortMap
      Returns true if this map maps one or more keys to the specified value.
      Specified by:
      containsValue in interface Reference2ShortMap<K>
      Overrides:
      containsValue in class AbstractReference2ShortMap<K>
      See Also:
      Map.containsValue(Object)
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface java.util.Map<K,​java.lang.Short>
      Overrides:
      isEmpty in class AbstractReference2ShortMap<K>
    • put

      public short put​(K k, short v)
      Description copied from interface: Reference2ShortFunction
      Adds a pair to the map (optional operation).
      Specified by:
      put in interface Reference2ShortFunction<K>
      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)
    • removeShort

      public short removeShort​(java.lang.Object k)
      Description copied from interface: Reference2ShortFunction
      Removes the mapping with the given key (optional operation).
      Specified by:
      removeShort in interface Reference2ShortFunction<K>
      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)
    • keySet

      public ReferenceSet<K> keySet()
      Description copied from class: AbstractReference2ShortMap
      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.

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

      public ShortCollection values()
      Description copied from class: AbstractReference2ShortMap
      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.

      Specified by:
      values in interface java.util.Map<K,​java.lang.Short>
      Specified by:
      values in interface Reference2ShortMap<K>
      Overrides:
      values in class AbstractReference2ShortMap<K>
      Returns:
      a set view of the values of this map; it may be safely cast to a type-specific interface.
      See Also:
      Map.values()
    • clone

      public Reference2ShortArrayMap<K> 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.