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

Klasse Char2ShortOpenCustomHashMap

java.lang.Object
java.util.AbstractMap<Character,Short>
speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
speiger.src.collections.chars.maps.impl.customHash.Char2ShortOpenCustomHashMap
Alle implementierten Schnittstellen:
Map<Character,Short>, Char2ShortFunction, Char2ShortMap, ITrimmable
Bekannte direkte Unterklassen:
Char2ShortLinkedOpenCustomHashMap
public class Char2ShortOpenCustomHashMap extends AbstractChar2ShortMap 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

    • Char2ShortOpenCustomHashMap

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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(Character[] keys, Short[] 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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(Character[] keys, Short[] 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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(char[] keys, short[] 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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(char[] keys, short[] 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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(Map<? extends Character,? extends Short> 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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(Map<? extends Character,? extends Short> 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

    • Char2ShortOpenCustomHashMap

      public Char2ShortOpenCustomHashMap(Char2ShortMap 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

    • Char2ShortOpenCustomHashMap

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

    • containsValue

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

    • remove

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

    • removeOrDefault

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

    • get

      public Short get(Object key)
      Angegeben von:
      get in Schnittstelle Char2ShortMap
      Angegeben von:
      get in Schnittstelle Map<Character,Short>
      Setzt außer Kraft:
      get in Klasse AbstractChar2ShortMap

    • getOrDefault

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

    • char2ShortEntrySet

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

    • keySet

      public CharSet keySet()
      Angegeben von:
      keySet in Schnittstelle Char2ShortMap
      Angegeben von:
      keySet in Schnittstelle Map<Character,Short>
      Setzt außer Kraft:
      keySet in Klasse AbstractChar2ShortMap

    • values

      public ShortCollection values()
      Angegeben von:
      values in Schnittstelle Char2ShortMap
      Angegeben von:
      values in Schnittstelle Map<Character,Short>
      Setzt außer Kraft:
      values in Klasse AbstractChar2ShortMap

    • forEach

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

    • replace

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

    • computeShort

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

    • computeShortIfAbsent

      public short computeShortIfAbsent(char key, Char2ShortFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      computeShortIfAbsent in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      computeShortIfAbsent in Klasse AbstractChar2ShortMap
      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

    • supplyShortIfAbsent

      public short supplyShortIfAbsent(char key, ShortSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      supplyShortIfAbsent in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      supplyShortIfAbsent in Klasse AbstractChar2ShortMap
      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

    • computeShortIfPresent

      public short computeShortIfPresent(char key, CharShortUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      computeShortIfPresent in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      computeShortIfPresent in Klasse AbstractChar2ShortMap
      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

    • computeShortNonDefault

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

    • computeShortIfAbsentNonDefault

      public short computeShortIfAbsentNonDefault(char key, Char2ShortFunction mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      computeShortIfAbsentNonDefault in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      computeShortIfAbsentNonDefault in Klasse AbstractChar2ShortMap
      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

    • supplyShortIfAbsentNonDefault

      public short supplyShortIfAbsentNonDefault(char key, ShortSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      supplyShortIfAbsentNonDefault in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      supplyShortIfAbsentNonDefault in Klasse AbstractChar2ShortMap
      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

    • computeShortIfPresentNonDefault

      public short computeShortIfPresentNonDefault(char key, CharShortUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      computeShortIfPresentNonDefault in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      computeShortIfPresentNonDefault in Klasse AbstractChar2ShortMap
      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

    • mergeShort

      public short mergeShort(char key, short value, ShortShortUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      mergeShort in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      mergeShort in Klasse AbstractChar2ShortMap
      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

    • mergeAllShort

      public void mergeAllShort(Char2ShortMap m, ShortShortUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Char2ShortMap
      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:
      mergeAllShort in Schnittstelle Char2ShortMap
      Setzt außer Kraft:
      mergeAllShort in Klasse AbstractChar2ShortMap
      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,Short>
      Setzt außer Kraft:
      size in Klasse AbstractMap<Character,Short>

    • clear

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

    • 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