it.unimi.dsi.fastutil.objects

Class Reference2ObjectFunctions.UnmodifiableFunction<K,V>

java.lang.Object

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

it.unimi.dsi.fastutil.objects.Reference2ObjectFunctions.UnmodifiableFunction<K,V>

All Implemented Interfaces:

Reference2ObjectFunction<K,V>, Serializable, Function<K,V>

Direct Known Subclasses:

Reference2ObjectMaps.UnmodifiableMap

Enclosing class:

Reference2ObjectFunctions

public static class Reference2ObjectFunctions.UnmodifiableFunction<K,V>
extends AbstractReference2ObjectFunction<K,V>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object k)
V	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(V defRetValue) Sets the default return value (optional operation).
boolean	equals(Object o)
V	get(Object k) Returns the value to which the given key is mapped.
int	hashCode()
V	put(K k, V v) Adds a pair to the map (optional operation).
V	remove(Object k) Removes the mapping with the given key (optional operation).
int	size()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

size

public int size()

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Reference2ObjectFunction

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

Overrides:

defaultReturnValue in class AbstractReference2ObjectFunction<K,V>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

Description copied from interface: Reference2ObjectFunction

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

Overrides:

defaultReturnValue in class AbstractReference2ObjectFunction<K,V>

Parameters:

defRetValue - the new default return value.

See Also:

Reference2ObjectFunction.defaultReturnValue()

containsKey

public boolean containsKey(Object k)

put

public V put(K k,
             V v)

Description copied from interface: Reference2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Reference2ObjectFunction<K,V>

Parameters:

k - the key.

v - 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)

get

public V get(Object k)

Description copied from interface: Reference2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Reference2ObjectFunction<K,V>

Parameters:

k - the key.

Returns:

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

See Also:

Function.get(Object)

remove

public V remove(Object k)

Description copied from interface: Reference2ObjectFunction

Removes the mapping with the given key (optional operation).

Specified by:

remove in interface Reference2ObjectFunction<K,V>

Parameters:

k - 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object