it.unimi.dsi.fastutil.shorts

Class AbstractShort2CharFunction

java.lang.Object

it.unimi.dsi.fastutil.shorts.AbstractShort2CharFunction

All Implemented Interfaces:

Function<Short,Character>, Short2CharFunction, Serializable

Direct Known Subclasses:

AbstractShort2CharMap, Short2CharFunctions.EmptyFunction, Short2CharFunctions.Singleton, Short2CharFunctions.SynchronizedFunction, Short2CharFunctions.UnmodifiableFunction

public abstract class AbstractShort2CharFunction
extends Object
implements Short2CharFunction, 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

Field Summary

Fields

Modifier and Type	Field and Description
protected char	defRetValue The default return value for get(), put() and remove().
static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractShort2CharFunction()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2CharFunction

containsKey, get

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

size

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

defRetValue

protected char defRetValue

The default return value for get(), put() and remove().

Constructor Detail

AbstractShort2CharFunction

protected AbstractShort2CharFunction()

Method Detail

defaultReturnValue

public void defaultReturnValue(char rv)

Description copied from interface: Short2CharFunction

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 Short2CharFunction

Parameters:

rv - the new default return value.

See Also:

Short2CharFunction.defaultReturnValue()

defaultReturnValue

public char defaultReturnValue()

Description copied from interface: Short2CharFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Short2CharFunction

Returns:

the current default return value.

put

public char put(short key,
       char value)

Description copied from interface: Short2CharFunction

Adds a pair to the map.

Specified by:

put in interface Short2CharFunction

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 char remove(short key)

Description copied from interface: Short2CharFunction

Removes the mapping with the given key.

Specified by:

remove in interface Short2CharFunction

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<Short,Character>

See Also:

Map.clear()

containsKey

public boolean containsKey(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<Short,Character>

Parameters:

ok - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

get

public Character get(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<Short,Character>

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 Character put(Short ok,
            Character 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<Short,Character>

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 Character remove(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<Short,Character>

Returns:

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

See Also:

Map.remove(Object)