it.unimi.dsi.fastutil.objects

Class Object2IntFunctions.UnmodifiableFunction<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2IntFunction<K>

it.unimi.dsi.fastutil.objects.Object2IntFunctions.UnmodifiableFunction<K>

All Implemented Interfaces:

Object2IntFunction<K>, Serializable, Function<K,Integer>, ToIntFunction<K>

Direct Known Subclasses:

Object2IntMaps.UnmodifiableMap

Enclosing class:

Object2IntFunctions

public static class Object2IntFunctions.UnmodifiableFunction<K>
extends AbstractObject2IntFunction<K>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Object2IntFunction<K>	function

Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2IntFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableFunction(Object2IntFunction<K> f)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object k)
int	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(int defRetValue) Sets the default return value (optional operation).
boolean	equals(Object o)
Integer	get(Object k) Deprecated. Please use the corresponding type-specific method instead.
int	getInt(Object k) Returns the value to which the given key is mapped.
int	hashCode()
int	put(K k, int v) Adds a pair to the map (optional operation).
Integer	put(K k, Integer v) Deprecated. Please use the corresponding type-specific method instead.
Integer	remove(Object k) Deprecated. Please use the corresponding type-specific method instead.
int	removeInt(Object k) Removes the mapping with the given key (optional operation).
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.objects.Object2IntFunction

applyAsInt

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 Object2IntFunction<K> function

Constructor Detail

UnmodifiableFunction

protected UnmodifiableFunction(Object2IntFunction<K> f)

Method Detail

size

public int size()

defaultReturnValue

public int defaultReturnValue()

Description copied from interface: Object2IntFunction

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 Object2IntFunction<K>

Overrides:

defaultReturnValue in class AbstractObject2IntFunction<K>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(int defRetValue)

Description copied from interface: Object2IntFunction

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 Object2IntFunction<K>

Overrides:

defaultReturnValue in class AbstractObject2IntFunction<K>

Parameters:

defRetValue - the new default return value.

See Also:

Object2IntFunction.defaultReturnValue()

containsKey

public boolean containsKey(Object k)

put

public int put(K k,
               int v)

Description copied from interface: Object2IntFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Object2IntFunction<K>

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)

getInt

public int getInt(Object k)

Description copied from interface: Object2IntFunction

Returns the value to which the given key is mapped.

Specified by:

getInt in interface Object2IntFunction<K>

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)

removeInt

public int removeInt(Object k)

Description copied from interface: Object2IntFunction

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

Specified by:

removeInt in interface Object2IntFunction<K>

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 Integer put(K k,
                               Integer 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 Object2IntFunction<K>

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 Integer 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 Object2IntFunction<K>

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 Integer 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 Object2IntFunction<K>

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