com.koloboke.collect.map
Interface IntCharMap

All Superinterfaces:

Container, Map<Integer,Character>

All Known Subinterfaces:

HashIntCharMap

public interface IntCharMap
extends Map<Integer,Character>, Container

A Map specialization with int keys and char values.

See Also:

IntCharMapFactory, @KolobokeMap

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

char	addValue(int key, char 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.
char	addValue(int key, char addition, char 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.
char	compute(int key, IntCharToCharFunction remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (or default value if there is no current mapping).
char	computeIfAbsent(int key, IntToCharFunction 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 .
char	computeIfPresent(int key, IntCharToCharFunction 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(int key) Returns true if this map contains a mapping for the specified key.
boolean	containsKey(Object key) Deprecated. Use specialization containsKey(int) instead
boolean	containsValue(char value) Returns true if this map maps one or more keys to the specified value.
boolean	containsValue(Object value) Deprecated. Use specialization containsValue(char) instead
IntCharCursor	cursor() Returns a new cursor over the entries of this map.
char	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<Integer,Character>>	entrySet() Returns a Set view of the mappings contained in this map.
void	forEach(IntCharConsumer 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(IntCharPredicate 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.
char	get(int key) Returns the value to which the specified key is mapped, or default value if this map contains no mapping for the key.
Character	get(Object key) Deprecated. Use specialization get(int) instead
char	getOrDefault(int key, char defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
Character	getOrDefault(Object key, Character defaultValue) Deprecated. Use specialization getOrDefault(int, char) instead
IntSet	keySet() Returns a Set view of the keys contained in this map.
char	merge(int key, char value, CharBinaryOperator 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.
char	put(int key, char value) Associates the specified value with the specified key in this map (optional operation).
Character	put(Integer key, Character value) Deprecated. Use specialization put(int, char) instead
char	putIfAbsent(int key, char 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.
Character	putIfAbsent(Integer key, Character value) Deprecated. Use specialization putIfAbsent(int, char) instead
char	remove(int key) Removes the mapping for a key from this map if it is present (optional operation).
boolean	remove(int key, char value) Removes the entry for the specified key only if it is currently mapped to the specified value.
Character	remove(Object key) Deprecated. Use specialization remove(int) instead
boolean	remove(Object key, Object value) Deprecated. Use specialization remove(int, char) instead
boolean	removeIf(IntCharPredicate filter) Removes all of the entries of this collection that satisfy the given predicate.
char	replace(int key, char value) Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(int key, char oldValue, char newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
Character	replace(Integer key, Character value) Deprecated. Use specialization replace(int, char) instead
boolean	replace(Integer key, Character oldValue, Character newValue) Deprecated. Use specialization replace(int, char, char) instead
void	replaceAll(IntCharToCharFunction 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.
CharCollection	values() Returns a Collection view of the values contained in this map.

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

char 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:

IntCharMapFactory.withDefaultValue(char)

containsKey

@Deprecated
boolean containsKey(Object key)

Deprecated. Use specialization containsKey(int) instead

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Specified by:

containsKey in interface Map<Integer,Character>

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

containsKey

boolean containsKey(int key)

Returns true if this map contains a mapping for the specified key.

Parameters:

key - the int 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(char) instead

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.

Specified by:

containsValue in interface Map<Integer,Character>

Parameters:

value - value whose presence in this map is to be tested

Returns:

true if this map maps one or more keys to the specified value

containsValue

boolean containsValue(char 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 IntCharMap interface.

Parameters:

value - the char 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
Character get(Object key)

Deprecated. Use specialization get(int) instead

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Specified by:

get in interface Map<Integer,Character>

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

get

char get(int 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
Character getOrDefault(Object key,
                                  Character defaultValue)

Deprecated. Use specialization getOrDefault(int, char) instead

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 default mapping of the key

Returns:

the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key

getOrDefault

char getOrDefault(int key,
                  char 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

void forEach(@Nonnull
             IntCharConsumer 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
                     IntCharPredicate 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
IntCharCursor 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 (IntCharCursor 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
IntSet keySet()

Description copied from interface: java.util.Map

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

keySet in interface Map<Integer,Character>

Returns:

a set view of the keys contained in this map

values

@Nonnull
CharCollection values()

Description copied from interface: java.util.Map

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

values in interface Map<Integer,Character>

Returns:

a collection view of the values contained in this map

entrySet

@Nonnull
ObjSet<Map.Entry<Integer,Character>> entrySet()

Description copied from interface: java.util.Map

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface Map<Integer,Character>

Returns:

a set view of the mappings contained in this map

put

@Deprecated
Character put(Integer key,
                         Character value)

Deprecated. Use specialization put(int, char) instead

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.)

Specified by:

put in interface Map<Integer,Character>

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 null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

put

char put(int key,
         char 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
Character putIfAbsent(Integer key,
                                          Character value)

Deprecated. Use specialization putIfAbsent(int, char) 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.

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

char putIfAbsent(int key,
                 char 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

char compute(int key,
             @Nonnull
             IntCharToCharFunction 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

char computeIfAbsent(int key,
                     @Nonnull
                     IntToCharFunction 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

char computeIfPresent(int key,
                      @Nonnull
                      IntCharToCharFunction 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

char merge(int key,
           char value,
           @Nonnull
           CharBinaryOperator 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

char addValue(int key,
              char 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

char addValue(int key,
              char addition,
              char 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(int, char) 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
Character replace(Integer key,
                                      Character value)

Deprecated. Use specialization replace(int, char) instead

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 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

char replace(int key,
             char 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(Integer key,
                           Character oldValue,
                           Character newValue)

Deprecated. Use specialization replace(int, char, char) instead

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:

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(int key,
                char oldValue,
                char 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

void replaceAll(@Nonnull
                IntCharToCharFunction 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
Character remove(Object key)

Deprecated. Use specialization remove(int) instead

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null 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 null.

The map will not contain a mapping for the specified key once the call returns.

Specified by:

remove in interface Map<Integer,Character>

Parameters:

key - key whose mapping is to be removed from the map

Returns:

the previous value associated with key, or null if there was no mapping for key.

remove

char remove(int 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(int, char) instead

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:

NullPointerException - if the specified key or value is null

UnsupportedOperationException - if the remove operation is not supported by this map

remove

boolean remove(int key,
               char 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
                 IntCharPredicate 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