CharIntMap (Koloboke Collections 1.0 API)

All Superinterfaces:

Container, Map<Character,Integer>

All Known Subinterfaces:

HashCharIntMap
```
public interface CharIntMap
extends Map<Character,Integer>, Container
```
A Map specialization with char keys and int values.

See Also:

CharIntMapFactory, @KolobokeMap

Nested Class Summary
- Nested classes/interfaces inherited from interface Map
  Map.Entry<K,V>

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addValue(char key, int addition)` Adds the given value `addition` to the value associated with the specified key, or to the default value if this map contains no mapping for the key, and associates the resulting value with the key.
`int`	`addValue(char key, int addition, int initialValue)` Adds the given value `addition` to the value associated with the specified key, or the given `initialValue` if this map contains no mapping for the key, and associates the resulting value with the key.
`Integer`	`compute(Character key, BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction)` Deprecated. Use specialization `compute(char, CharIntToIntFunction)` instead
`int`	`compute(char key, CharIntToIntFunction remappingFunction)` Attempts to compute a mapping for the specified key and its current mapped value (or default value if there is no current mapping).
`Integer`	`computeIfAbsent(Character key, Function<? super Character,? extends Integer> mappingFunction)` Deprecated. Use specialization `computeIfAbsent(char, CharToIntFunction)` instead
`int`	`computeIfAbsent(char key, CharToIntFunction mappingFunction)` If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map .
`Integer`	`computeIfPresent(Character key, BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction)` Deprecated. Use specialization `computeIfPresent(char, CharIntToIntFunction)` instead
`int`	`computeIfPresent(char key, CharIntToIntFunction remappingFunction)` If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
`boolean`	`containsKey(char key)` Returns `true` if this map contains a mapping for the specified key.
`boolean`	`containsKey(Object key)` Deprecated. Use specialization `containsKey(char)` instead
`boolean`	`containsValue(int value)` Returns `true` if this map maps one or more keys to the specified value.
`boolean`	`containsValue(Object value)` Deprecated. Use specialization `containsValue(int)` instead
`CharIntCursor`	`cursor()` Returns a new cursor over the entries of this map.
`int`	`defaultValue()` Returns the default value of this map, which is used instead of `null` in primitive specialization methods, when the key is absent in the map.
`ObjSet<Map.Entry<Character,Integer>>`	`entrySet()`
`void`	`forEach(BiConsumer<? super Character,? super Integer> action)` Deprecated. Use specialization `forEach(CharIntConsumer)` instead
`void`	`forEach(CharIntConsumer action)` Performs the given `action` on each entry in this map until all entries have been processed or the action throws an `Exception`.
`boolean`	`forEachWhile(CharIntPredicate predicate)` Checks the given `predicate` on each entry in this map until all entries have been processed or the predicate returns `false` for some entry, or throws an `Exception`.
`int`	`get(char key)` Returns the value to which the specified key is mapped, or default value if this map contains no mapping for the key.
`Integer`	`get(Object key)` Deprecated. Use specialization `get(char)` instead
`int`	`getOrDefault(char key, int defaultValue)` Returns the value to which the specified key is mapped, or `defaultValue` if this map contains no mapping for the key.
`Integer`	`getOrDefault(Object key, Integer defaultValue)` Deprecated. Use specialization `getOrDefault(char, int)` instead
`CharSet`	`keySet()`
`Integer`	`merge(Character key, Integer value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction)` Deprecated. Use specialization `merge(char, int, IntBinaryOperator)` instead
`int`	`merge(char key, int value, IntBinaryOperator remappingFunction)` If the specified key is not already associated with a value, associates it with the given value, otherwise, replaces the value with the results of the given remapping function.
`Integer`	`put(Character key, Integer value)` Deprecated. Use specialization `put(char, int)` instead
`int`	`put(char key, int value)` Associates the specified value with the specified key in this map (optional operation).
`Integer`	`putIfAbsent(Character key, Integer value)` Deprecated. Use specialization `putIfAbsent(char, int)` instead
`int`	`putIfAbsent(char key, int value)` If the specified key is not already associated with a value, associates it with the given value and returns default value, else returns the current value.
`int`	`remove(char key)` Removes the mapping for a key from this map if it is present (optional operation).
`boolean`	`remove(char key, int value)` Removes the entry for the specified key only if it is currently mapped to the specified value.
`Integer`	`remove(Object key)` Deprecated. Use specialization `remove(char)` instead
`boolean`	`remove(Object key, Object value)` Deprecated. Use specialization `remove(char, int)` instead
`boolean`	`removeIf(CharIntPredicate filter)` Removes all of the entries of this collection that satisfy the given predicate.
`Integer`	`replace(Character key, Integer value)` Deprecated. Use specialization `replace(char, int)` instead
`boolean`	`replace(Character key, Integer oldValue, Integer newValue)` Deprecated. Use specialization `replace(char, int, int)` instead
`int`	`replace(char key, int value)` Replaces the entry for the specified key only if it is currently mapped to some value.
`boolean`	`replace(char key, int oldValue, int newValue)` Replaces the entry for the specified key only if currently mapped to the specified value.
`void`	`replaceAll(BiFunction<? super Character,? super Integer,? extends Integer> function)` Deprecated. Use specialization `replaceAll(CharIntToIntFunction)` instead
`void`	`replaceAll(CharIntToIntFunction function)` Replaces each entry's value with the result of invoking the given function on that entry, in the order entries are returned by an entry set iterator, until all entries have been processed or the function throws an exception.
`IntCollection`	`values()`

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

Methods inherited from interface com.koloboke.collect.Container
clear, ensureCapacity, isEmpty, shrink, size, sizeAsLong

- Method Detail
  - defaultValue
```
int defaultValue()
```
    Returns the default value of this map, which is used instead of null in primitive specialization methods, when the key is absent in the map.
    
    Returns:
    
    the default value of this map
    
    See Also:
    
    CharIntMapFactory.withDefaultValue(int)
  - containsKey
```
@Deprecated
boolean containsKey(Object key)
```
    Deprecated. Use specialization containsKey(char) instead
    
    Specified by:
    
    containsKey in interface Map<Character,Integer>
  - containsKey
```
boolean containsKey(char key)
```
    Returns true if this map contains a mapping for the specified key.
    
    Parameters:
    
    key - the char key whose presence in this map is to be tested
    
    Returns:
    
    true if this map contains a mapping for the specified key
  - containsValue
```
@Deprecated
boolean containsValue(Object value)
```
    Deprecated. Use specialization containsValue(int) instead
    
    Specified by:
    
    containsValue in interface Map<Character,Integer>
  - containsValue
```
boolean containsValue(int value)
```
    Returns true if this map maps one or more keys to the specified value. This operation will probably require time linear in the map size for most implementations of the CharIntMap interface.
    
    Parameters:
    
    value - the int value whose presence in this map is to be tested
    
    Returns:
    
    true if this map maps one or more keys to the specified value
  - get
```
@Nullable
 @Deprecated
Integer get(Object key)
```
    Deprecated. Use specialization get(char) instead
    
    Specified by:
    
    get in interface Map<Character,Integer>
  - get
```
int get(char key)
```
    Returns the value to which the specified key is mapped, or default value if this map contains no mapping for the key.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or default value if this map contains no mapping for the key
  - getOrDefault
```
@Deprecated
Integer getOrDefault(Object key,
                                  Integer defaultValue)
```
    Deprecated. Use specialization getOrDefault(char, int) instead
    
    Specified by:
    
    getOrDefault in interface Map<Character,Integer>
  - getOrDefault
```
int getOrDefault(char key,
                 int defaultValue)
```
    Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    defaultValue - the value to return if the specified key is absent in the map
    
    Returns:
    
    the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key
  - forEach
```
@Deprecated
void forEach(@Nonnull
                          BiConsumer<? super Character,? super Integer> action)
```
    Deprecated. Use specialization forEach(CharIntConsumer) instead
    
    Specified by:
    
    forEach in interface Map<Character,Integer>
  - forEach
```
void forEach(@Nonnull
             CharIntConsumer action)
```
    Performs the given action on each entry in this map until all entries have been processed or the action throws an Exception. Exceptions thrown by the action are relayed to the caller. The entries will be processed in the same order as the entry set iterator unless that order is unspecified in which case implementations may use an order which differs from the entry set iterator.
    
    Parameters:
    
    action - The action to be performed for each entry
    
    See Also:
    
    Comparison of iteration options in the library
  - forEachWhile
```
boolean forEachWhile(@Nonnull
                     CharIntPredicate predicate)
```
    Checks the given predicate on each entry in this map until all entries have been processed or the predicate returns false for some entry, or throws an Exception. Exceptions thrown by the predicate are relayed to the caller.
    The entries will be processed in the same order as the entry set iterator unless that order is unspecified in which case implementations may use an order which differs from the entry set iterator.
    If the map is empty, this method returns true immediately.
    
    Parameters:
    
    predicate - the predicate to be checked for each entry
    
    Returns:
    
    true if the predicate returned true for all entries of the map, false if it returned false for the entry
    
    See Also:
    
    Comparison of iteration options in the library
  - cursor
```
@Nonnull
CharIntCursor cursor()
```
    Returns a new cursor over the entries of this map. It's order is always correspond to the entry set iterator order.
    Basic cursor usage idiom is:
```
 for (CharIntCursor cur = map.cursor(); cur.moveNext();) {
     // Work with cur.key() and cur.value()
     // Call cur.remove() to remove the current entry
 }
```
    Returns:
    
    a new cursor over the entries of this map
    
    See Also:
    
    Comparison of iteration options in the library
  - keySet
```
@Nonnull
CharSet keySet()
```
    Specified by:
    
    keySet in interface Map<Character,Integer>
  - values
```
@Nonnull
IntCollection values()
```
    Specified by:
    
    values in interface Map<Character,Integer>
  - entrySet
```
@Nonnull
ObjSet<Map.Entry<Character,Integer>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<Character,Integer>
  - put
```
@Deprecated
Integer put(Character key,
                         Integer value)
```
    Deprecated. Use specialization put(char, int) instead
    
    Specified by:
    
    put in interface Map<Character,Integer>
  - put
```
int put(char key,
        int value)
```
    Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with key, or default value if there was no mapping for key. (A default value return can also indicate that the map previously associated default value with key.)
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
    
    IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this map
  - putIfAbsent
```
@Nullable
 @Deprecated
Integer putIfAbsent(Character key,
                                             Integer value)
```
    Deprecated. Use specialization putIfAbsent(char, int) instead
    
    If the specified key is not already associated with a value, associates it with the given value and returns null, else returns the current value.
    
    Specified by:
    
    putIfAbsent in interface Map<Character,Integer>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key, or null if there was no mapping for the key. (A null return can also indicate that the map previously associated null with the key, if the implementation supports null values.)
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
    
    ClassCastException - if the key or value is of an inappropriate type for this map
    
    NullPointerException - if the specified key or value is null
    
    IllegalArgumentException - if some property of the specified key or value prevents it from being stored in this map
  - putIfAbsent
```
int putIfAbsent(char key,
                int value)
```
    If the specified key is not already associated with a value, associates it with the given value and returns default value, else returns the current value.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key, or default value if there was no mapping for the key. (A default value return can also indicate that the map previously associated default value with the key, if the implementation supports such values.)
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
    
    IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this map
  - compute
```
@Deprecated
Integer compute(Character key,
                             @Nonnull
                             BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction)
```
    Deprecated. Use specialization compute(char, CharIntToIntFunction) instead
    
    Specified by:
    
    compute in interface Map<Character,Integer>
  - compute
```
int compute(char key,
            @Nonnull
            CharIntToIntFunction remappingFunction)
```
    Attempts to compute a mapping for the specified key and its current mapped value (or default value if there is no current mapping).
    If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    remappingFunction - the function to compute a value
    
    Returns:
    
    the new value associated with the specified key
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - computeIfAbsent
```
@Deprecated
Integer computeIfAbsent(Character key,
                                     @Nonnull
                                     Function<? super Character,? extends Integer> mappingFunction)
```
    Deprecated. Use specialization computeIfAbsent(char, CharToIntFunction) instead
    
    Specified by:
    
    computeIfAbsent in interface Map<Character,Integer>
  - computeIfAbsent
```
int computeIfAbsent(char key,
                    @Nonnull
                    CharToIntFunction mappingFunction)
```
    If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map . The most common usage is to construct a new object serving as an initial mapped value or memoized result.
    If the function itself throws an (unchecked) exception, the exception is rethrown, and no mapping is recorded.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    mappingFunction - the function to compute a value
    
    Returns:
    
    the current (existing or computed) value associated with the specified key
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - computeIfPresent
```
@Deprecated
Integer computeIfPresent(Character key,
                                      @Nonnull
                                      BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction)
```
    Deprecated. Use specialization computeIfPresent(char, CharIntToIntFunction) instead
    
    Specified by:
    
    computeIfPresent in interface Map<Character,Integer>
  - computeIfPresent
```
int computeIfPresent(char key,
                     @Nonnull
                     CharIntToIntFunction remappingFunction)
```
    If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
    If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    remappingFunction - the function to compute a value
    
    Returns:
    
    the new value associated with the specified key, or "no entry" value
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - merge
```
@Deprecated
Integer merge(Character key,
                           Integer value,
                           @Nonnull
                           BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction)
```
    Deprecated. Use specialization merge(char, int, IntBinaryOperator) instead
    
    Specified by:
    
    merge in interface Map<Character,Integer>
  - merge
```
int merge(char key,
          int value,
          @Nonnull
          IntBinaryOperator remappingFunction)
```
    If the specified key is not already associated with a value, associates it with the given value, otherwise, replaces the value with the results of the given remapping function. This method may be of use when combining multiple mapped values for a key.
    If the remappingFunction itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - the value to use if absent
    
    remappingFunction - the function to recompute a value if present
    
    Returns:
    
    the new value associated with the specified key
    
    Throws:
    
    NullPointerException - if the remappingFunction is null
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - addValue
```
int addValue(char key,
             int addition)
```
    Adds the given value addition to the value associated with the specified key, or to the default value if this map contains no mapping for the key, and associates the resulting value with the key.
    
    Parameters:
    
    key - the key to which value add the given value
    
    addition - the value addition
    
    Returns:
    
    the new value associated with the specified key
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - addValue
```
int addValue(char key,
             int addition,
             int initialValue)
```
    Adds the given value addition to the value associated with the specified key, or the given initialValue if this map contains no mapping for the key, and associates the resulting value with the key.
    This version of addValue(char, int) method is useful if you want to accumulate values from the different initial value, than the default value of this map.
    
    Parameters:
    
    key - the key to which value add the given value
    
    addition - the value addition
    
    initialValue - the value to add the given value addition to, if the map contains no mapping for the given key
    
    Returns:
    
    the new value associated with the specified key
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - replace
```
@Nullable
 @Deprecated
Integer replace(Character key,
                                         Integer value)
```
    Deprecated. Use specialization replace(char, int) instead
    
    Replaces the entry for the specified key only if it is currently mapped to some value.
    
    Specified by:
    
    replace in interface Map<Character,Integer>
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key, or null if there was no mapping for the key.
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
    
    NullPointerException - if the specified key or value is null
    
    IllegalArgumentException - if some property of the specified value prevents it from being stored in this map
  - replace
```
int replace(char key,
            int value)
```
    Replaces the entry for the specified key only if it is currently mapped to some value.
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with the specified key, or default value if there was no mapping for the key. (A default value return can also indicate that the map previously associated default value with the key, if the implementation supports such values.)
    
    Throws:
    
    IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this map
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - replace
```
@Deprecated
boolean replace(Character key,
                             Integer oldValue,
                             Integer newValue)
```
    Deprecated. Use specialization replace(char, int, int) instead
    
    Replaces the entry for the specified key only if currently mapped to the specified value.
    
    Specified by:
    
    replace in interface Map<Character,Integer>
    
    Parameters:
    
    key - key with which the specified value is associated
    
    oldValue - value expected to be associated with the specified key
    
    newValue - value to be associated with the specified key
    
    Returns:
    
    true if the value was replaced
    
    Throws:
    
    UnsupportedOperationException - if the put operation is not supported by this map
    
    NullPointerException - if the specified key or value is null
    
    IllegalArgumentException - if some property of the specified value prevents it from being stored in this map
  - replace
```
boolean replace(char key,
                int oldValue,
                int newValue)
```
    Replaces the entry for the specified key only if currently mapped to the specified value.
    
    Parameters:
    
    key - key with which the specified value is associated
    
    oldValue - value expected to be associated with the specified key
    
    newValue - value to be associated with the specified key
    
    Returns:
    
    true if the value was replaced
    
    Throws:
    
    IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this map
    
    UnsupportedOperationException - if the put operation is not supported by this map
  - replaceAll
```
@Deprecated
void replaceAll(@Nonnull
                             BiFunction<? super Character,? super Integer,? extends Integer> function)
```
    Deprecated. Use specialization replaceAll(CharIntToIntFunction) instead
    
    Specified by:
    
    replaceAll in interface Map<Character,Integer>
  - replaceAll
```
void replaceAll(@Nonnull
                CharIntToIntFunction function)
```
    Replaces each entry's value with the result of invoking the given function on that entry, in the order entries are returned by an entry set iterator, until all entries have been processed or the function throws an exception.
    
    Parameters:
    
    function - the function to apply to each entry
    
    Throws:
    
    UnsupportedOperationException - if the set operation is not supported by this map's entry set iterator
    
    IllegalArgumentException - if some property of a replacement value prevents it from being stored in this map (optional restriction)
  - remove
```
@Nullable
 @Deprecated
Integer remove(Object key)
```
    Deprecated. Use specialization remove(char) instead
    
    Specified by:
    
    remove in interface Map<Character,Integer>
  - remove
```
int remove(char key)
```
    Removes the mapping for a key from this map if it is present (optional operation).
    Returns the value to which this map previously associated the key, or default value if the map contained no mapping for the key.
    A return value of default value does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to default value.
    The map will not contain a mapping for the specified key once the call returns.
    
    Parameters:
    
    key - key whose mapping is to be removed from the map
    
    Returns:
    
    the previous value associated with key, or default value if there was no mapping for key
    
    Throws:
    
    UnsupportedOperationException - if the remove operation is not supported by this map
  - remove
```
@Deprecated
boolean remove(Object key,
                            Object value)
```
    Deprecated. Use specialization remove(char, int) instead
    
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    
    Specified by:
    
    remove in interface Map<Character,Integer>
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value expected to be associated with the specified key
    
    Returns:
    
    true if the value was removed
    
    Throws:
    
    NullPointerException - if the specified key or value is null
    
    UnsupportedOperationException - if the remove operation is not supported by this map
  - remove
```
boolean remove(char key,
               int value)
```
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    
    Parameters:
    
    key - key with which the specified value is associated
    
    value - value expected to be associated with the specified key
    
    Returns:
    
    true if the value was removed
    
    Throws:
    
    UnsupportedOperationException - if the remove operation is not supported by this map
  - removeIf
```
boolean removeIf(@Nonnull
                 CharIntPredicate filter)
```
    Removes all of the entries of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.
    
    Parameters:
    
    filter - a predicate which returns true for elements to be removed
    
    Returns:
    
    true if any elements were removed
    
    Throws:
    
    NullPointerException - if the specified filter is null
    
    UnsupportedOperationException - if elements cannot be removed from this collection. Implementations may throw this exception if a matching element cannot be removed or if, in general, removal is not supported.
    
    See Also:
    
    Comparison of iteration options in the library

Interface CharIntMap

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Method Summary

Methods inherited from interface Map

Methods inherited from interface com.koloboke.collect.Container

Method Detail

defaultValue

containsKey

containsKey

containsValue

containsValue

get

get

getOrDefault

getOrDefault

forEach

forEach

forEachWhile

cursor

keySet

values

entrySet

put

put

putIfAbsent

putIfAbsent

compute

compute

computeIfAbsent

computeIfAbsent

computeIfPresent

computeIfPresent

merge

merge

addValue

addValue

replace

replace

replace

replace

replaceAll

replaceAll

remove

remove

remove

remove

removeIf