Interface Boolean2BooleanFunction
-
- All Superinterfaces:
Function<java.lang.Boolean,java.lang.Boolean>
,java.util.function.Function<java.lang.Boolean,java.lang.Boolean>
- All Known Implementing Classes:
AbstractBoolean2BooleanFunction
- 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 Boolean2BooleanFunction extends Function<java.lang.Boolean,java.lang.Boolean>
A type-specificFunction
; provides some additional methods that use polymorphism to avoid (un)boxing.Type-specific versions of
get()
,put()
andremove()
cannot rely onnull
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 thedefaultReturnValue()
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-specificcontainsKey()
, 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()
andremove()
for maps with primitive-type keys or values returnnull
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 notnull
.- See Also:
Function
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default Boolean2ByteFunction
andThen(Boolean2ByteFunction after)
default Boolean2CharFunction
andThen(Boolean2CharFunction after)
default Boolean2DoubleFunction
andThen(Boolean2DoubleFunction after)
default Boolean2FloatFunction
andThen(Boolean2FloatFunction after)
default Boolean2IntFunction
andThen(Boolean2IntFunction after)
default Boolean2LongFunction
andThen(Boolean2LongFunction after)
default <T> Boolean2ObjectFunction<T>
andThen(Boolean2ObjectFunction<T> after)
default <T> Boolean2ReferenceFunction<T>
andThen(Boolean2ReferenceFunction<T> after)
default Boolean2ShortFunction
andThen(Boolean2ShortFunction after)
default Byte2BooleanFunction
compose(Byte2BooleanFunction before)
default Char2BooleanFunction
compose(Char2BooleanFunction before)
default Double2BooleanFunction
compose(Double2BooleanFunction before)
default Float2BooleanFunction
compose(Float2BooleanFunction before)
default Int2BooleanFunction
compose(Int2BooleanFunction before)
default Long2BooleanFunction
compose(Long2BooleanFunction before)
default <T> Object2BooleanFunction<T>
compose(Object2BooleanFunction<T> before)
default <T> Reference2BooleanFunction<T>
compose(Reference2BooleanFunction<T> before)
default Short2BooleanFunction
compose(Short2BooleanFunction before)
default boolean
containsKey(boolean key)
Returns true if this function contains a mapping for the specified key.default boolean
containsKey(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default boolean
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(boolean rv)
Sets the default return value (optional operation).boolean
get(boolean key)
Returns the value to which the given key is mapped.default java.lang.Boolean
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.static Boolean2BooleanFunction
identity()
default boolean
put(boolean key, boolean value)
Adds a pair to the map (optional operation).default java.lang.Boolean
put(java.lang.Boolean key, java.lang.Boolean value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(boolean key)
Removes the mapping with the given key (optional operation).default java.lang.Boolean
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
put
default boolean put(boolean 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)
-
get
boolean get(boolean 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
default boolean remove(boolean 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 java.lang.Boolean put(java.lang.Boolean key, java.lang.Boolean value)
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).
-
get
@Deprecated default java.lang.Boolean get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.
-
remove
@Deprecated default java.lang.Boolean remove(java.lang.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).
-
containsKey
default boolean containsKey(boolean key)
Returns true if this function contains a mapping for the specified key.Note that for some kind of functions (e.g., hashes) this method will always return true. In particular, this default implementation always returns true.
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Function.containsKey(Object)
-
containsKey
@Deprecated default boolean containsKey(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns true if this function contains a mapping for the specified key.Note that for some kind of functions (e.g., hashes) this method will always return true. This default implementation, in particular, always return true.
- Specified by:
containsKey
in interfaceFunction<java.lang.Boolean,java.lang.Boolean>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(boolean rv)
Sets the default return value (optional operation). This value must be returned by type-specific versions ofget()
,put()
andremove()
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.
-
identity
static Boolean2BooleanFunction identity()
-
andThen
default Boolean2ByteFunction andThen(Boolean2ByteFunction after)
-
compose
default Byte2BooleanFunction compose(Byte2BooleanFunction before)
-
andThen
default Boolean2ShortFunction andThen(Boolean2ShortFunction after)
-
compose
default Short2BooleanFunction compose(Short2BooleanFunction before)
-
andThen
default Boolean2IntFunction andThen(Boolean2IntFunction after)
-
compose
default Int2BooleanFunction compose(Int2BooleanFunction before)
-
andThen
default Boolean2LongFunction andThen(Boolean2LongFunction after)
-
compose
default Long2BooleanFunction compose(Long2BooleanFunction before)
-
andThen
default Boolean2CharFunction andThen(Boolean2CharFunction after)
-
compose
default Char2BooleanFunction compose(Char2BooleanFunction before)
-
andThen
default Boolean2FloatFunction andThen(Boolean2FloatFunction after)
-
compose
default Float2BooleanFunction compose(Float2BooleanFunction before)
-
andThen
default Boolean2DoubleFunction andThen(Boolean2DoubleFunction after)
-
compose
default Double2BooleanFunction compose(Double2BooleanFunction before)
-
andThen
default <T> Boolean2ObjectFunction<T> andThen(Boolean2ObjectFunction<T> after)
-
compose
default <T> Object2BooleanFunction<T> compose(Object2BooleanFunction<T> before)
-
andThen
default <T> Boolean2ReferenceFunction<T> andThen(Boolean2ReferenceFunction<T> after)
-
compose
default <T> Reference2BooleanFunction<T> compose(Reference2BooleanFunction<T> before)
-
-