Boolean2CharMap (Primitive-Collections 0.2.0 API)

All Superinterfaces:

Boolean2CharFunction, java.util.Map<java.lang.Boolean,java.lang.Character>

All Known Implementing Classes:

AbstractBoolean2CharMap
```
public interface Boolean2CharMap
extends java.util.Map<java.lang.Boolean,java.lang.Character>, Boolean2CharFunction
```
A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Boolean2CharMap.Entry` Type Specific Map Entry that reduces boxing/unboxing
`static interface`	`Boolean2CharMap.FastEntrySet` Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`char`	`addTo(boolean key, char value)` A Helper method to add a primitives together.
`void`	`addToAll(Boolean2CharMap m)` A Helper method to bulk add primitives together.
`ObjectSet<Boolean2CharMap.Entry>`	`boolean2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`default java.lang.Character`	`compute(java.lang.Boolean key, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Character,? extends java.lang.Character> mappingFunction)` Deprecated.
`char`	`computeChar(boolean key, BooleanCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfAbsent(boolean key, Boolean2CharFunction mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`char`	`computeCharIfPresent(boolean key, BooleanCharUnaryOperator mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`default java.lang.Character`	`computeIfAbsent(java.lang.Boolean key, java.util.function.Function<? super java.lang.Boolean,? extends java.lang.Character> mappingFunction)` Deprecated.
`default java.lang.Character`	`computeIfPresent(java.lang.Boolean key, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Character,? extends java.lang.Character> mappingFunction)` Deprecated.
`boolean`	`containsKey(boolean key)` Type Specific method to reduce boxing/unboxing of values
`default boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(char value)` Type Specific method to reduce boxing/unboxing of values
`default boolean`	`containsValue(java.lang.Object value)`
`ObjectSet<java.util.Map.Entry<java.lang.Boolean,java.lang.Character>>`	`entrySet()` Deprecated.
`default void`	`forEach(java.util.function.BiConsumer<? super java.lang.Boolean,? super java.lang.Character> action)` Deprecated.
`void`	`forEach(BooleanCharConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`default java.lang.Character`	`get(java.lang.Object key)` Deprecated.
`char`	`getChar(boolean key)` A Type Specific get method to reduce boxing/unboxing
`char`	`getDefaultReturnValue()` Method to see what the default return value is.
`char`	`getOrDefault(boolean key, char defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`default java.lang.Character`	`getOrDefault(java.lang.Object key, java.lang.Character defaultValue)` Deprecated.
`BooleanSet`	`keySet()`
`default java.lang.Character`	`merge(java.lang.Boolean key, java.lang.Character value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> mappingFunction)` Deprecated.
`void`	`mergeAllChar(Boolean2CharMap m, CharCharUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`char`	`mergeChar(boolean key, char value, CharCharUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`char`	`put(boolean key, char value)` Type Specific method to reduce boxing/unboxing of values
`default java.lang.Character`	`put(java.lang.Boolean key, java.lang.Character value)` Deprecated.
`default void`	`putAll(boolean[] keys, char[] values)` Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
`void`	`putAll(boolean[] 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
`void`	`putAll(Boolean2CharMap m)` Type Specific function for the bull putting of values
`void`	`putAllIfAbsent(Boolean2CharMap m)` Type-Specific bulk put method put elements into the map if not present.
`char`	`putIfAbsent(boolean key, char value)` Type Specific method to reduce boxing/unboxing of values
`default java.lang.Character`	`putIfAbsent(java.lang.Boolean key, java.lang.Character value)` Deprecated.
`char`	`remBoolean(boolean key)` Type Specific remove function to reduce boxing/unboxing
`char`	`remBooleanOrDefault(boolean key, char defaultValue)` Type-Specific Remove function with a default return value if wanted.
`boolean`	`remove(boolean key, char value)` Type Specific remove function to reduce boxing/unboxing
`default java.lang.Character`	`remove(java.lang.Object key)`
`default boolean`	`remove(java.lang.Object key, java.lang.Object value)`
`char`	`replace(boolean key, char value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`default java.lang.Character`	`replace(java.lang.Boolean key, java.lang.Character value)` Deprecated.
`default boolean`	`replace(java.lang.Boolean key, java.lang.Character oldValue, java.lang.Character newValue)` Deprecated.
`boolean`	`replace(boolean key, char oldValue, char newValue)` A Type Specific replace method to replace an existing value
`default void`	`replaceAll(java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Character,? extends java.lang.Character> mappingFunction)` Deprecated.
`void`	`replaceChars(Boolean2CharMap m)` Type-Specific bulk replace method.
`void`	`replaceChars(BooleanCharUnaryOperator mappingFunction)` A Type Specific mass replace method to reduce boxing/unboxing
`Boolean2CharMap`	`setDefaultReturnValue(char v)` Method to define the default return value if a requested key isn't present
`CharCollection`	`values()`

Methods inherited from interface java.util.Map
clear, equals, hashCode, isEmpty, putAll, size

- Method Detail
  - getDefaultReturnValue
```
char getDefaultReturnValue()
```
    Method to see what the default return value is.
    
    Returns:
    
    default return value
  - setDefaultReturnValue
```
Boolean2CharMap setDefaultReturnValue(char v)
```
    Method to define the default return value if a requested key isn't present
    
    Parameters:
    
    v - value that should be the default return value
    
    Returns:
    
    itself
  - put
```
char put(boolean key,
         char value)
```
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.put(Object, Object)
  - putAll
```
default void putAll(boolean[] keys,
                    char[] values)
```
    Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    Parameters:
    
    keys - the keys that should be added
    
    values - the values that should be added
    
    Throws:
    
    java.lang.IllegalStateException - if the arrays are not the same size
    
    See Also:
    
    Map.putAll(Map)
  - putAll
```
void putAll(boolean[] 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
    
    Parameters:
    
    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
    
    Throws:
    
    java.lang.IllegalStateException - if the arrays are not within the range
    
    See Also:
    
    Map.putAll(Map)
  - putIfAbsent
```
char putIfAbsent(boolean key,
                 char value)
```
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.putIfAbsent(Object, Object)
  - putAllIfAbsent
```
void putAllIfAbsent(Boolean2CharMap m)
```
    Type-Specific bulk put method put elements into the map if not present.
    
    Parameters:
    
    m - elements that should be added if not present.
  - addTo
```
char addTo(boolean key,
           char value)
```
    A Helper method to add a primitives together. If key is not present then this functions as a put.
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted / added
    
    Returns:
    
    the last present value or default return value.
  - addToAll
```
void addToAll(Boolean2CharMap m)
```
    A Helper method to bulk add primitives together.
    
    Parameters:
    
    m - the values that should be added/inserted
  - putAll
```
void putAll(Boolean2CharMap m)
```
    Type Specific function for the bull putting of values
    
    Parameters:
    
    m - the elements that should be inserted
  - containsKey
```
boolean containsKey(boolean key)
```
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    key - element that is searched for
    
    Returns:
    
    if the key is present
  - containsKey
```
default boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.Boolean,java.lang.Character>
    
    Parameters:
    
    key - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsKey(Object)
    
    Note:
    
    in some implementations key does not have to be Boolean but just have to support equals with Boolean.
  - containsValue
```
boolean containsValue(char value)
```
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    value - element that is searched for
    
    Returns:
    
    if the value is present
  - containsValue
```
default boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.Boolean,java.lang.Character>
    
    Parameters:
    
    value - that is searched for.
    
    Returns:
    
    true if found
    
    See Also:
    
    Map.containsValue(Object)
    
    Note:
    
    in some implementations key does not have to be CLASS_VALUE but just have to support equals with CLASS_VALUE.
  - remBoolean
```
char remBoolean(boolean key)
```
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remove
```
default java.lang.Character remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.Boolean,java.lang.Character>
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
    
    See Also:
    
    Map.remove(Object)
    
    Note:
    
    in some implementations key does not have to be Boolean but just have to support equals with Boolean.
  - remove
```
boolean remove(boolean key,
               char value)
```
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    value - the expected value that should be found
    
    Returns:
    
    true if the key and value was found and removed
    
    See Also:
    
    Map.remove(Object, Object)
  - remove
```
default boolean remove(java.lang.Object key,
                       java.lang.Object value)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.Boolean,java.lang.Character>
    
    Parameters:
    
    key - the element that should be removed
    
    value - the expected value that should be found
    
    Returns:
    
    true if the key and value was found and removed
    
    See Also:
    
    Map.remove(Object, Object)
  - remBooleanOrDefault
```
char remBooleanOrDefault(boolean key,
                         char defaultValue)
```
    Type-Specific Remove function with a default return value if wanted.
    
    Parameters:
    
    key - the element that should be removed
    
    defaultValue - the value that should be returned if the entry doesn't exist
    
    Returns:
    
    the value that was removed or default value
    
    See Also:
    
    Map.remove(Object, Object)
  - replace
```
boolean replace(boolean key,
                char oldValue,
                char newValue)
```
    A Type Specific replace method to replace an existing value
    
    Parameters:
    
    key - the element that should be searched for
    
    oldValue - the expected value to be replaced
    
    newValue - the value to replace the oldValue with.
    
    Returns:
    
    true if the value got replaced
    
    Note:
    
    this fails if the value is not present even if it matches the oldValue
  - replace
```
char replace(boolean key,
             char value)
```
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
    
    Note:
    
    this fails if the value is not present
  - replaceChars
```
void replaceChars(Boolean2CharMap m)
```
    Type-Specific bulk replace method. Could be seen as putAllIfPresent
    
    Parameters:
    
    m - elements that should be replaced.
  - replaceChars
```
void replaceChars(BooleanCharUnaryOperator mappingFunction)
```
    A Type Specific mass replace method to reduce boxing/unboxing
    
    Parameters:
    
    mappingFunction - operation to replace all values
  - computeChar
```
char computeChar(boolean key,
                 BooleanCharUnaryOperator mappingFunction)
```
    A Type Specific compute method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeCharIfAbsent
```
char computeCharIfAbsent(boolean key,
                         Boolean2CharFunction mappingFunction)
```
    A Type Specific compute method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeCharIfPresent
```
char computeCharIfPresent(boolean key,
                          BooleanCharUnaryOperator mappingFunction)
```
    A Type Specific compute method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if present
    
    Returns:
    
    the result of the default return value or present value
    
    Note:
    
    if not present then compute is not executed
  - mergeChar
```
char mergeChar(boolean key,
               char value,
               CharCharUnaryOperator mappingFunction)
```
    A Type Specific merge method to reduce boxing/unboxing
    
    Parameters:
    
    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
    
    Returns:
    
    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(Boolean2CharMap m,
                  CharCharUnaryOperator mappingFunction)
```
    A Bulk method for merging Maps.
    
    Parameters:
    
    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(java.lang.Boolean key,
                                     java.lang.Character oldValue,
                                     java.lang.Character newValue)
```
    Deprecated.
    
    Specified by:
    
    replace in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - replace
```
@Deprecated
default java.lang.Character replace(java.lang.Boolean key,
                                                 java.lang.Character value)
```
    Deprecated.
    
    Specified by:
    
    replace in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - getChar
```
char getChar(boolean key)
```
    A Type Specific get method to reduce boxing/unboxing
    
    Specified by:
    
    getChar in interface Boolean2CharFunction
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
char getOrDefault(boolean key,
                  char defaultValue)
```
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that is searched for
    
    defaultValue - the value that should be returned if the key is not present
    
    Returns:
    
    the searched value or defaultValue value
  - get
```
@Deprecated
default java.lang.Character get(java.lang.Object key)
```
    Deprecated.
    
    Specified by:
    
    get in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - getOrDefault
```
@Deprecated
default java.lang.Character getOrDefault(java.lang.Object key,
                                                      java.lang.Character defaultValue)
```
    Deprecated.
    
    Specified by:
    
    getOrDefault in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - replaceAll
```
@Deprecated
default void replaceAll(java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Character,? extends java.lang.Character> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    replaceAll in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - compute
```
@Deprecated
default java.lang.Character compute(java.lang.Boolean key,
                                                 java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Character,? extends java.lang.Character> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    compute in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - computeIfAbsent
```
@Deprecated
default java.lang.Character computeIfAbsent(java.lang.Boolean key,
                                                         java.util.function.Function<? super java.lang.Boolean,? extends java.lang.Character> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    computeIfAbsent in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - computeIfPresent
```
@Deprecated
default java.lang.Character computeIfPresent(java.lang.Boolean key,
                                                          java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Character,? extends java.lang.Character> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    computeIfPresent in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - merge
```
@Deprecated
default java.lang.Character merge(java.lang.Boolean key,
                                               java.lang.Character value,
                                               java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> mappingFunction)
```
    Deprecated.
    
    Specified by:
    
    merge in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - forEach
```
void forEach(BooleanCharConsumer action)
```
    Type Specific forEach method to reduce boxing/unboxing
    
    Parameters:
    
    action - processor of the values that are iterator over
  - forEach
```
@Deprecated
default void forEach(java.util.function.BiConsumer<? super java.lang.Boolean,? super java.lang.Character> action)
```
    Deprecated.
    
    Specified by:
    
    forEach in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - keySet
```
BooleanSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - values
```
CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - entrySet
```
@Deprecated
ObjectSet<java.util.Map.Entry<java.lang.Boolean,java.lang.Character>> entrySet()
```
    Deprecated.
    
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - boolean2CharEntrySet
```
ObjectSet<Boolean2CharMap.Entry> boolean2CharEntrySet()
```
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - put
```
@Deprecated
default java.lang.Character put(java.lang.Boolean key,
                                             java.lang.Character value)
```
    Deprecated.
    
    Specified by:
    
    put in interface java.util.Map<java.lang.Boolean,java.lang.Character>
  - putIfAbsent
```
@Deprecated
default java.lang.Character putIfAbsent(java.lang.Boolean key,
                                                     java.lang.Character value)
```
    Deprecated.
    
    Specified by:
    
    putIfAbsent in interface java.util.Map<java.lang.Boolean,java.lang.Character>

Interface Boolean2CharMap

Nested Class Summary

Method Summary

Methods inherited from interface java.util.Map

Method Detail

getDefaultReturnValue

setDefaultReturnValue

put

putAll

putAll

putIfAbsent

putAllIfAbsent

addTo

addToAll

putAll

containsKey

containsKey

containsValue

containsValue

remBoolean

remove

remove

remove

remBooleanOrDefault

replace

replace

replaceChars

replaceChars

computeChar

computeCharIfAbsent

computeCharIfPresent

mergeChar

mergeAllChar

replace

replace

getChar

getOrDefault

get

getOrDefault

replaceAll

compute

computeIfAbsent

computeIfPresent

merge

forEach

forEach

keySet

values

entrySet

boolean2CharEntrySet

put

putIfAbsent