it.unimi.dsi.fastutil.chars

Interface Char2ReferenceFunction<V>

All Superinterfaces:

Function<Character,V>

All Known Subinterfaces:

Char2ReferenceMap<V>, Char2ReferenceSortedMap<V>

All Known Implementing Classes:

AbstractChar2ReferenceFunction, AbstractChar2ReferenceMap, AbstractChar2ReferenceSortedMap, Char2ReferenceArrayMap, Char2ReferenceAVLTreeMap, Char2ReferenceFunctions.EmptyFunction, Char2ReferenceFunctions.Singleton, Char2ReferenceFunctions.SynchronizedFunction, Char2ReferenceFunctions.UnmodifiableFunction, Char2ReferenceLinkedOpenHashMap, Char2ReferenceMaps.EmptyMap, Char2ReferenceMaps.Singleton, Char2ReferenceMaps.SynchronizedMap, Char2ReferenceMaps.UnmodifiableMap, Char2ReferenceOpenHashMap, Char2ReferenceRBTreeMap, Char2ReferenceSortedMaps.EmptySortedMap, Char2ReferenceSortedMaps.Singleton, Char2ReferenceSortedMaps.SynchronizedSortedMap, Char2ReferenceSortedMaps.UnmodifiableSortedMap

public interface Char2ReferenceFunction<V>
extends Function<Character,V>

A type-specific Function; provides some additional methods that use polymorphism to avoid (un)boxing.

Type-specific versions of get(), put() and remove() cannot rely on null to denote absence of a key. Rather, they return a default return value, which is set to 0 cast to the return type (false for booleans) at creation, but can be changed using the defaultReturnValue() method.

For uniformity reasons, even maps returning objects implement the default return value (of course, in this case the default return value is initialized to null).

Warning: to fall in line as much as possible with the standard map interface, it is strongly suggested that standard versions of get(), put() and remove() for maps with primitive-type values return null to denote missing keys rather than wrap the default return value in an object (of course, for maps with object keys and values this is not possible, as there is no type-specific version).

See Also:

Function

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(char key)
V	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(V rv) Sets the default return value.
V	get(char key) Returns the value to which the given key is mapped.
V	put(char key, V value) Adds a pair to the map.
V	remove(char key) Removes the mapping with the given key.

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

clear, containsKey, get, put, remove, size

Method Detail

put

V put(char key,
    V value)

Adds a pair to the map.

Parameters:

key - the key.

value - 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

V get(char key)

Returns the value to which the given key is mapped.

Parameters:

key - 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

V remove(char key)

Removes the mapping with the given key.

Parameters:

key -

Returns:

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

See Also:

Function.remove(Object)

containsKey

boolean containsKey(char key)

See Also:

Function.containsKey(Object)

defaultReturnValue

void defaultReturnValue(V rv)

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.

Parameters:

rv - the new default return value.

See Also:

defaultReturnValue()

defaultReturnValue

V defaultReturnValue()

Gets the default return value.

Returns:

the current default return value.