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

Klasse Char2ObjectOpenCustomHashMap<V>

java.lang.Object
java.util.AbstractMap<Character,V>
speiger.src.collections.chars.maps.abstracts.AbstractChar2ObjectMap<V>
speiger.src.collections.chars.maps.impl.customHash.Char2ObjectOpenCustomHashMap<V>
Typparameter:
V - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
Map<Character,V>, CharFunction<V>, Char2ObjectMap<V>, ITrimmable
Bekannte direkte Unterklassen:
Char2ObjectLinkedOpenCustomHashMap
public class Char2ObjectOpenCustomHashMap<V> extends AbstractChar2ObjectMap<V> 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

    • Char2ObjectOpenCustomHashMap

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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(int minCapacity, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(int minCapacity, float loadFactor, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(Character[] keys, V[] values, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(Character[] keys, V[] values, float loadFactor, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(char[] keys, V[] values, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(char[] keys, V[] values, float loadFactor, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(Map<? extends Character,? extends V> map, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(Map<? extends Character,? extends V> map, float loadFactor, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(Char2ObjectMap<V> map, CharStrategy 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

    • Char2ObjectOpenCustomHashMap

      public Char2ObjectOpenCustomHashMap(Char2ObjectMap<V> map, float loadFactor, CharStrategy 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 V put(char key, V value)
      Beschreibung aus Schnittstelle kopiert: Char2ObjectMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Char2ObjectMap<V>
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted
      Gibt zurück:
      the last present value or default return value.
      Siehe auch:

    • putIfAbsent

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

    • containsKey

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

    • containsKey

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

    • containsValue

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

    • remove

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

    • removeOrDefault

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

    • remove

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

    • remove

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

    • remove

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

    • get

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

    • get

      public V get(Object key)
      Angegeben von:
      get in Schnittstelle Char2ObjectMap<V>
      Angegeben von:
      get in Schnittstelle Map<Character,V>
      Setzt außer Kraft:
      get in Klasse AbstractChar2ObjectMap<V>

    • getOrDefault

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

    • copy

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

    • char2ObjectEntrySet

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

    • keySet

      public CharSet keySet()
      Angegeben von:
      keySet in Schnittstelle Char2ObjectMap<V>
      Angegeben von:
      keySet in Schnittstelle Map<Character,V>
      Setzt außer Kraft:
      keySet in Klasse AbstractChar2ObjectMap<V>

    • values

      public ObjectCollection<V> values()
      Angegeben von:
      values in Schnittstelle Char2ObjectMap<V>
      Angegeben von:
      values in Schnittstelle Map<Character,V>
      Setzt außer Kraft:
      values in Klasse AbstractChar2ObjectMap<V>

    • forEach

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

    • replace

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

    • replace

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

    • compute

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

    • computeIfAbsent

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

    • supplyIfAbsent

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

    • computeIfPresent

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

    • merge

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

    • mergeAll

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

    • size

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

    • clear

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

    • 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