Interface Int2BooleanFunction
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
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:
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Please use the corresponding type-specific method instead.default Int2ByteFunctionandThenByte(Boolean2ByteFunction after) default Int2CharFunctionandThenChar(Boolean2CharFunction after) default Int2DoubleFunctiondefault Int2FloatFunctiondefault Int2IntFunctionandThenInt(Boolean2IntFunction after) default Int2LongFunctionandThenLong(Boolean2LongFunction after) default <T> Int2ObjectFunction<T> andThenObject(Boolean2ObjectFunction<? extends T> after) default <T> Int2ReferenceFunction<T> andThenReference(Boolean2ReferenceFunction<? extends T> after) default Int2ShortFunctionDeprecated.Please use the corresponding type-specific method instead.default Byte2BooleanFunctioncomposeByte(Byte2IntFunction before) default Char2BooleanFunctioncomposeChar(Char2IntFunction before) default Double2BooleanFunctioncomposeDouble(Double2IntFunction before) default Float2BooleanFunctioncomposeFloat(Float2IntFunction before) default Int2BooleanFunctioncomposeInt(Int2IntFunction before) default Long2BooleanFunctioncomposeLong(Long2IntFunction before) default <T> Object2BooleanFunction<T> composeObject(Object2IntFunction<? super T> before) default <T> Reference2BooleanFunction<T> composeReference(Reference2IntFunction<? super T> before) default Short2BooleanFunctioncomposeShort(Short2IntFunction before) default booleancontainsKey(int key) Returns true if this function contains a mapping for the specified key.default booleancontainsKey(Object key) Deprecated.Please use the corresponding type-specific method instead.default booleanGets the default return value.default voiddefaultReturnValue(boolean rv) Sets the default return value (optional operation).booleanget(int key) Returns the value to which the given key is mapped.default BooleanDeprecated.Please use the corresponding type-specific method instead.default booleangetOrDefault(int key, boolean defaultValue) Returns the value associated by this function to the specified key, or give the specified value if not present.default BooleangetOrDefault(Object key, Boolean defaultValue) Deprecated.Please use the corresponding type-specific method instead.default booleanput(int key, boolean value) Adds a pair to the map (optional operation).default BooleanDeprecated.Please use the corresponding type-specific method instead.default booleanremove(int key) Removes the mapping with the given key (optional operation).default BooleanDeprecated.Please use the corresponding type-specific method instead.default booleantest(int operand) Methods inherited from interface java.util.function.IntPredicate
and, negate, or
-
Method Details
-
test
default boolean test(int operand) - Specified by:
testin interfaceIntPredicate- Since:
- 8.0.0
-
put
default boolean put(int 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:
-
get
boolean get(int 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:
-
getOrDefault
default boolean getOrDefault(int key, boolean defaultValue) Returns the value associated by this function to the specified key, or give the specified value if not present.- Parameters:
key- the key.defaultValue- the value to return if not present.- Returns:
- the corresponding value, or
defaultValueif no value was present for the given key. - Since:
- 8.5.0
- See Also:
-
remove
default boolean remove(int 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:
-
put
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation). -
get
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key. -
getOrDefault
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key, or give the specified value if not present.- Specified by:
getOrDefaultin interfaceFunction<Integer,Boolean> - Parameters:
key- the key.defaultValue- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValueif no value was present for the given key. - See Also:
-
remove
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(int 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:
-
containsKey
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:
containsKeyin interfaceFunction<Integer,Boolean> - Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
-
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/nullby default.- Parameters:
rv- the new default return value.- See Also:
-
defaultReturnValue
default boolean defaultReturnValue()Gets the default return value.This default implementation just return the default null value of the type (
nullfor objects, 0 for scalars, false for Booleans).- Returns:
- the current default return value.
-
compose
Deprecated.Please use the corresponding type-specific method instead. -
andThen
Deprecated.Please use the corresponding type-specific method instead. -
andThenByte
-
composeByte
-
andThenShort
-
composeShort
-
andThenInt
-
composeInt
-
andThenLong
-
composeLong
-
andThenChar
-
composeChar
-
andThenFloat
-
composeFloat
-
andThenDouble
-
composeDouble
-
andThenObject
-
composeObject
-
andThenReference
-
composeReference
-