it.unimi.dsi.fastutil.objects

Interface Reference2BooleanFunction<K>

All Superinterfaces:

Function<K,Boolean>

All Known Subinterfaces:

Reference2BooleanMap<K>, Reference2BooleanSortedMap<K>

All Known Implementing Classes:

AbstractReference2BooleanFunction, AbstractReference2BooleanMap, AbstractReference2BooleanSortedMap, Reference2BooleanArrayMap, Reference2BooleanFunctions.EmptyFunction, Reference2BooleanFunctions.Singleton, Reference2BooleanFunctions.SynchronizedFunction, Reference2BooleanFunctions.UnmodifiableFunction, Reference2BooleanLinkedOpenHashMap, Reference2BooleanMaps.EmptyMap, Reference2BooleanMaps.Singleton, Reference2BooleanMaps.SynchronizedMap, Reference2BooleanMaps.UnmodifiableMap, Reference2BooleanOpenCustomHashMap, Reference2BooleanOpenHashMap, Reference2BooleanSortedMaps.EmptySortedMap, Reference2BooleanSortedMaps.Singleton, Reference2BooleanSortedMaps.SynchronizedSortedMap, Reference2BooleanSortedMaps.UnmodifiableSortedMap

public interface Reference2BooleanFunction<K>
extends Function<K,Boolean>

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

Modifier and Type	Method and Description
boolean	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(boolean rv) Sets the default return value.
boolean	getBoolean(Object key) Returns the value to which the given key is mapped.
boolean	put(K key, boolean value) Adds a pair to the map.
boolean	removeBoolean(Object 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

boolean put(K key,
            boolean 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)

getBoolean

boolean getBoolean(Object 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)

removeBoolean

boolean removeBoolean(Object key)

Removes the mapping with the given key.

Parameters:

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

defaultReturnValue

void defaultReturnValue(boolean 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

boolean defaultReturnValue()

Gets the default return value.

Returns:

the current default return value.