it.unimi.dsi.fastutil.chars

Class AbstractChar2IntFunction

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction

All Implemented Interfaces:

Char2IntFunction, Function<java.lang.Character,java.lang.Integer>, java.io.Serializable

Direct Known Subclasses:

AbstractChar2IntMap, Char2IntFunctions.EmptyFunction, Char2IntFunctions.Singleton, Char2IntFunctions.SynchronizedFunction, Char2IntFunctions.UnmodifiableFunction

public abstract class AbstractChar2IntFunction
extends java.lang.Object
implements Char2IntFunction, java.io.Serializable

An abstract class providing basic methods for functions 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).

This class handles directly a default return value (including methods to access it). Instances of classes inheriting from this class have just to return defRetValue to denote lack of a key in type-specific methods. The value is serialized.

Implementing subclasses have just to provide type-specific get(), type-specific containsKey(), and size() methods.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(java.lang.Object ok) Returns true if this function contains a mapping for the specified key.
int	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(int rv) Sets the default return value.
java.lang.Integer	get(java.lang.Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
java.lang.Integer	put(java.lang.Character ok, java.lang.Integer ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	put(char key, int value) Adds a pair to the map.
int	remove(char key) Removes the mapping with the given key.
java.lang.Integer	remove(java.lang.Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

containsKey, get

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

size

Method Detail

defaultReturnValue

public void defaultReturnValue(int rv)

Description copied from interface: Char2IntFunction

Sets the default return value. This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false/null by default.

Specified by:

defaultReturnValue in interface Char2IntFunction

Parameters:

rv - the new default return value.

See Also:

Char2IntFunction.defaultReturnValue()

defaultReturnValue

public int defaultReturnValue()

Description copied from interface: Char2IntFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Char2IntFunction

Returns:

the current default return value.

put

public int put(char key,
      int value)

Description copied from interface: Char2IntFunction

Adds a pair to the map.

Specified by:

put in interface Char2IntFunction

Parameters:

key - the key.

value - the value.

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.put(Object,Object)

remove

public int remove(char key)

Description copied from interface: Char2IntFunction

Removes the mapping with the given key.

Specified by:

remove in interface Char2IntFunction

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.remove(Object)

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<java.lang.Character,java.lang.Integer>

See Also:

Map.clear()

containsKey

public boolean containsKey(java.lang.Object ok)

Description copied from interface: Function

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

Note that for some kind of functions (e.g., hashes) this method will always return true.

Specified by:

containsKey in interface Function<java.lang.Character,java.lang.Integer>

Parameters:

ok - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

get

public java.lang.Integer get(java.lang.Object ok)

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

get in interface Function<java.lang.Character,java.lang.Integer>

Parameters:

ok - the key.

Returns:

the corresponding value, or null if no value was present for the given key.

See Also:

Map.get(Object)

put

public java.lang.Integer put(java.lang.Character ok,
                    java.lang.Integer ov)

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

put in interface Function<java.lang.Character,java.lang.Integer>

Parameters:

ok - the key.

ov - the value.

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.put(Object,Object)

remove

public java.lang.Integer remove(java.lang.Object ok)

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

remove in interface Function<java.lang.Character,java.lang.Integer>

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)