it.unimi.dsi.fastutil.doubles

Class Double2ObjectFunctions.UnmodifiableFunction<V>

java.lang.Object

it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectFunction<V>

it.unimi.dsi.fastutil.doubles.Double2ObjectFunctions.UnmodifiableFunction<V>

All Implemented Interfaces:

Double2ObjectFunction<V>, Serializable, DoubleFunction<V>, Function<Double,V>

Direct Known Subclasses:

Double2ObjectMaps.UnmodifiableMap

Enclosing class:

Double2ObjectFunctions

public static class Double2ObjectFunctions.UnmodifiableFunction<V>
extends AbstractDouble2ObjectFunction<V>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Double2ObjectFunction<V>	function

Fields inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableFunction(Double2ObjectFunction<V> f)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(double 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 (optional operation).
boolean	equals(Object o)
V	get(double k) Returns the value to which the given key is mapped.
V	get(Object k) Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
V	put(double k, V v) Adds a pair to the map (optional operation).
V	put(Double k, V v) Deprecated. Please use the corresponding type-specific method instead.
V	remove(double k) Removes the mapping with the given key (optional operation).
V	remove(Object k) Deprecated. Please use the corresponding type-specific method instead.
int	size()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectFunction

apply, containsKey

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

function

protected final Double2ObjectFunction<V> function

Constructor Detail

UnmodifiableFunction

protected UnmodifiableFunction(Double2ObjectFunction<V> f)

Method Detail

size

public int size()

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Double2ObjectFunction

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 Double2ObjectFunction<V>

Overrides:

defaultReturnValue in class AbstractDouble2ObjectFunction<V>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

Description copied from interface: Double2ObjectFunction

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 Double2ObjectFunction<V>

Overrides:

defaultReturnValue in class AbstractDouble2ObjectFunction<V>

Parameters:

defRetValue - the new default return value.

See Also:

Double2ObjectFunction.defaultReturnValue()

containsKey

public boolean containsKey(double k)

Description copied from interface: Double2ObjectFunction

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. In particular, this default implementation always returns true.

Specified by:

containsKey in interface Double2ObjectFunction<V>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Function.containsKey(Object)

put

public V put(double k,
             V v)

Description copied from interface: Double2ObjectFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Double2ObjectFunction<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(double k)

Description copied from interface: Double2ObjectFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Double2ObjectFunction<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(double k)

Description copied from interface: Double2ObjectFunction

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

Specified by:

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

put

@Deprecated
public V put(Double k,
                         V v)

Deprecated. Please use the corresponding type-specific method instead.

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

Specified by:

put in interface Double2ObjectFunction<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)

get

@Deprecated
public V get(Object k)

Deprecated. Please use the corresponding type-specific method instead.

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

Specified by:

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

remove

@Deprecated
public V remove(Object k)

Deprecated. Please use the corresponding type-specific method instead.

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

Specified by:

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

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