it.unimi.dsi.fastutil.objects

Class Reference2ObjectFunctions.SynchronizedFunction<K,V>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Reference2ObjectMaps.SynchronizedMap

Enclosing class:

Reference2ObjectFunctions

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

A synchronized wrapper class for functions.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
boolean	containsKey(Object k) Returns true if this function contains a mapping for the specified key.
V	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(V defRetValue) Sets the default return value.
V	get(Object k) Returns the value associated by this function to the specified key.
V	put(K k, V v) Associates the specified value with the specified key in this function (optional operation).
V	remove(Object k) Removes this key and the associated value from this function if it is present (optional operation).
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

size

public int size()

Description copied from interface: Function

Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:

size in interface Function<K,V>

Returns:

the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(Object k)

Description copied from interface: Function

Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true.

Specified by:

containsKey in interface Function<K,V>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Reference2ObjectFunction

Gets the default return value.

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

put

public V put(K k,
             V v)

Description copied from interface: Function

Associates the specified value with the specified key in this function (optional operation).

Specified by:

put in interface Function<K,V>

Overrides:

put in class AbstractReference2ObjectFunction<K,V>

Parameters:

k - the key.

v - the value.

Returns:

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

See Also:

Map.put(Object,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,V>

Overrides:

clear in class AbstractReference2ObjectFunction<K,V>

See Also:

Map.clear()

toString

public String toString()

Overrides:

toString in class Object

remove

public V remove(Object k)

Description copied from interface: Function

Removes this key and the associated value from this function if it is present (optional operation).

Specified by:

remove in interface Function<K,V>

Overrides:

remove in class AbstractReference2ObjectFunction<K,V>

Parameters:

k - the key.

Returns:

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

See Also:

Map.remove(Object)

get

public V get(Object k)

Description copied from interface: Function

Returns the value associated by this function to the specified key.

Specified by:

get in interface Function<K,V>

Parameters:

k - the key.

Returns:

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

See Also:

Map.get(Object)