Package it.unimi.dsi.fastutil.objects

Class AbstractObject2ReferenceFunction<K,V>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction<K,V>

All Implemented Interfaces:

Function<K,V>, Object2ReferenceFunction<K,V>, java.io.Serializable, java.util.function.Function<K,V>

Direct Known Subclasses:

AbstractObject2ReferenceMap, Object2ReferenceFunctions.EmptyFunction, Object2ReferenceFunctions.Singleton, Object2ReferenceFunctions.UnmodifiableFunction

public abstract class AbstractObject2ReferenceFunction<K,V>
extends java.lang.Object
implements Object2ReferenceFunction<K,V>, java.io.Serializable

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

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

Modifier and Type	Method	Description
V	defaultReturnValue()	Gets the default return value.
void	defaultReturnValue(V rv)	Sets the default return value (optional operation).

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

apply, clear, containsKey, size

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ReferenceFunction

get, put, remove

Method Detail

defaultReturnValue

public void defaultReturnValue(V rv)

Description copied from interface: Object2ReferenceFunction

Sets the default return value (optional operation). 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 Object2ReferenceFunction<K,V>

Parameters:

rv - the new default return value.

See Also:

Object2ReferenceFunction.defaultReturnValue()

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Object2ReferenceFunction

Gets the default return value.

This default implementation just return the default null value of the type (null for objects, 0 for scalars, false for Booleans).

Specified by:

defaultReturnValue in interface Object2ReferenceFunction<K,V>

Returns:

the current default return value.