com.koloboke.collect.map

Interface ShortCharMap

All Superinterfaces:

Container, Map<Short,Character>

All Known Subinterfaces:

HashShortCharMap

public interface ShortCharMap
extends Map<Short,Character>, Container

A Map specialization with short keys and char values.

See Also:

ShortCharMapFactory, @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(short 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(short 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(Short key, BiFunction<? super Short,? super Character,? extends Character> remappingFunction) Deprecated. Use specialization compute(short, ShortCharToCharFunction) instead
char	compute(short key, ShortCharToCharFunction 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(Short key, Function<? super Short,? extends Character> mappingFunction) Deprecated. Use specialization computeIfAbsent(short, ShortToCharFunction) instead
char	computeIfAbsent(short key, ShortToCharFunction 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(Short key, BiFunction<? super Short,? super Character,? extends Character> remappingFunction) Deprecated. Use specialization computeIfPresent(short, ShortCharToCharFunction) instead
char	computeIfPresent(short key, ShortCharToCharFunction 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(Object key) Deprecated. Use specialization containsKey(short) instead
boolean	containsKey(short key) Returns true if this map contains a mapping for the specified key.
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
ShortCharCursor	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<Short,Character>>	entrySet()
void	forEach(BiConsumer<? super Short,? super Character> action) Deprecated. Use specialization forEach(ShortCharConsumer) instead
void	forEach(ShortCharConsumer 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(ShortCharPredicate 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 get(short) instead
char	get(short key) Returns the value to which the specified key is mapped, or default value if this map contains no mapping for the key.
Character	getOrDefault(Object key, Character defaultValue) Deprecated. Use specialization getOrDefault(short, char) instead
char	getOrDefault(short key, char defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
ShortSet	keySet()
Character	merge(Short key, Character value, BiFunction<? super Character,? super Character,? extends Character> remappingFunction) Deprecated. Use specialization merge(short, char, CharBinaryOperator) instead
char	merge(short 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(short key, char value) Associates the specified value with the specified key in this map (optional operation).
Character	put(Short key, Character value) Deprecated. Use specialization put(short, char) instead
char	putIfAbsent(short 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(Short key, Character value) Deprecated. Use specialization putIfAbsent(short, char) instead
Character	remove(Object key) Deprecated. Use specialization remove(short) instead
boolean	remove(Object key, Object value) Deprecated. Use specialization remove(short, char) instead
char	remove(short key) Removes the mapping for a key from this map if it is present (optional operation).
boolean	remove(short key, char value) Removes the entry for the specified key only if it is currently mapped to the specified value.
boolean	removeIf(ShortCharPredicate filter) Removes all of the entries of this collection that satisfy the given predicate.
char	replace(short key, char value) Replaces the entry for the specified key only if it is currently mapped to some value.
Character	replace(Short key, Character value) Deprecated. Use specialization replace(short, char) instead
boolean	replace(Short key, Character oldValue, Character newValue) Deprecated. Use specialization replace(short, char, char) instead
boolean	replace(short key, char oldValue, char newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
void	replaceAll(BiFunction<? super Short,? super Character,? extends Character> function) Deprecated. Use specialization replaceAll(ShortCharToCharFunction) instead
void	replaceAll(ShortCharToCharFunction 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, 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:

ShortCharMapFactory.withDefaultValue(char)

containsKey

@Deprecated
boolean containsKey(Object key)

Deprecated. Use specialization containsKey(short) instead

Specified by:

containsKey in interface Map<Short,Character>

containsKey

boolean containsKey(short key)

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

Parameters:

key - the short 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

Specified by:

containsValue in interface Map<Short,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 ShortCharMap 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(short) instead

Specified by:

get in interface Map<Short,Character>

get

char get(short 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(short, char) instead

Specified by:

getOrDefault in interface Map<Short,Character>

getOrDefault

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

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

Deprecated. Use specialization forEach(ShortCharConsumer) instead

Specified by:

forEach in interface Map<Short,Character>

forEach

void forEach(@Nonnull
             ShortCharConsumer 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
                     ShortCharPredicate 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
ShortCharCursor 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 (ShortCharCursor 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
ShortSet keySet()

Specified by:

keySet in interface Map<Short,Character>

values

@Nonnull
CharCollection values()

Specified by:

values in interface Map<Short,Character>

entrySet

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

Specified by:

entrySet in interface Map<Short,Character>

put

@Deprecated
Character put(Short key,
                           Character value)

Deprecated. Use specialization put(short, char) instead

Specified by:

put in interface Map<Short,Character>

put

char put(short 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(Short key,
                                               Character value)

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

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

Deprecated. Use specialization compute(short, ShortCharToCharFunction) instead

Specified by:

compute in interface Map<Short,Character>

compute

char compute(short key,
             @Nonnull
             ShortCharToCharFunction 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
Character computeIfAbsent(Short key,
                                       @Nonnull
                                       Function<? super Short,? extends Character> mappingFunction)

Deprecated. Use specialization computeIfAbsent(short, ShortToCharFunction) instead

Specified by:

computeIfAbsent in interface Map<Short,Character>

computeIfAbsent

char computeIfAbsent(short key,
                     @Nonnull
                     ShortToCharFunction 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
Character computeIfPresent(Short key,
                                        @Nonnull
                                        BiFunction<? super Short,? super Character,? extends Character> remappingFunction)

Deprecated. Use specialization computeIfPresent(short, ShortCharToCharFunction) instead

Specified by:

computeIfPresent in interface Map<Short,Character>

computeIfPresent

char computeIfPresent(short key,
                      @Nonnull
                      ShortCharToCharFunction 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
Character merge(Short key,
                             Character value,
                             @Nonnull
                             BiFunction<? super Character,? super Character,? extends Character> remappingFunction)

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

Specified by:

merge in interface Map<Short,Character>

merge

char merge(short 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(short 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(short 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(short, 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(Short key,
                                           Character value)

Deprecated. Use specialization replace(short, char) instead

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

Specified by:

replace in interface Map<Short,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 key or value is null

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

replace

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

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

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

Specified by:

replace in interface Map<Short,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 key or value is null

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

replace

boolean replace(short 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

@Deprecated
void replaceAll(@Nonnull
                             BiFunction<? super Short,? super Character,? extends Character> function)

Deprecated. Use specialization replaceAll(ShortCharToCharFunction) instead

Specified by:

replaceAll in interface Map<Short,Character>

replaceAll

void replaceAll(@Nonnull
                ShortCharToCharFunction 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(short) instead

Specified by:

remove in interface Map<Short,Character>

remove

char remove(short 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(short, 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<Short,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 key or value is null

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

remove

boolean remove(short 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
                 ShortCharPredicate 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