Modul speiger.src.collections
Package speiger.src.collections.shorts.maps.impl.immutable

Klasse ImmutableShort2ObjectOpenHashMap<V>

java.lang.Object
java.util.AbstractMap<Short,V>
speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap<V>
speiger.src.collections.shorts.maps.impl.immutable.ImmutableShort2ObjectOpenHashMap<V>
Typparameter:
V - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
Map<Short,V>, ShortFunction<V>, Short2ObjectMap<V>, Short2ObjectOrderedMap<V>
public class ImmutableShort2ObjectOpenHashMap<V> extends AbstractShort2ObjectMap<V> implements Short2ObjectOrderedMap<V>
A Type Specific Custom implementation of the HashMap Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys and values. Extra to that there is a couple quality of life functions provided

  • Konstruktordetails

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(Short[] keys, V[] values)
      Helper constructor that allow to create a map from boxed values (it will unbox them)
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(Short[] keys, V[] values, float loadFactor)
      Helper constructor that allow to create a map from boxed values (it will unbox them)
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      loadFactor - the percentage of how full the backing array can be before they resize
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(short[] keys, V[] values)
      Helper constructor that allow to create a map from unboxed values
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(short[] keys, V[] values, float loadFactor)
      Helper constructor that allow to create a map from unboxed values
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      loadFactor - the percentage of how full the backing array can be before they resize
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(Map<? extends Short,? extends V> map)
      A Helper constructor that allows to create a Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(Map<? extends Short,? extends V> map, float loadFactor)
      A Helper constructor that allows to create a Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map
      loadFactor - the percentage of how full the backing array can be before they resize
      Löst aus:
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(Short2ObjectMap<V> map)
      A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map

    • ImmutableShort2ObjectOpenHashMap

      public ImmutableShort2ObjectOpenHashMap(Short2ObjectMap<V> map, float loadFactor)
      A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map
      loadFactor - the percentage of how full the backing array can be before they resize
      Löst aus:
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

  • Methodendetails

    • put

      public V put(short key, V value)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Short2ObjectMap<V>
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted
      Gibt zurück:
      the last present value or default return value.
      Siehe auch:

    • putIfAbsent

      public V putIfAbsent(short key, V value)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      putIfAbsent in Schnittstelle Short2ObjectMap<V>
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted
      Gibt zurück:
      the last present value or default return value.
      Siehe auch:

    • putAndMoveToFirst

      public V putAndMoveToFirst(short key, V value)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A customized put method that allows you to insert into the first index.
      Angegeben von:
      putAndMoveToFirst in Schnittstelle Short2ObjectOrderedMap<V>
      Parameter:
      key - the key that should be inserted
      value - the value that should be inserted
      Gibt zurück:
      the previous present or default return value
      Siehe auch:

    • putAndMoveToLast

      public V putAndMoveToLast(short key, V value)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
      Angegeben von:
      putAndMoveToLast in Schnittstelle Short2ObjectOrderedMap<V>
      Parameter:
      key - the key that should be inserted
      value - the value that should be inserted
      Gibt zurück:
      the previous present or default return value
      Siehe auch:

    • moveToFirst

      public boolean moveToFirst(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A specific move method to move a given key/value to the first index.
      Angegeben von:
      moveToFirst in Schnittstelle Short2ObjectOrderedMap<V>
      Parameter:
      key - that should be moved to the first index
      Gibt zurück:
      true if the value was moved.

    • moveToLast

      public boolean moveToLast(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A specific move method to move a given key/value to the last index.
      Angegeben von:
      moveToLast in Schnittstelle Short2ObjectOrderedMap<V>
      Parameter:
      key - that should be moved to the first last
      Gibt zurück:
      true if the value was moved.

    • getAndMoveToFirst

      public V getAndMoveToFirst(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A Specific get method that allows to move teh given key/value int the first index.
      Angegeben von:
      getAndMoveToFirst in Schnittstelle Short2ObjectOrderedMap<V>
      Parameter:
      key - that is searched for
      Gibt zurück:
      the given value for the requested key or default return value

    • getAndMoveToLast

      public V getAndMoveToLast(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A Specific get method that allows to move teh given key/value int the last index.
      Angegeben von:
      getAndMoveToLast in Schnittstelle Short2ObjectOrderedMap<V>
      Parameter:
      key - that is searched for
      Gibt zurück:
      the given value for the requested key or default return value

    • containsKey

      public boolean containsKey(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      containsKey in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      containsKey in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - element that is searched for
      Gibt zurück:
      if the key is present

    • containsKey

      @Deprecated public boolean containsKey(Object key)
      Veraltet.
      Angegeben von:
      containsKey in Schnittstelle Map<Short,V>
      Angegeben von:
      containsKey in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      containsKey in Klasse AbstractMap<Short,V>
      Parameter:
      key - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:

    • containsValue

      public boolean containsValue(Object value)
      Angegeben von:
      containsValue in Schnittstelle Map<Short,V>
      Setzt außer Kraft:
      containsValue in Klasse AbstractShort2ObjectMap<V>

    • remove

      public V remove(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Short2ObjectMap<V>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value

    • removeOrDefault

      public V removeOrDefault(short key, V defaultValue)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type-Specific Remove function with a default return value if wanted.
      Angegeben von:
      removeOrDefault in Schnittstelle Short2ObjectMap<V>
      Parameter:
      key - the element that should be removed
      defaultValue - the value that should be returned if the entry doesn't exist
      Gibt zurück:
      the value that was removed or default value
      Siehe auch:

    • remove

      @Deprecated public V remove(Object key)
      Veraltet.
      Angegeben von:
      remove in Schnittstelle Map<Short,V>
      Angegeben von:
      remove in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      remove in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value
      Siehe auch:

    • remove

      public boolean remove(short key, V value)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Short2ObjectMap<V>
      Parameter:
      key - the element that should be removed
      value - the expected value that should be found
      Gibt zurück:
      true if the key and value was found and removed
      Siehe auch:

    • remove

      public boolean remove(Object key, Object value)
      Angegeben von:
      remove in Schnittstelle Map<Short,V>
      Angegeben von:
      remove in Schnittstelle Short2ObjectMap<V>
      Parameter:
      key - the element that should be removed
      value - the expected value that should be found
      Gibt zurück:
      true if the key and value was found and removed
      Siehe auch:

    • get

      public V get(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific get method to reduce boxing/unboxing
      Angegeben von:
      get in Schnittstelle Short2ObjectMap<V>
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • get

      public V get(Object key)
      Angegeben von:
      get in Schnittstelle Map<Short,V>
      Angegeben von:
      get in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      get in Klasse AbstractShort2ObjectMap<V>

    • getOrDefault

      public V getOrDefault(short key, V defaultValue)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific getOrDefault method to reduce boxing/unboxing
      Angegeben von:
      getOrDefault in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      getOrDefault in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the key that is searched for
      defaultValue - the value that should be returned if the key is not present
      Gibt zurück:
      the searched value or defaultValue value

    • firstShortKey

      public short firstShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A method to get the first Key of a Map.
      Angegeben von:
      firstShortKey in Schnittstelle Short2ObjectOrderedMap<V>
      Gibt zurück:
      the first key in the map

    • pollFirstShortKey

      public short pollFirstShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A method to get and remove the first Key of a Map.
      Angegeben von:
      pollFirstShortKey in Schnittstelle Short2ObjectOrderedMap<V>
      Gibt zurück:
      the first key in the map

    • lastShortKey

      public short lastShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A method to get the last Key of a Map.
      Angegeben von:
      lastShortKey in Schnittstelle Short2ObjectOrderedMap<V>
      Gibt zurück:
      the last key in the map

    • pollLastShortKey

      public short pollLastShortKey()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A method to get and remove the last Key of a Map.
      Angegeben von:
      pollLastShortKey in Schnittstelle Short2ObjectOrderedMap<V>
      Gibt zurück:
      the last key in the map

    • firstValue

      public V firstValue()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A method to get the first Value of a Map.
      Angegeben von:
      firstValue in Schnittstelle Short2ObjectOrderedMap<V>
      Gibt zurück:
      the first key in the map

    • lastValue

      public V lastValue()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectOrderedMap
      A method to get the last Value of a Map.
      Angegeben von:
      lastValue in Schnittstelle Short2ObjectOrderedMap<V>
      Gibt zurück:
      the last key in the map

    • short2ObjectEntrySet

      public ObjectOrderedSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
      Angegeben von:
      short2ObjectEntrySet in Schnittstelle Short2ObjectMap<V>
      Angegeben von:
      short2ObjectEntrySet in Schnittstelle Short2ObjectOrderedMap<V>
      Gibt zurück:
      a EntrySet of the collection

    • keySet

      public ShortOrderedSet keySet()
      Angegeben von:
      keySet in Schnittstelle Map<Short,V>
      Angegeben von:
      keySet in Schnittstelle Short2ObjectMap<V>
      Angegeben von:
      keySet in Schnittstelle Short2ObjectOrderedMap<V>
      Setzt außer Kraft:
      keySet in Klasse AbstractShort2ObjectMap<V>

    • values

      public ObjectCollection<V> values()
      Angegeben von:
      values in Schnittstelle Map<Short,V>
      Angegeben von:
      values in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      values in Klasse AbstractShort2ObjectMap<V>

    • copy

      public ImmutableShort2ObjectOpenHashMap<V> copy()
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
      Angegeben von:
      copy in Schnittstelle Short2ObjectMap<V>
      Angegeben von:
      copy in Schnittstelle Short2ObjectOrderedMap<V>
      Setzt außer Kraft:
      copy in Klasse AbstractShort2ObjectMap<V>
      Gibt zurück:
      a Shallow Copy of the Map

    • forEach

      public void forEach(ShortObjectConsumer<V> action)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      Type Specific forEach method to reduce boxing/unboxing
      Angegeben von:
      forEach in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      forEach in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      action - processor of the values that are iterator over

    • replace

      public boolean replace(short key, V oldValue, V newValue)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific replace method to replace an existing value
      Angegeben von:
      replace in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      replace in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the element that should be searched for
      oldValue - the expected value to be replaced
      newValue - the value to replace the oldValue with.
      Gibt zurück:
      true if the value got replaced

    • replace

      public V replace(short key, V value)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Angegeben von:
      replace in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      replace in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the element that should be searched for
      value - the value to replace with.
      Gibt zurück:
      the present value or default return value

    • compute

      public V compute(short key, ShortObjectUnaryOperator<V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      compute in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      compute in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeIfAbsent

      public V computeIfAbsent(short key, ShortFunction<V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeIfAbsent in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      computeIfAbsent in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • supplyIfAbsent

      public V supplyIfAbsent(short key, ObjectSupplier<V> valueProvider)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      supplyIfAbsent in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      supplyIfAbsent in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the key that should be computed
      valueProvider - the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • computeIfPresent

      public V computeIfPresent(short key, ShortObjectUnaryOperator<V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      computeIfPresent in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      computeIfPresent in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if present
      Gibt zurück:
      the result of the default return value or present value

    • merge

      public V merge(short key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Type Specific merge method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      merge in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      merge in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      key - the key that should be be searched for
      value - the value that should be merged with
      mappingFunction - the operator that should generate the new Value
      Gibt zurück:
      the result of the merge

    • mergeAll

      public void mergeAll(Short2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ObjectMap
      A Bulk method for merging Maps. If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Angegeben von:
      mergeAll in Schnittstelle Short2ObjectMap<V>
      Setzt außer Kraft:
      mergeAll in Klasse AbstractShort2ObjectMap<V>
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value

    • size

      public int size()
      Angegeben von:
      size in Schnittstelle Map<Short,V>
      Setzt außer Kraft:
      size in Klasse AbstractMap<Short,V>

    • clear

      public void clear()
      Angegeben von:
      clear in Schnittstelle Map<Short,V>
      Setzt außer Kraft:
      clear in Klasse AbstractMap<Short,V>