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

Klasse Short2ByteOpenCustomHashMap

java.lang.Object
java.util.AbstractMap<Short,Byte>
speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap
speiger.src.collections.shorts.maps.impl.customHash.Short2ByteOpenCustomHashMap
Alle implementierten Schnittstellen:
Map<Short,Byte>, Short2ByteFunction, Short2ByteMap, ITrimmable
Bekannte direkte Unterklassen:
Short2ByteLinkedOpenCustomHashMap
public class Short2ByteOpenCustomHashMap extends AbstractShort2ByteMap implements ITrimmable
A Type Specific HashMap that allows for custom HashControl. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control.

  • Konstruktordetails

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(ShortStrategy strategy)
      Default Contstructor
      Parameter:
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(int minCapacity, ShortStrategy strategy)
      Constructor that defines the minimum capacity
      Parameter:
      minCapacity - the minimum capacity the HashMap is allowed to be.
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the minimum capacity is negative

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(int minCapacity, float loadFactor, ShortStrategy strategy)
      Constructor that defines the minimum capacity and load factor
      Parameter:
      minCapacity - the minimum capacity the HashMap is allowed to be.
      loadFactor - the percentage of how full the backing array can be before they resize
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the minimum capacity is negative
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(Short[] keys, Byte[] values, ShortStrategy strategy)
      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.
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the keys and values do not match in lenght

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(Short[] keys, Byte[] values, float loadFactor, ShortStrategy strategy)
      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
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      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

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(short[] keys, byte[] values, ShortStrategy strategy)
      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.
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the keys and values do not match in lenght

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(short[] keys, byte[] values, float loadFactor, ShortStrategy strategy)
      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
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      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

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(Map<? extends Short,? extends Byte> map, ShortStrategy strategy)
      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
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(Map<? extends Short,? extends Byte> map, float loadFactor, ShortStrategy strategy)
      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
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(Short2ByteMap map, ShortStrategy strategy)
      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
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null

    • Short2ByteOpenCustomHashMap

      public Short2ByteOpenCustomHashMap(Short2ByteMap map, float loadFactor, ShortStrategy strategy)
      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
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null
      IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

  • Methodendetails

    • put

      public byte put(short key, byte value)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Short2ByteMap
      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 byte putIfAbsent(short key, byte value)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      putIfAbsent in Schnittstelle Short2ByteMap
      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:

    • addTo

      public byte addTo(short key, byte value)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      Angegeben von:
      addTo in Schnittstelle Short2ByteMap
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted / added
      Gibt zurück:
      the last present value or default return value.

    • subFrom

      public byte subFrom(short key, byte value)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the Short2ByteMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Angegeben von:
      subFrom in Schnittstelle Short2ByteMap
      Parameter:
      key - that should be subtract from
      value - that should be subtract
      Gibt zurück:
      the last present or default return value

    • containsKey

      public boolean containsKey(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      containsKey in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      containsKey in Klasse AbstractShort2ByteMap
      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,Byte>
      Angegeben von:
      containsKey in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      containsKey in Klasse AbstractMap<Short,Byte>
      Parameter:
      key - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:

    • containsValue

      public boolean containsValue(byte value)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      containsValue in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      containsValue in Klasse AbstractShort2ByteMap
      Parameter:
      value - element that is searched for
      Gibt zurück:
      if the value is present

    • containsValue

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

    • remove

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

    • removeOrDefault

      public byte removeOrDefault(short key, byte defaultValue)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      Type-Specific Remove function with a default return value if wanted.
      Angegeben von:
      removeOrDefault in Schnittstelle Short2ByteMap
      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

      public Byte remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<Short,Byte>
      Angegeben von:
      remove in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      remove in Klasse AbstractShort2ByteMap
      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, byte value)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Short2ByteMap
      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,Byte>
      Angegeben von:
      remove in Schnittstelle Short2ByteMap
      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 byte get(short key)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      A Type Specific get method to reduce boxing/unboxing
      Angegeben von:
      get in Schnittstelle Short2ByteMap
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • get

      public Byte get(Object key)
      Angegeben von:
      get in Schnittstelle Map<Short,Byte>
      Angegeben von:
      get in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      get in Klasse AbstractShort2ByteMap

    • getOrDefault

      public byte getOrDefault(short key, byte defaultValue)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      A Type Specific getOrDefault method to reduce boxing/unboxing
      Angegeben von:
      getOrDefault in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      getOrDefault in Klasse AbstractShort2ByteMap
      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

    • copy

      public Short2ByteOpenCustomHashMap copy()
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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 Short2ByteMap
      Setzt außer Kraft:
      copy in Klasse AbstractShort2ByteMap
      Gibt zurück:
      a Shallow Copy of the Map

    • short2ByteEntrySet

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

    • keySet

      public ShortSet keySet()
      Angegeben von:
      keySet in Schnittstelle Map<Short,Byte>
      Angegeben von:
      keySet in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      keySet in Klasse AbstractShort2ByteMap

    • values

      public ByteCollection values()
      Angegeben von:
      values in Schnittstelle Map<Short,Byte>
      Angegeben von:
      values in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      values in Klasse AbstractShort2ByteMap

    • forEach

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

    • replace

      public boolean replace(short key, byte oldValue, byte newValue)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      A Type Specific replace method to replace an existing value
      Angegeben von:
      replace in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      replace in Klasse AbstractShort2ByteMap
      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 byte replace(short key, byte value)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Angegeben von:
      replace in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      replace in Klasse AbstractShort2ByteMap
      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

    • computeByte

      public byte computeByte(short key, ShortByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      computeByte in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      computeByte in Klasse AbstractShort2ByteMap
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeByteIfAbsent

      public byte computeByteIfAbsent(short key, Short2ByteFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      computeByteIfAbsent in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      computeByteIfAbsent in Klasse AbstractShort2ByteMap
      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

    • supplyByteIfAbsent

      public byte supplyByteIfAbsent(short key, ByteSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      supplyByteIfAbsent in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      supplyByteIfAbsent in Klasse AbstractShort2ByteMap
      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

    • computeByteIfPresent

      public byte computeByteIfPresent(short key, ShortByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      computeByteIfPresent in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      computeByteIfPresent in Klasse AbstractShort2ByteMap
      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

    • computeByteNonDefault

      public byte computeByteNonDefault(short key, ShortByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      computeByteNonDefault in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      computeByteNonDefault in Klasse AbstractShort2ByteMap
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeByteIfAbsentNonDefault

      public byte computeByteIfAbsentNonDefault(short key, Short2ByteFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      computeByteIfAbsentNonDefault in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      computeByteIfAbsentNonDefault in Klasse AbstractShort2ByteMap
      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

    • supplyByteIfAbsentNonDefault

      public byte supplyByteIfAbsentNonDefault(short key, ByteSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      supplyByteIfAbsentNonDefault in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      supplyByteIfAbsentNonDefault in Klasse AbstractShort2ByteMap
      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

    • computeByteIfPresentNonDefault

      public byte computeByteIfPresentNonDefault(short key, ShortByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      computeByteIfPresentNonDefault in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      computeByteIfPresentNonDefault in Klasse AbstractShort2ByteMap
      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

    • mergeByte

      public byte mergeByte(short key, byte value, ByteByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      mergeByte in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      mergeByte in Klasse AbstractShort2ByteMap
      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

    • mergeAllByte

      public void mergeAllByte(Short2ByteMap m, ByteByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Short2ByteMap
      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:
      mergeAllByte in Schnittstelle Short2ByteMap
      Setzt außer Kraft:
      mergeAllByte in Klasse AbstractShort2ByteMap
      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,Byte>
      Setzt außer Kraft:
      size in Klasse AbstractMap<Short,Byte>

    • clear

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

    • trim

      public boolean trim(int size)
      Beschreibung aus Schnittstelle kopiert: ITrimmable
      Trims the original collection down to the size of the current elements or the requested size depending which is bigger
      Angegeben von:
      trim in Schnittstelle ITrimmable
      Parameter:
      size - the requested trim size.
      Gibt zurück:
      if the internal array has been trimmed.

    • clearAndTrim

      public void clearAndTrim(int size)
      Beschreibung aus Schnittstelle kopiert: ITrimmable
      Trims the collection down to the requested size and clears all elements while doing so
      Angegeben von:
      clearAndTrim in Schnittstelle ITrimmable
      Parameter:
      size - the amount of elements that should be allowed