Modul speiger.src.collections
Package speiger.src.collections.chars.maps.interfaces

Schnittstelle Char2CharMap

Alle Superschnittstellen:
CharUnaryOperator, Map<Character,Character>
Alle bekannten Unterschnittstellen:
Char2CharConcurrentMap, Char2CharNavigableMap, Char2CharOrderedMap, Char2CharSortedMap
Alle bekannten Implementierungsklassen:
AbstractChar2CharMap, Char2CharArrayMap, Char2CharAVLTreeMap, Char2CharConcurrentOpenHashMap, Char2CharLinkedOpenCustomHashMap, Char2CharLinkedOpenHashMap, Char2CharMaps.EmptyMap, Char2CharMaps.SingletonMap, Char2CharMaps.SynchronizedMap, Char2CharMaps.SynchronizedNavigableMap, Char2CharMaps.SynchronizedOrderedMap, Char2CharMaps.SynchronizedSortedMap, Char2CharMaps.UnmodifyableMap, Char2CharMaps.UnmodifyableNavigableMap, Char2CharMaps.UnmodifyableOrderedMap, Char2CharMaps.UnmodifyableSortedMap, Char2CharOpenCustomHashMap, Char2CharOpenHashMap, Char2CharRBTreeMap, ImmutableChar2CharOpenHashMap
public interface Char2CharMap extends Map<Character,Character>, CharUnaryOperator
A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

  • Methodendetails

    • builder

      static Char2CharMap.MapBuilder builder()
      Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
      Gibt zurück:
      a MapBuilder

    • getDefaultReturnValue

      char getDefaultReturnValue()
      Method to see what the default return value is.
      Gibt zurück:
      default return value

    • setDefaultReturnValue

      Char2CharMap setDefaultReturnValue(char v)
      Method to define the default return value if a requested key isn't present
      Parameter:
      v - value that should be the default return value
      Gibt zurück:
      itself

    • copy

      Char2CharMap copy()
      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
      Gibt zurück:
      a Shallow Copy of the Map
      Note:
      Wrappers and view Maps will not support this feature

    • put

      char put(char key, char value)
      Type Specific method to reduce boxing/unboxing of values
      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:

    • put

      default char put(Char2CharMap.Entry entry)
      A Helper method that allows to put int a Char2CharMap.Entry into a map.
      Parameter:
      entry - then Entry that should be inserted.
      Gibt zurück:
      the last present value or default return value.

    • put

      default Character put(Map.Entry<Character,Character> entry)
      A Helper method that allows to put int a Map.Entry into a map.
      Parameter:
      entry - then Entry that should be inserted.
      Gibt zurück:
      the last present value or default return value.

    • putAll

      default void putAll(char[] keys, char[] values)
      Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      Löst aus:
      IllegalStateException - if the arrays are not the same size
      Siehe auch:

    • putAll

      void putAll(char[] keys, char[] values, int offset, int size)
      Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      offset - where the to start in the array
      size - how many elements should be added
      Löst aus:
      IllegalStateException - if the arrays are not within the range
      Siehe auch:

    • putAll

      default void putAll(Character[] keys, Character[] values)
      Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      Löst aus:
      IllegalStateException - if the arrays are not the same size
      Siehe auch:

    • putAll

      void putAll(Character[] keys, Character[] values, int offset, int size)
      Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      offset - where the to start in the array
      size - how many elements should be added
      Löst aus:
      IllegalStateException - if the arrays are not within the range
      Siehe auch:

    • putIfAbsent

      char putIfAbsent(char key, char value)
      Type Specific method to reduce boxing/unboxing of values
      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:

    • putAllIfAbsent

      void putAllIfAbsent(Char2CharMap m)
      Type-Specific bulk put method put elements into the map if not present.
      Parameter:
      m - elements that should be added if not present.

    • addTo

      char addTo(char key, char value)
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      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.

    • addToAll

      void addToAll(Char2CharMap m)
      A Helper method to bulk add primitives together.
      Parameter:
      m - the values that should be added/inserted

    • subFrom

      char subFrom(char key, char value)
      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 getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Parameter:
      key - that should be subtract from
      value - that should be subtract
      Gibt zurück:
      the last present or default return value

    • putAll

      void putAll(Char2CharMap m)
      Type Specific function for the bull putting of values
      Parameter:
      m - the elements that should be inserted

    • containsKey

      boolean containsKey(char key)
      Type Specific method to reduce boxing/unboxing of values
      Parameter:
      key - element that is searched for
      Gibt zurück:
      if the key is present

    • containsKey

      default boolean containsKey(Object key)
      Angegeben von:
      containsKey in Schnittstelle Map<Character,Character>
      Parameter:
      key - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:
      Note:
      in some implementations key does not have to be Character but just have to support equals with Character.

    • containsValue

      boolean containsValue(char value)
      Type Specific method to reduce boxing/unboxing of values
      Parameter:
      value - element that is searched for
      Gibt zurück:
      if the value is present

    • containsValue

      default boolean containsValue(Object value)
      Angegeben von:
      containsValue in Schnittstelle Map<Character,Character>
      Parameter:
      value - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:
      Note:
      in some implementations key does not have to be CLASS_VALUE but just have to support equals with CLASS_VALUE.

    • remove

      char remove(char key)
      Type Specific remove function to reduce boxing/unboxing
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value

    • remove

      default Character remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<Character,Character>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value
      Siehe auch:
      Note:
      in some implementations key does not have to be Character but just have to support equals with Character.

    • remove

      boolean remove(char key, char value)
      Type Specific remove function to reduce boxing/unboxing
      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

      default boolean remove(Object key, Object value)
      Angegeben von:
      remove in Schnittstelle Map<Character,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:

    • removeOrDefault

      char removeOrDefault(char key, char defaultValue)
      Type-Specific Remove function with a default return value if wanted.
      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:

    • replace

      boolean replace(char key, char oldValue, char newValue)
      A Type Specific replace method to replace an existing value
      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
      Note:
      this fails if the value is not present even if it matches the oldValue

    • replace

      char replace(char key, char value)
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      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
      Note:
      this fails if the value is not present

    • replaceChars

      void replaceChars(Char2CharMap m)
      Type-Specific bulk replace method. Could be seen as putAllIfPresent
      Parameter:
      m - elements that should be replaced.

    • replaceChars

      void replaceChars(CharCharUnaryOperator mappingFunction)
      A Type Specific mass replace method to reduce boxing/unboxing
      Parameter:
      mappingFunction - operation to replace all values

    • computeChar

      char computeChar(char key, CharCharUnaryOperator mappingFunction)
      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.
      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

      char computeCharIfAbsent(char key, CharUnaryOperator mappingFunction)
      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.
      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

      char supplyCharIfAbsent(char key, CharSupplier valueProvider)
      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.
      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

      char computeCharIfPresent(char key, CharCharUnaryOperator mappingFunction)
      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.
      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
      Note:
      if not present then compute is not executed

    • computeCharNonDefault

      char computeCharNonDefault(char key, CharCharUnaryOperator mappingFunction)
      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.
      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

      char computeCharIfAbsentNonDefault(char key, CharUnaryOperator mappingFunction)
      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.
      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

      char supplyCharIfAbsentNonDefault(char key, CharSupplier valueProvider)
      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.
      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

      char computeCharIfPresentNonDefault(char key, CharCharUnaryOperator mappingFunction)
      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.
      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
      Note:
      if not present then compute is not executed

    • mergeChar

      char mergeChar(char key, char value, CharCharUnaryOperator mappingFunction)
      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.
      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
      Note:
      if the result matches the default return value then the key is removed from the map

    • mergeAllChar

      void mergeAllChar(Char2CharMap m, CharCharUnaryOperator mappingFunction)
      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.
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value
      Note:
      if the result matches the default return value then the key is removed from the map

    • replace

      @Deprecated default boolean replace(Character key, Character oldValue, Character newValue)
      Veraltet.
      Angegeben von:
      replace in Schnittstelle Map<Character,Character>

    • replace

      @Deprecated default Character replace(Character key, Character value)
      Veraltet.
      Angegeben von:
      replace in Schnittstelle Map<Character,Character>

    • applyAsChar

      default char applyAsChar(char key)
      Beschreibung aus Schnittstelle kopiert: CharUnaryOperator
      Type Specific get function to reduce boxing/unboxing
      Angegeben von:
      applyAsChar in Schnittstelle CharUnaryOperator
      Parameter:
      key - the value that should be processed
      Gibt zurück:
      the result of the function

    • get

      char get(char key)
      A Type Specific get method to reduce boxing/unboxing
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • getOrDefault

      char getOrDefault(char key, char defaultValue)
      A Type Specific getOrDefault method to reduce boxing/unboxing
      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

    • get

      @Deprecated default Character get(Object key)
      Veraltet.
      Angegeben von:
      get in Schnittstelle Map<Character,Character>

    • getOrDefault

      @Deprecated default Character getOrDefault(Object key, Character defaultValue)
      Veraltet.
      Angegeben von:
      getOrDefault in Schnittstelle Map<Character,Character>

    • replaceAll

      @Deprecated default void replaceAll(BiFunction<? super Character,? super Character,? extends Character> mappingFunction)
      Veraltet.
      Angegeben von:
      replaceAll in Schnittstelle Map<Character,Character>

    • compute

      @Deprecated default Character compute(Character key, BiFunction<? super Character,? super Character,? extends Character> mappingFunction)
      Veraltet.
      Angegeben von:
      compute in Schnittstelle Map<Character,Character>

    • computeIfAbsent

      @Deprecated default Character computeIfAbsent(Character key, Function<? super Character,? extends Character> mappingFunction)
      Veraltet.
      Angegeben von:
      computeIfAbsent in Schnittstelle Map<Character,Character>

    • computeIfPresent

      @Deprecated default Character computeIfPresent(Character key, BiFunction<? super Character,? super Character,? extends Character> mappingFunction)
      Veraltet.
      Angegeben von:
      computeIfPresent in Schnittstelle Map<Character,Character>

    • merge

      @Deprecated default Character merge(Character key, Character value, BiFunction<? super Character,? super Character,? extends Character> mappingFunction)
      Veraltet.
      Angegeben von:
      merge in Schnittstelle Map<Character,Character>

    • forEach

      void forEach(CharCharConsumer action)
      Type Specific forEach method to reduce boxing/unboxing
      Parameter:
      action - processor of the values that are iterator over

    • forEach

      @Deprecated default void forEach(BiConsumer<? super Character,? super Character> action)
      Veraltet.
      Angegeben von:
      forEach in Schnittstelle Map<Character,Character>

    • keySet

      CharSet keySet()
      Angegeben von:
      keySet in Schnittstelle Map<Character,Character>

    • values

      CharCollection values()
      Angegeben von:
      values in Schnittstelle Map<Character,Character>

    • entrySet

      @Deprecated ObjectSet<Map.Entry<Character,Character>> entrySet()
      Veraltet.
      Angegeben von:
      entrySet in Schnittstelle Map<Character,Character>

    • char2CharEntrySet

      ObjectSet<Char2CharMap.Entry> char2CharEntrySet()
      Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
      Gibt zurück:
      a EntrySet of the collection

    • synchronize

      default Char2CharMap synchronize()
      Creates a Wrapped Map that is Synchronized
      Gibt zurück:
      a new Map that is synchronized
      Siehe auch:

    • synchronize

      default Char2CharMap synchronize(Object mutex)
      Creates a Wrapped Map that is Synchronized
      Parameter:
      mutex - is the controller of the synchronization block
      Gibt zurück:
      a new Map Wrapper that is synchronized
      Siehe auch:

    • unmodifiable

      default Char2CharMap unmodifiable()
      Creates a Wrapped Map that is unmodifiable
      Gibt zurück:
      a new Map Wrapper that is unmodifiable
      Siehe auch:

    • put

      @Deprecated default Character put(Character key, Character value)
      Veraltet.
      Angegeben von:
      put in Schnittstelle Map<Character,Character>

    • putIfAbsent

      @Deprecated default Character putIfAbsent(Character key, Character value)
      Veraltet.
      Angegeben von:
      putIfAbsent in Schnittstelle Map<Character,Character>