Class Byte2ObjectArrayMap<V>

All Implemented Interfaces:
Byte2ObjectFunction<V>, Byte2ObjectMap<V>, Function<Byte,V>, Serializable, Cloneable, Function<Byte,V>, IntFunction<V>, Map<Byte,V>

public class Byte2ObjectArrayMap<V> extends AbstractByte2ObjectMap<V> implements Serializable, 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:
  • Constructor Details

    • Byte2ObjectArrayMap

      public Byte2ObjectArrayMap(byte[] key, Object[] 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).
    • Byte2ObjectArrayMap

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

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

      public Byte2ObjectArrayMap(Byte2ObjectMap<V> m)
      Creates a new empty array map copying the entries of a given map.
      Parameters:
      m - a map.
    • Byte2ObjectArrayMap

      public Byte2ObjectArrayMap(Map<? extends Byte, ? extends V> m)
      Creates a new empty array map copying the entries of a given map.
      Parameters:
      m - a map.
    • Byte2ObjectArrayMap

      public Byte2ObjectArrayMap(byte[] key, Object[] 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

    • byte2ObjectEntrySet

      public Byte2ObjectMap.FastEntrySet<V> byte2ObjectEntrySet()
      Description copied from interface: Byte2ObjectMap
      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:
      byte2ObjectEntrySet in interface Byte2ObjectMap<V>
      Returns:
      a type-specific set view of the mappings contained in this map.
      See Also:
    • get

      public V get(byte k)
      Description copied from interface: Byte2ObjectFunction
      Returns the value to which the given key is mapped.
      Specified by:
      get in interface Byte2ObjectFunction<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:
    • size

      public int size()
      Description copied from interface: Function
      Returns the intended number of keys in this function, or -1 if no such number exists.

      Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible. This default implementation, in particular, returns -1.

      Specified by:
      size in interface Byte2ObjectMap<V>
      Specified by:
      size in interface Function<Byte,V>
      Specified by:
      size in interface Map<Byte,V>
      Returns:
      the intended number of keys in this function, or -1 if that number is not available.
      See Also:
    • clear

      public void clear()
      Description copied from interface: Function
      Removes all associations from this function (optional operation).
      Specified by:
      clear in interface Byte2ObjectMap<V>
      Specified by:
      clear in interface Function<Byte,V>
      Specified by:
      clear in interface Map<Byte,V>
      See Also:
    • containsKey

      public boolean containsKey(byte k)
      Description copied from class: AbstractByte2ObjectMap
      Returns true if this function contains a mapping for the specified key.

      Note that for some kind of functions (e.g., hashes) this method will always return true. In particular, this default implementation always returns true.

      Specified by:
      containsKey in interface Byte2ObjectFunction<V>
      Specified by:
      containsKey in interface Byte2ObjectMap<V>
      Overrides:
      containsKey in class AbstractByte2ObjectMap<V>
      Parameters:
      k - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
    • containsValue

      public boolean containsValue(Object v)
      Description copied from class: AbstractByte2ObjectMap
      Specified by:
      containsValue in interface Map<Byte,V>
      Overrides:
      containsValue in class AbstractByte2ObjectMap<V>
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Map<Byte,V>
      Overrides:
      isEmpty in class AbstractByte2ObjectMap<V>
    • put

      public V put(byte k, V v)
      Description copied from interface: Byte2ObjectFunction
      Adds a pair to the map (optional operation).
      Specified by:
      put in interface Byte2ObjectFunction<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:
    • remove

      public V remove(byte k)
      Description copied from interface: Byte2ObjectFunction
      Removes the mapping with the given key (optional operation).
      Specified by:
      remove in interface Byte2ObjectFunction<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:
    • keySet

      public ByteSet keySet()
      Description copied from class: AbstractByte2ObjectMap
      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 Byte2ObjectMap<V>
      Specified by:
      keySet in interface Map<Byte,V>
      Overrides:
      keySet in class AbstractByte2ObjectMap<V>
      Returns:
      a set view of the keys of this map; it may be safely cast to a type-specific interface.
      See Also:
    • values

      public ObjectCollection<V> values()
      Description copied from class: AbstractByte2ObjectMap
      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 Byte2ObjectMap<V>
      Specified by:
      values in interface Map<Byte,V>
      Overrides:
      values in class AbstractByte2ObjectMap<V>
      Returns:
      a set view of the values of this map; it may be safely cast to a type-specific interface.
      See Also:
    • clone

      public Byte2ObjectArrayMap<V> 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.