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

Klasse Int2CharOpenCustomHashMap

java.lang.Object
java.util.AbstractMap<Integer,Character>
speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap
speiger.src.collections.ints.maps.impl.customHash.Int2CharOpenCustomHashMap
Alle implementierten Schnittstellen:
Map<Integer,Character>, Int2CharFunction, Int2CharMap, ITrimmable
Bekannte direkte Unterklassen:
Int2CharLinkedOpenCustomHashMap
public class Int2CharOpenCustomHashMap extends AbstractInt2CharMap 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

    • Int2CharOpenCustomHashMap

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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(int minCapacity, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(int minCapacity, float loadFactor, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(Integer[] keys, Character[] values, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(Integer[] keys, Character[] values, float loadFactor, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(int[] keys, char[] values, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(int[] keys, char[] values, float loadFactor, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(Map<? extends Integer,? extends Character> map, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(Map<? extends Integer,? extends Character> map, float loadFactor, IntStrategy 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

    • Int2CharOpenCustomHashMap

      public Int2CharOpenCustomHashMap(Int2CharMap map, IntStrategy 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

    • Int2CharOpenCustomHashMap

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

    • containsValue

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

    • remove

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

    • removeOrDefault

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

    • get

      public Character get(Object key)
      Angegeben von:
      get in Schnittstelle Int2CharMap
      Angegeben von:
      get in Schnittstelle Map<Integer,Character>
      Setzt außer Kraft:
      get in Klasse AbstractInt2CharMap

    • getOrDefault

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

    • int2CharEntrySet

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

    • keySet

      public IntSet keySet()
      Angegeben von:
      keySet in Schnittstelle Int2CharMap
      Angegeben von:
      keySet in Schnittstelle Map<Integer,Character>
      Setzt außer Kraft:
      keySet in Klasse AbstractInt2CharMap

    • values

      public CharCollection values()
      Angegeben von:
      values in Schnittstelle Int2CharMap
      Angegeben von:
      values in Schnittstelle Map<Integer,Character>
      Setzt außer Kraft:
      values in Klasse AbstractInt2CharMap

    • forEach

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

    • replace

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

    • computeChar

      public char computeChar(int key, IntCharUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      computeChar in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      computeChar in Klasse AbstractInt2CharMap
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeCharIfAbsent

      public char computeCharIfAbsent(int key, Int2CharFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      computeCharIfAbsent in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      computeCharIfAbsent in Klasse AbstractInt2CharMap
      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

    • supplyCharIfAbsent

      public char supplyCharIfAbsent(int key, CharSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      supplyCharIfAbsent in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      supplyCharIfAbsent in Klasse AbstractInt2CharMap
      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

    • computeCharIfPresent

      public char computeCharIfPresent(int key, IntCharUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      computeCharIfPresent in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      computeCharIfPresent in Klasse AbstractInt2CharMap
      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

    • computeCharNonDefault

      public char computeCharNonDefault(int key, IntCharUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      computeCharNonDefault in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      computeCharNonDefault in Klasse AbstractInt2CharMap
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeCharIfAbsentNonDefault

      public char computeCharIfAbsentNonDefault(int key, Int2CharFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      computeCharIfAbsentNonDefault in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      computeCharIfAbsentNonDefault in Klasse AbstractInt2CharMap
      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

    • supplyCharIfAbsentNonDefault

      public char supplyCharIfAbsentNonDefault(int key, CharSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      supplyCharIfAbsentNonDefault in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      supplyCharIfAbsentNonDefault in Klasse AbstractInt2CharMap
      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

    • computeCharIfPresentNonDefault

      public char computeCharIfPresentNonDefault(int key, IntCharUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      computeCharIfPresentNonDefault in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      computeCharIfPresentNonDefault in Klasse AbstractInt2CharMap
      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

    • mergeChar

      public char mergeChar(int key, char value, CharCharUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      mergeChar in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      mergeChar in Klasse AbstractInt2CharMap
      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

    • mergeAllChar

      public void mergeAllChar(Int2CharMap m, CharCharUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Int2CharMap
      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:
      mergeAllChar in Schnittstelle Int2CharMap
      Setzt außer Kraft:
      mergeAllChar in Klasse AbstractInt2CharMap
      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<Integer,Character>
      Setzt außer Kraft:
      size in Klasse AbstractMap<Integer,Character>

    • clear

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

    • 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