Package it.unimi.dsi.fastutil.objects

Interface Object2BooleanFunction<K>

All Superinterfaces:

Function<K,Boolean>, Function<K,Boolean>, Predicate<K>

All Known Subinterfaces:

Object2BooleanMap<K>, Object2BooleanSortedMap<K>

All Known Implementing Classes:

AbstractObject2BooleanFunction, AbstractObject2BooleanMap, AbstractObject2BooleanSortedMap, Object2BooleanArrayMap, Object2BooleanAVLTreeMap, Object2BooleanFunctions.EmptyFunction, Object2BooleanFunctions.PrimitiveFunction, Object2BooleanFunctions.Singleton, Object2BooleanFunctions.SynchronizedFunction, Object2BooleanFunctions.UnmodifiableFunction, Object2BooleanLinkedOpenCustomHashMap, Object2BooleanLinkedOpenHashMap, Object2BooleanMaps.EmptyMap, Object2BooleanMaps.Singleton, Object2BooleanMaps.SynchronizedMap, Object2BooleanMaps.UnmodifiableMap, Object2BooleanOpenCustomHashMap, Object2BooleanOpenHashMap, Object2BooleanRBTreeMap, Object2BooleanSortedMaps.EmptySortedMap, Object2BooleanSortedMaps.Singleton, Object2BooleanSortedMaps.SynchronizedSortedMap, Object2BooleanSortedMaps.UnmodifiableSortedMap

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Object2BooleanFunction<K>
extends Function<K,Boolean>, Predicate<K>

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/false at creation, but can be changed using the defaultReturnValue() method.

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

The default implementation of optional operations just throw an UnsupportedOperationException, except for the type-specific containsKey(), which return true. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules.

Warning: to fall in line as much as possible with the standard map interface, it is required that standard versions of get(), put() and remove() for maps with primitive-type keys or values return null to denote missing keys rather than wrap the default return value in an object. In case both keys and values are reference types, the default return value must be returned instead, thus violating the standard map interface when the default return value is not null.

See Also:

Function

Method Summary

Modifier and Type	Method	Description
default boolean	defaultReturnValue()	Gets the default return value.
default void	defaultReturnValue(boolean rv)	Sets the default return value (optional operation).
default Boolean	get(Object key)	Deprecated. Please use the corresponding type-specific method instead.
boolean	getBoolean(Object key)	Returns the value to which the given key is mapped.
default boolean	put(K key, boolean value)	Adds a pair to the map (optional operation).
default Boolean	put(K key, Boolean value)	Deprecated. Please use the corresponding type-specific method instead.
default Boolean	remove(Object key)	Deprecated. Please use the corresponding type-specific method instead.
default boolean	removeBoolean(Object key)	Removes the mapping with the given key (optional operation).
default boolean	test(K operand)

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

apply, clear, containsKey, size

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Detail

test

default boolean test(K operand)

Specified by:

test in interface Predicate<K>

Since:

8.0.0

put

default boolean put(K key,
                    boolean value)

Adds a pair to the map (optional operation).

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

default boolean removeBoolean(Object key)

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

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)

put

@Deprecated
default Boolean put(K key,
                    Boolean value)

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 Function<K,Boolean>

Parameters:

key - the key.

value - 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
default Boolean get(Object key)

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 Function<K,Boolean>

Parameters:

key - the key.

Returns:

the corresponding value, or null if no value was present for the given key.

See Also:

Map.get(Object)

remove

@Deprecated
default Boolean remove(Object key)

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 Function<K,Boolean>

Parameters:

key - the key.

Returns:

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

See Also:

Map.remove(Object)

defaultReturnValue

default void defaultReturnValue(boolean rv)

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.

Parameters:

rv - the new default return value.

See Also:

defaultReturnValue()

defaultReturnValue

default boolean defaultReturnValue()

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

Returns:

the current default return value.