com.koloboke.collect.map

Interface ObjCharMap<K>

All Superinterfaces:

Container, Map<K,Character>

All Known Subinterfaces:

HashObjCharMap<K>

public interface ObjCharMap<K>
extends Map<K,Character>, Container

A Map specialization with Object keys and char values.

See Also:

ObjCharMapFactory, @KolobokeMap

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
char	addValue(K 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(K 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.
Character	compute(K key, BiFunction<? super K,? super Character,? extends Character> remappingFunction) Deprecated. Use specialization compute(Object, ObjCharToCharFunction) instead
char	compute(K key, ObjCharToCharFunction<? super K> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (or default value if there is no current mapping).
Character	computeIfAbsent(K key, Function<? super K,? extends Character> mappingFunction) Deprecated. Use specialization computeIfAbsent(Object, ToCharFunction) instead
char	computeIfAbsent(K key, ToCharFunction<? super K> 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 .
Character	computeIfPresent(K key, BiFunction<? super K,? super Character,? extends Character> remappingFunction) Deprecated. Use specialization computeIfPresent(Object, ObjCharToCharFunction) instead
char	computeIfPresent(K key, ObjCharToCharFunction<? super K> 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	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
ObjCharCursor<K>	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<K,Character>>	entrySet()
void	forEach(BiConsumer<? super K,? super Character> action) Deprecated. Use specialization forEach(ObjCharConsumer) instead
void	forEach(ObjCharConsumer<? super K> 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(ObjCharPredicate<? super K> 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.
Character	get(Object key) Deprecated. Use specialization getChar(Object) instead
char	getChar(Object key) Returns the value to which the specified key is mapped, or default value if this map contains no mapping for the key.
char	getOrDefault(Object 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(Object, char) instead
Equivalence<K>	keyEquivalence() Returns the equivalence strategy for keys in this map.
ObjSet<K>	keySet()
Character	merge(K key, Character value, BiFunction<? super Character,? super Character,? extends Character> remappingFunction) Deprecated. Use specialization merge(Object, char, CharBinaryOperator) instead
char	merge(K 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(K key, char value) Associates the specified value with the specified key in this map (optional operation).
Character	put(K key, Character value) Deprecated. Use specialization put(Object, char) instead
char	putIfAbsent(K 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(K key, Character value) Deprecated. Use specialization putIfAbsent(Object, char) instead
Character	remove(Object key) Deprecated. Use specialization removeAsChar(Object) instead
boolean	remove(Object key, char value) Removes the entry for the specified key only if it is currently mapped to the specified value.
boolean	remove(Object key, Object value) Deprecated. Use specialization remove(Object, char) instead
char	removeAsChar(Object key) Removes the mapping for a key from this map if it is present (optional operation).
boolean	removeIf(ObjCharPredicate<? super K> filter) Removes all of the entries of this collection that satisfy the given predicate.
char	replace(K key, char value) Replaces the entry for the specified key only if it is currently mapped to some value.
Character	replace(K key, Character value) Deprecated. Use specialization replace(Object, char) instead
boolean	replace(K key, Character oldValue, Character newValue) Deprecated. Use specialization replace(Object, char, char) instead
boolean	replace(K key, char oldValue, char newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
void	replaceAll(BiFunction<? super K,? super Character,? extends Character> function) Deprecated. Use specialization replaceAll(ObjCharToCharFunction) instead
void	replaceAll(ObjCharToCharFunction<? super K> 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()

Methods inherited from interface Map

clear, containsKey, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface com.koloboke.collect.Container

clear, ensureCapacity, isEmpty, shrink, size, sizeAsLong

Method Detail

keyEquivalence

@Nonnull
Equivalence<K> keyEquivalence()

Returns the equivalence strategy for keys in this map. All methods in the Map interface which defined in terms of Object.equals(Object) equality of key objects (almost all methods, actually), are supposed to use this equivalence instead.

Returns:

the equivalence strategy for keys in this map

See Also:

HashObjCharMapFactory.withKeyEquivalence(com.koloboke.collect.Equivalence<? super K>)

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:

ObjCharMapFactory.withDefaultValue(char)

containsValue

@Deprecated
boolean containsValue(Object value)

Deprecated. Use specialization containsValue(char) instead

Specified by:

containsValue in interface Map<K,Character>

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 ObjCharMap 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 getChar(Object) instead

Specified by:

get in interface Map<K,Character>

getChar

char getChar(Object key)

Returns the value to which the specified key is mapped, or default value 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 keyEquivalence() == null ? (key==null ? k==null : key.equals(k)) : keyEquivalence().nullableEquivalent(k, key), then this method returns v; otherwise it returns default value. (There can be at most one such mapping.)

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

Throws:

ClassCastException - if the key is of an inappropriate type for this map (optional restriction)

NullPointerException - if the specified key is null and this map does not permit null keys (optional restriction)

getOrDefault

@Deprecated
Character getOrDefault(Object key,
                                    Character defaultValue)

Deprecated. Use specialization getOrDefault(Object, char) instead

Specified by:

getOrDefault in interface Map<K,Character>

getOrDefault

char getOrDefault(Object 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

Throws:

ClassCastException - if the key is of an inappropriate type for this map (optional restriction)

NullPointerException - if the specified key is null and this map does not permit null keys (optional restriction)

forEach

@Deprecated
void forEach(@Nonnull
                          BiConsumer<? super K,? super Character> action)

Deprecated. Use specialization forEach(ObjCharConsumer) instead

Specified by:

forEach in interface Map<K,Character>

forEach

void forEach(@Nonnull
             ObjCharConsumer<? super K> 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
                     ObjCharPredicate<? super K> 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
ObjCharCursor<K> 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 (ObjCharCursor<K> 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
ObjSet<K> keySet()

Specified by:

keySet in interface Map<K,Character>

values

@Nonnull
CharCollection values()

Specified by:

values in interface Map<K,Character>

entrySet

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

Specified by:

entrySet in interface Map<K,Character>

put

@Deprecated
Character put(K key,
                           Character value)

Deprecated. Use specialization put(Object, char) instead

Specified by:

put in interface Map<K,Character>

put

char put(K 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

ClassCastException - if the class of the specified key prevents it from being stored in this map

NullPointerException - if the specified key is null, and this map does not permit null keys

IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this map

putIfAbsent

@Nullable
 @Deprecated
Character putIfAbsent(K key,
                                               Character value)

Deprecated. Use specialization putIfAbsent(Object, 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.

Specified by:

putIfAbsent in interface Map<K,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 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 value is null

IllegalArgumentException - if some property of the specified key or value prevents it from being stored in this map

putIfAbsent

char putIfAbsent(K 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

ClassCastException - if the class of the specified key prevents it from being stored in this map

NullPointerException - if the specified key is null, and this map does not permit null keys

IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this map

compute

@Deprecated
Character compute(K key,
                               @Nonnull
                               BiFunction<? super K,? super Character,? extends Character> remappingFunction)

Deprecated. Use specialization compute(Object, ObjCharToCharFunction) instead

Specified by:

compute in interface Map<K,Character>

compute

char compute(K key,
             @Nonnull
             ObjCharToCharFunction<? super K> 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 or if the specified key is null and this map does not support null keys

Throws:

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

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

computeIfAbsent

@Deprecated
Character computeIfAbsent(K key,
                                       @Nonnull
                                       Function<? super K,? extends Character> mappingFunction)

Deprecated. Use specialization computeIfAbsent(Object, ToCharFunction) instead

Specified by:

computeIfAbsent in interface Map<K,Character>

computeIfAbsent

char computeIfAbsent(K key,
                     @Nonnull
                     ToCharFunction<? super K> 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 or if the specified key is null and this map does not support null keys

Throws:

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

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

computeIfPresent

@Deprecated
Character computeIfPresent(K key,
                                        @Nonnull
                                        BiFunction<? super K,? super Character,? extends Character> remappingFunction)

Deprecated. Use specialization computeIfPresent(Object, ObjCharToCharFunction) instead

Specified by:

computeIfPresent in interface Map<K,Character>

computeIfPresent

char computeIfPresent(K key,
                      @Nonnull
                      ObjCharToCharFunction<? super K> 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 or if the specified key is null and this map does not support null keys

Throws:

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

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

merge

@Deprecated
Character merge(K key,
                             Character value,
                             @Nonnull
                             BiFunction<? super Character,? super Character,? extends Character> remappingFunction)

Deprecated. Use specialization merge(Object, char, CharBinaryOperator) instead

Specified by:

merge in interface Map<K,Character>

merge

char merge(K 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 or if the specified key is null and this map does not support null keys or if the specified value is null and this map does not support null values

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

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

addValue

char addValue(K 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 or if the specified key is null and this map does not support null keys

Throws:

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

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

addValue

char addValue(K 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(Object, 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 or if the specified key is null and this map does not support null keys

Throws:

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

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

replace

@Nullable
 @Deprecated
Character replace(K key,
                                           Character value)

Deprecated. Use specialization replace(Object, char) instead

Replaces the entry for the specified key only if it is currently mapped to some value.

Specified by:

replace in interface Map<K,Character>

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 value is null

IllegalArgumentException - if some property of the specified value prevents it from being stored in this map

replace

char replace(K 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:

ClassCastException - if the class of the specified key prevents it from being stored in this map

NullPointerException - if the specified key is null, and this map does not permit null keys

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(K key,
                             Character oldValue,
                             Character newValue)

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

Replaces the entry for the specified key only if currently mapped to the specified value.

Specified by:

replace in interface Map<K,Character>

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 value is null

IllegalArgumentException - if some property of the specified value prevents it from being stored in this map

replace

boolean replace(K 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:

ClassCastException - if the class of the specified key prevents it from being stored in this map

NullPointerException - if the specified key is null, and this map does not permit null keys

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 K,? super Character,? extends Character> function)

Deprecated. Use specialization replaceAll(ObjCharToCharFunction) instead

Specified by:

replaceAll in interface Map<K,Character>

replaceAll

void replaceAll(@Nonnull
                ObjCharToCharFunction<? super K> 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 removeAsChar(Object) instead

Specified by:

remove in interface Map<K,Character>

removeAsChar

char removeAsChar(Object key)

Removes the mapping for a key from this map if it is present (optional operation).

More formally, if this map contains a mapping from a key k to a value v such that keyEquivalence() == null ? (key==null ? k==null : key.equals(k)) : keyEquivalence().nullableEquivalent(k, key), 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 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:

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

NullPointerException - if the specified key is null, and this map does not permit null keys (optional restriction)

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

remove

@Deprecated
boolean remove(Object key,
                            Object value)

Deprecated. Use specialization remove(Object, char) instead

Removes the entry for the specified key only if it is currently mapped to the specified value.

Specified by:

remove in interface Map<K,Character>

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 value is null , or if the specified key is null, and this map does not permit null keys (optional restriction)

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

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

remove

boolean remove(Object 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:

ClassCastException - if the class of the specified key prevents it from being stored in this map (optional restriction)

NullPointerException - if the specified key is null, and this map does not permit null keys (optional restriction)

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

removeIf

boolean removeIf(@Nonnull
                 ObjCharPredicate<? super K> 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