it.unimi.dsi.fastutil.longs

Class Long2ReferenceFunctions.EmptyFunction<V>

java.lang.Object

it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceFunction<V>

it.unimi.dsi.fastutil.longs.Long2ReferenceFunctions.EmptyFunction<V>

All Implemented Interfaces:

Function<Long,V>, Long2ReferenceFunction<V>, Serializable, Cloneable

Direct Known Subclasses:

Long2ReferenceMaps.EmptyMap

Enclosing class:

Long2ReferenceFunctions

public static class Long2ReferenceFunctions.EmptyFunction<V>
extends AbstractLong2ReferenceFunction<V>
implements Serializable, Cloneable

An immutable class representing an empty type-specific function.

This class may be useful to implement your own in case you subclass a type-specific function.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Long2ReferenceFunctions.EmptyFunction()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all associations from this function (optional operation).
Object	clone()
boolean	containsKey(long k)
V	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(V defRetValue) Sets the default return value.
V	get(long k) Returns the value to which the given key is mapped.
V	get(Object k) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.

Methods inherited from class it.unimi.dsi.fastutil.longs.AbstractLong2ReferenceFunction

containsKey, put, put, remove, remove

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Long2ReferenceFunctions.EmptyFunction

protected Long2ReferenceFunctions.EmptyFunction()

Method Detail

get

public V get(long k)

Description copied from interface: Long2ReferenceFunction

Returns the value to which the given key is mapped.

Specified by:

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

containsKey

public boolean containsKey(long k)

Specified by:

containsKey in interface Long2ReferenceFunction<V>

See Also:

Function.containsKey(Object)

defaultReturnValue

public V defaultReturnValue()

Description copied from interface: Long2ReferenceFunction

Gets the default return value.

Specified by:

defaultReturnValue in interface Long2ReferenceFunction<V>

Overrides:

defaultReturnValue in class AbstractLong2ReferenceFunction<V>

Returns:

the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)

Description copied from interface: Long2ReferenceFunction

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

Overrides:

defaultReturnValue in class AbstractLong2ReferenceFunction<V>

Parameters:

defRetValue - the new default return value.

See Also:

Long2ReferenceFunction.defaultReturnValue()

get

public V get(Object k)

Description copied from class: AbstractLong2ReferenceFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

get in interface Function<Long,V>

Overrides:

get in class AbstractLong2ReferenceFunction<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)

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<Long,V>

Returns:

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

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<Long,V>

Overrides:

clear in class AbstractLong2ReferenceFunction<V>

See Also:

Map.clear()

clone

public Object clone()

Overrides:

clone in class Object