Package it.unimi.dsi.fastutil.objects

Class Reference2ReferenceFunctions.SynchronizedFunction<K,V>

java.lang.Object

it.unimi.dsi.fastutil.objects.Reference2ReferenceFunctions.SynchronizedFunction<K,V>

All Implemented Interfaces:

it.unimi.dsi.fastutil.Function<K,V>, Reference2ReferenceFunction<K,V>, java.io.Serializable, java.util.function.Function<K,V>

Direct Known Subclasses:

Reference2ReferenceMaps.SynchronizedMap

Enclosing class:

Reference2ReferenceFunctions

public static class Reference2ReferenceFunctions.SynchronizedFunction<K,V>
extends java.lang.Object
implements Reference2ReferenceFunction<K,V>, java.io.Serializable

A synchronized wrapper class for functions.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
V	apply(K key)
void	clear()
boolean	containsKey(java.lang.Object k)
V	defaultReturnValue()	Gets the default return value.
void	defaultReturnValue(V defRetValue)	Sets the default return value (optional operation).
boolean	equals(java.lang.Object o)
V	get(java.lang.Object k)	Returns the value to which the given key is mapped.
V	getOrDefault(java.lang.Object k, V defaultValue)	Returns the value associated by this function to the specified key, or give the specified value if not present.
int	hashCode()
V	put(K k, V v)	Adds a pair to the map (optional operation).
V	remove(java.lang.Object k)	Removes the mapping with the given key (optional operation).
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

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

andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

Method Details

apply

public V apply(K key)

Specified by:

apply in interface it.unimi.dsi.fastutil.Function<K,V>

Specified by:

apply in interface java.util.function.Function<K,V>

size

public int size()

Specified by:

size in interface it.unimi.dsi.fastutil.Function<K,V>

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.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

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:

defRetValue - the new default return value.

See Also:

Reference2ReferenceFunction.defaultReturnValue()

containsKey

public boolean containsKey(java.lang.Object k)

Specified by:

containsKey in interface it.unimi.dsi.fastutil.Function<K,V>

put

public V put(K k,
V v)

Description copied from interface: Reference2ReferenceFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface it.unimi.dsi.fastutil.Function<K,V>

Specified by:

put in interface Reference2ReferenceFunction<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(java.lang.Object k)

Description copied from interface: Reference2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface it.unimi.dsi.fastutil.Function<K,V>

Specified by:

get in interface Reference2ReferenceFunction<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)

getOrDefault

public V getOrDefault(java.lang.Object k,
V defaultValue)

Description copied from interface: Reference2ReferenceFunction

Returns the value associated by this function to the specified key, or give the specified value if not present.

Specified by:

getOrDefault in interface it.unimi.dsi.fastutil.Function<K,V>

Specified by:

getOrDefault in interface Reference2ReferenceFunction<K,V>

Parameters:

k - the key.

defaultValue - the value to return if not present.

Returns:

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

See Also:

Function.getOrDefault(Object, Object)

remove

public V remove(java.lang.Object k)

Description copied from interface: Reference2ReferenceFunction

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

Specified by:

remove in interface it.unimi.dsi.fastutil.Function<K,V>

Specified by:

remove in interface Reference2ReferenceFunction<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()

Specified by:

clear in interface it.unimi.dsi.fastutil.Function<K,V>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object