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

Klasse Object2LongOpenCustomHashMap<T>

java.lang.Object
java.util.AbstractMap<T,Long>
speiger.src.collections.objects.maps.abstracts.AbstractObject2LongMap<T>
speiger.src.collections.objects.maps.impl.customHash.Object2LongOpenCustomHashMap<T>
Typparameter:
T - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
ToLongFunction<T>, Map<T,Long>, ToLongFunction<T>, Object2LongMap<T>, ITrimmable
Bekannte direkte Unterklassen:
Object2LongLinkedOpenCustomHashMap
public class Object2LongOpenCustomHashMap<T> extends AbstractObject2LongMap<T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(ObjectStrategy<? super T> strategy)
      Default Contstructor
      Parameter:
      strategy - the strategy that allows hash control.
      Löst aus:
      NullPointerException - if Strategy is null

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(int minCapacity, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(int minCapacity, float loadFactor, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(T[] keys, Long[] values, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(T[] keys, Long[] values, float loadFactor, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(T[] keys, long[] values, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(T[] keys, long[] values, float loadFactor, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(Map<? extends T,? extends Long> map, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(Map<? extends T,? extends Long> map, float loadFactor, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(Object2LongMap<T> map, ObjectStrategy<? super T> 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

    • Object2LongOpenCustomHashMap

      public Object2LongOpenCustomHashMap(Object2LongMap<T> map, float loadFactor, ObjectStrategy<? super T> 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(T key, long value)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Object2LongMap<T>
      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(T key, long value)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      putIfAbsent in Schnittstelle Object2LongMap<T>
      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(T key, long value)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      Angegeben von:
      addTo in Schnittstelle Object2LongMap<T>
      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(T key, long value)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Angegeben von:
      subFrom in Schnittstelle Object2LongMap<T>
      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(Object key)
      Angegeben von:
      containsKey in Schnittstelle Map<T,Long>
      Setzt außer Kraft:
      containsKey in Klasse AbstractObject2LongMap<T>

    • containsValue

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

    • rem

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

    • remOrDefault

      public long remOrDefault(T key, long defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      Type-Specific Remove function with a default return value if wanted.
      Angegeben von:
      remOrDefault in Schnittstelle Object2LongMap<T>
      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 Map<T,Long>
      Angegeben von:
      remove in Schnittstelle Object2LongMap<T>
      Setzt außer Kraft:
      remove in Klasse AbstractObject2LongMap<T>
      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(T key, long value)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Object2LongMap<T>
      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<T,Long>
      Angegeben von:
      remove in Schnittstelle Object2LongMap<T>
      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:

    • getLong

      public long getLong(T key)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      A Type Specific get method to reduce boxing/unboxing
      Angegeben von:
      getLong in Schnittstelle Object2LongMap<T>
      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 Map<T,Long>
      Angegeben von:
      get in Schnittstelle Object2LongMap<T>
      Setzt außer Kraft:
      get in Klasse AbstractObject2LongMap<T>

    • getOrDefault

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

    • object2LongEntrySet

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

    • keySet

      public ObjectSet<T> keySet()
      Angegeben von:
      keySet in Schnittstelle Map<T,Long>
      Angegeben von:
      keySet in Schnittstelle Object2LongMap<T>
      Setzt außer Kraft:
      keySet in Klasse AbstractObject2LongMap<T>

    • values

      public LongCollection values()
      Angegeben von:
      values in Schnittstelle Map<T,Long>
      Angegeben von:
      values in Schnittstelle Object2LongMap<T>
      Setzt außer Kraft:
      values in Klasse AbstractObject2LongMap<T>

    • forEach

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

    • replace

      public boolean replace(T key, long oldValue, long newValue)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      A Type Specific replace method to replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2LongMap<T>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2LongMap<T>
      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(T key, long value)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2LongMap<T>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2LongMap<T>
      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(T key, ObjectLongUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      computeLong in Klasse AbstractObject2LongMap<T>
      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(T key, ToLongFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      computeLongIfAbsent in Klasse AbstractObject2LongMap<T>
      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(T key, LongSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      supplyLongIfAbsent in Klasse AbstractObject2LongMap<T>
      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(T key, ObjectLongUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      computeLongIfPresent in Klasse AbstractObject2LongMap<T>
      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(T key, ObjectLongUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      computeLongNonDefault in Klasse AbstractObject2LongMap<T>
      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(T key, ToLongFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      computeLongIfAbsentNonDefault in Klasse AbstractObject2LongMap<T>
      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(T key, LongSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      supplyLongIfAbsentNonDefault in Klasse AbstractObject2LongMap<T>
      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(T key, ObjectLongUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      computeLongIfPresentNonDefault in Klasse AbstractObject2LongMap<T>
      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(T key, long value, LongLongUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      mergeLong in Klasse AbstractObject2LongMap<T>
      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(Object2LongMap<T> m, LongLongUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2LongMap
      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 Object2LongMap<T>
      Setzt außer Kraft:
      mergeAllLong in Klasse AbstractObject2LongMap<T>
      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<T,Long>
      Setzt außer Kraft:
      size in Klasse AbstractMap<T,Long>

    • clear

      public void clear()
      Angegeben von:
      clear in Schnittstelle Map<T,Long>
      Setzt außer Kraft:
      clear in Klasse AbstractMap<T,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