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

Klasse Byte2LongOpenCustomHashMap

java.lang.Object
java.util.AbstractMap<Byte,Long>
speiger.src.collections.bytes.maps.abstracts.AbstractByte2LongMap
speiger.src.collections.bytes.maps.impl.customHash.Byte2LongOpenCustomHashMap
Alle implementierten Schnittstellen:
Map<Byte,Long>, Byte2LongFunction, Byte2LongMap, ITrimmable
Bekannte direkte Unterklassen:
Byte2LongLinkedOpenCustomHashMap
public class Byte2LongOpenCustomHashMap extends AbstractByte2LongMap 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

    • Byte2LongOpenCustomHashMap

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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(int minCapacity, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(int minCapacity, float loadFactor, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(Byte[] keys, Long[] values, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(Byte[] keys, Long[] values, float loadFactor, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(byte[] keys, long[] values, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(byte[] keys, long[] values, float loadFactor, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(Map<? extends Byte,? extends Long> map, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(Map<? extends Byte,? extends Long> map, float loadFactor, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(Byte2LongMap map, ByteStrategy 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

    • Byte2LongOpenCustomHashMap

      public Byte2LongOpenCustomHashMap(Byte2LongMap map, float loadFactor, ByteStrategy 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 long put(byte key, long value)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Byte2LongMap
      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 long putIfAbsent(byte key, long value)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      putIfAbsent in Schnittstelle Byte2LongMap
      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 long addTo(byte key, long value)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      Angegeben von:
      addTo in Schnittstelle Byte2LongMap
      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 long subFrom(byte key, long value)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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 Byte2LongMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Angegeben von:
      subFrom in Schnittstelle Byte2LongMap
      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(byte key)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      containsKey in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      containsKey in Klasse AbstractByte2LongMap
      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 Byte2LongMap
      Angegeben von:
      containsKey in Schnittstelle Map<Byte,Long>
      Setzt außer Kraft:
      containsKey in Klasse AbstractMap<Byte,Long>
      Parameter:
      key - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:

    • containsValue

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

    • remove

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

    • removeOrDefault

      public long removeOrDefault(byte key, long defaultValue)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      Type-Specific Remove function with a default return value if wanted.
      Angegeben von:
      removeOrDefault in Schnittstelle Byte2LongMap
      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 Long remove(Object key)
      Angegeben von:
      remove in Schnittstelle Byte2LongMap
      Angegeben von:
      remove in Schnittstelle Map<Byte,Long>
      Setzt außer Kraft:
      remove in Klasse AbstractByte2LongMap
      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(byte key, long value)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Byte2LongMap
      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 Byte2LongMap
      Angegeben von:
      remove in Schnittstelle Map<Byte,Long>
      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 long get(byte key)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      A Type Specific get method to reduce boxing/unboxing
      Angegeben von:
      get in Schnittstelle Byte2LongMap
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • get

      public Long get(Object key)
      Angegeben von:
      get in Schnittstelle Byte2LongMap
      Angegeben von:
      get in Schnittstelle Map<Byte,Long>
      Setzt außer Kraft:
      get in Klasse AbstractByte2LongMap

    • getOrDefault

      public long getOrDefault(byte key, long defaultValue)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      A Type Specific getOrDefault method to reduce boxing/unboxing
      Angegeben von:
      getOrDefault in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      getOrDefault in Klasse AbstractByte2LongMap
      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 Byte2LongOpenCustomHashMap copy()
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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 Byte2LongMap
      Setzt außer Kraft:
      copy in Klasse AbstractByte2LongMap
      Gibt zurück:
      a Shallow Copy of the Map

    • byte2LongEntrySet

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

    • keySet

      public ByteSet keySet()
      Angegeben von:
      keySet in Schnittstelle Byte2LongMap
      Angegeben von:
      keySet in Schnittstelle Map<Byte,Long>
      Setzt außer Kraft:
      keySet in Klasse AbstractByte2LongMap

    • values

      public LongCollection values()
      Angegeben von:
      values in Schnittstelle Byte2LongMap
      Angegeben von:
      values in Schnittstelle Map<Byte,Long>
      Setzt außer Kraft:
      values in Klasse AbstractByte2LongMap

    • forEach

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

    • replace

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

    • computeLong

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

    • computeLongIfAbsent

      public long computeLongIfAbsent(byte key, Byte2LongFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      computeLongIfAbsent in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      computeLongIfAbsent in Klasse AbstractByte2LongMap
      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

    • supplyLongIfAbsent

      public long supplyLongIfAbsent(byte key, LongSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      supplyLongIfAbsent in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      supplyLongIfAbsent in Klasse AbstractByte2LongMap
      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

    • computeLongIfPresent

      public long computeLongIfPresent(byte key, ByteLongUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      computeLongIfPresent in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      computeLongIfPresent in Klasse AbstractByte2LongMap
      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

    • computeLongNonDefault

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

    • computeLongIfAbsentNonDefault

      public long computeLongIfAbsentNonDefault(byte key, Byte2LongFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      computeLongIfAbsentNonDefault in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      computeLongIfAbsentNonDefault in Klasse AbstractByte2LongMap
      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

    • supplyLongIfAbsentNonDefault

      public long supplyLongIfAbsentNonDefault(byte key, LongSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      supplyLongIfAbsentNonDefault in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      supplyLongIfAbsentNonDefault in Klasse AbstractByte2LongMap
      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

    • computeLongIfPresentNonDefault

      public long computeLongIfPresentNonDefault(byte key, ByteLongUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      computeLongIfPresentNonDefault in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      computeLongIfPresentNonDefault in Klasse AbstractByte2LongMap
      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

    • mergeLong

      public long mergeLong(byte key, long value, LongLongUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      mergeLong in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      mergeLong in Klasse AbstractByte2LongMap
      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

    • mergeAllLong

      public void mergeAllLong(Byte2LongMap m, LongLongUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Byte2LongMap
      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:
      mergeAllLong in Schnittstelle Byte2LongMap
      Setzt außer Kraft:
      mergeAllLong in Klasse AbstractByte2LongMap
      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<Byte,Long>
      Setzt außer Kraft:
      size in Klasse AbstractMap<Byte,Long>

    • clear

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

    • 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