Package it.unimi.dsi.fastutil.chars

Class AbstractChar2IntMap

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction

it.unimi.dsi.fastutil.chars.AbstractChar2IntMap

All Implemented Interfaces:

Char2IntFunction, Char2IntMap, Function<Character,Integer>, Serializable, Function<Character,Integer>, IntUnaryOperator, Map<Character,Integer>

Direct Known Subclasses:

AbstractChar2IntSortedMap, Char2IntArrayMap, Char2IntOpenCustomHashMap, Char2IntOpenHashMap

public abstract class AbstractChar2IntMap
extends AbstractChar2IntFunction
implements Char2IntMap, Serializable

An abstract class providing basic methods for maps implementing a type-specific interface.

Optional operations just throw an UnsupportedOperationException. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules (they take care of returning null on a missing key).

As a further help, this class provides a BasicEntry inner class that implements a type-specific version of Map.Entry; it is particularly useful for those classes that do not implement their own entries (e.g., most immutable maps).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractChar2IntMap.BasicEntry	This class provides a basic but complete type-specific entry class for all those maps implementations that do not have entries on their own (e.g., most immutable maps).
static class	AbstractChar2IntMap.BasicEntrySet	This class provides a basic implementation for an Entry set which forwards some queries to the map.

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2IntMap

Char2IntMap.Entry, Char2IntMap.FastEntrySet

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(char k)	Returns true if this function contains a mapping for the specified key.
boolean	containsValue(int v)	Returns true if this map maps one or more keys to the specified value.
boolean	equals(Object o)
int	hashCode()	Returns a hash code for this map.
boolean	isEmpty()
CharSet	keySet()	Returns a type-specific-set view of the keys of this map.
final int	mergeInt(char key, int value, IntBinaryOperator remappingFunction)	If the specified key is not already associated with a value, associates it with the given value.
void	putAll(Map<? extends Character,? extends Integer> m)
String	toString()
IntCollection	values()	Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2IntFunction

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, get, put, remove

Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2IntMap

char2IntEntrySet, clear, compute, compute, computeIfAbsent, computeIfAbsent, computeIfAbsent, computeIfAbsentNullable, computeIfAbsentPartial, computeIfPresent, computeIfPresent, containsKey, containsValue, defaultReturnValue, defaultReturnValue, entrySet, forEach, get, getOrDefault, getOrDefault, merge, merge, mergeInt, put, putIfAbsent, putIfAbsent, remove, remove, remove, replace, replace, replace, replace, size

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose

Methods inherited from interface java.util.Map

replaceAll

Method Details

containsKey

public boolean containsKey(char k)

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

Specified by:

containsKey in interface Char2IntFunction

Specified by:

containsKey in interface Char2IntMap

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

• Map.containsKey(Object)

Implementation Specification:

This implementation does a linear search over the entry set, finding an entry that has the key specified.

If you override keySet(), you should probably override this method too to take advantage of the (presumably) faster key membership test your keySet() provides.

If you override this method but not keySet(), then the returned key set will take advantage of this method.

containsValue

public boolean containsValue(int v)

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

Specified by:

containsValue in interface Char2IntMap

See Also:

• Map.containsValue(Object)

Implementation Specification:

This implementation does a linear search over the entry set, finding an entry that has the value specified.

If you override values(), you should probably override this method too to take advantage of the (presumably) faster value membership test your values() provides.

If you override this method but not values(), then the returned values collection will take advantage of this method.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Character,Integer>

mergeInt

public final int mergeInt(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 associated value with the results of the given remapping function.

Specified by:

mergeInt in interface Char2IntMap

Parameters:

key - key with which the resulting value is to be associated.

value - the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.

remappingFunction - the function to recompute a value if present.

See Also:

• Map.merge(Object, Object, java.util.function.BiFunction)

Implementation Specification:

This method just delegates to the interface default method, as the default method, but it is final, so it cannot be overridden.

keySet

public CharSet keySet()

Returns a type-specific-set view of the keys of this map.

The view is backed by the set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

keySet in interface Char2IntMap

Specified by:

keySet in interface Map<Character,Integer>

Returns:

a set view of the keys of this map; it may be safely cast to a type-specific interface.

See Also:

• Map.keySet()

values

public IntCollection values()

Returns a type-specific-set view of the values of this map.

The view is backed by the set returned by Map.entrySet(). Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.

Specified by:

values in interface Char2IntMap

Specified by:

values in interface Map<Character,Integer>

Returns:

a set view of the values of this map; it may be safely cast to a type-specific interface.

See Also:

• Map.values()

putAll

public void putAll(Map<? extends Character,? extends Integer> m)

Specified by:

putAll in interface Map<Character,Integer>

hashCode

public int hashCode()

Returns a hash code for this map. The hash code of a map is computed by summing the hash codes of its entries.

Specified by:

hashCode in interface Map<Character,Integer>

Overrides:

hashCode in class Object

Returns:

a hash code for this map.

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Character,Integer>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object