it.unimi.dsi.fastutil.objects

Class AbstractObject2IntFunction<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2IntFunction<K>

All Implemented Interfaces:

Function<K,java.lang.Integer>, Object2IntFunction<K>, java.io.Serializable

Direct Known Subclasses:

AbstractObject2IntMap

public abstract class AbstractObject2IntFunction<K>
extends java.lang.Object
implements Object2IntFunction<K>, 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

Field Summary

Fields

Modifier and Type	Field and Description
protected int	defRetValue The default return value for get(), put() and remove().

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractObject2IntFunction()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
int	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(int rv) Sets the default return value.
java.lang.Integer	get(java.lang.Object ok) Deprecated. Please use the corresponding type-specific method instead.
int	put(K key, int value) Adds a pair to the map.
java.lang.Integer	put(K ok, java.lang.Integer ov) Deprecated. Please use the corresponding type-specific method instead.
java.lang.Integer	remove(java.lang.Object ok) Deprecated. Please use the corresponding type-specific method instead.
int	removeInt(java.lang.Object 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.objects.Object2IntFunction

getInt

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

containsKey, size

Field Detail

defRetValue

protected int defRetValue

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

Constructor Detail

AbstractObject2IntFunction

protected AbstractObject2IntFunction()

Method Detail

defaultReturnValue

public void defaultReturnValue(int rv)

Description copied from interface: Object2IntFunction

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 Object2IntFunction<K>

Parameters:

rv - the new default return value.

See Also:

Object2IntFunction.defaultReturnValue()

defaultReturnValue

public int defaultReturnValue()

Description copied from interface: Object2IntFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Object2IntFunction<K>

Returns:

the current default return value.

put

public int put(K key,
               int value)

Description copied from interface: Object2IntFunction

Adds a pair to the map.

Specified by:

put in interface Object2IntFunction<K>

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)

removeInt

public int removeInt(java.lang.Object key)

Description copied from interface: Object2IntFunction

Removes the mapping with the given key.

Specified by:

removeInt in interface Object2IntFunction<K>

Parameters:

key - the key.

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<K,java.lang.Integer>

See Also:

Map.clear()

get

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

Deprecated. Please use the corresponding type-specific method instead.

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<K,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

@Deprecated
public java.lang.Integer put(K ok,
                                         java.lang.Integer ov)

Deprecated. Please use the corresponding type-specific method instead.

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<K,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

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

Deprecated. Please use the corresponding type-specific method instead.

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<K,java.lang.Integer>

Parameters:

ok - the key.

Returns:

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

See Also:

Map.remove(Object)