it.unimi.dsi.fastutil.objects

Class AbstractReference2ReferenceFunction<K,V>

java.lang.Object

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

All Implemented Interfaces:

Reference2ReferenceFunction<K,V>, Serializable, Function<K,V>

Direct Known Subclasses:

AbstractReference2ReferenceMap, Reference2ReferenceFunctions.EmptyFunction, Reference2ReferenceFunctions.Singleton, Reference2ReferenceFunctions.UnmodifiableFunction

public abstract class AbstractReference2ReferenceFunction<K,V>
extends Object
implements Reference2ReferenceFunction<K,V>, 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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractReference2ReferenceFunction()

Method Summary

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

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.Reference2ReferenceFunction

get, put, remove

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

apply, clear, containsKey, size

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

defRetValue

protected V defRetValue

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

Constructor Detail

AbstractReference2ReferenceFunction

protected AbstractReference2ReferenceFunction()

Method Detail

defaultReturnValue

public void defaultReturnValue(V rv)

Description copied from interface: Reference2ReferenceFunction

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

Parameters:

rv - the new default return value.

See Also:

Reference2ReferenceFunction.defaultReturnValue()

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Reference2ReferenceFunction

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

Returns:

the current default return value.