@FunctionalInterface public interface Int2BooleanFunction extends Function<java.lang.Integer,java.lang.Boolean>, java.util.function.IntPredicate
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
.
Function
Modifier and Type | Method and Description |
---|---|
default <T> java.util.function.Function<java.lang.Integer,T> |
andThen(java.util.function.Function<? super java.lang.Boolean,? extends T> after)
Deprecated.
Please use the corresponding type-specific method instead.
|
default Int2ByteFunction |
andThenByte(Boolean2ByteFunction after) |
default Int2CharFunction |
andThenChar(Boolean2CharFunction after) |
default Int2DoubleFunction |
andThenDouble(Boolean2DoubleFunction after) |
default Int2FloatFunction |
andThenFloat(Boolean2FloatFunction after) |
default Int2IntFunction |
andThenInt(Boolean2IntFunction after) |
default Int2LongFunction |
andThenLong(Boolean2LongFunction after) |
default <T> Int2ObjectFunction<T> |
andThenObject(Boolean2ObjectFunction<? extends T> after) |
default <T> Int2ReferenceFunction<T> |
andThenReference(Boolean2ReferenceFunction<? extends T> after) |
default Int2ShortFunction |
andThenShort(Boolean2ShortFunction after) |
default <T> java.util.function.Function<T,java.lang.Boolean> |
compose(java.util.function.Function<? super T,? extends java.lang.Integer> before)
Deprecated.
Please use the corresponding type-specific method instead.
|
default Byte2BooleanFunction |
composeByte(Byte2IntFunction before) |
default Char2BooleanFunction |
composeChar(Char2IntFunction before) |
default Double2BooleanFunction |
composeDouble(Double2IntFunction before) |
default Float2BooleanFunction |
composeFloat(Float2IntFunction before) |
default Int2BooleanFunction |
composeInt(Int2IntFunction before) |
default Long2BooleanFunction |
composeLong(Long2IntFunction before) |
default <T> Object2BooleanFunction<T> |
composeObject(Object2IntFunction<? super T> before) |
default <T> Reference2BooleanFunction<T> |
composeReference(Reference2IntFunction<? super T> before) |
default Short2BooleanFunction |
composeShort(Short2IntFunction before) |
default boolean |
containsKey(int 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(int 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.
|
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.
|
default java.lang.Boolean |
getOrDefault(java.lang.Object key,
java.lang.Boolean defaultValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
put(int key,
boolean value)
Adds a pair to the map (optional operation).
|
default java.lang.Boolean |
put(java.lang.Integer key,
java.lang.Boolean value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
remove(int 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.
|
default boolean |
test(int operand) |
default boolean test(int operand)
test
in interface java.util.function.IntPredicate
default boolean put(int key, boolean value)
key
- the key.value
- the value.Function.put(Object,Object)
boolean get(int key)
key
- the key.Function.get(Object)
default boolean getOrDefault(int key, boolean defaultValue)
key
- the key.defaultValue
- the value to return if not present.defaultValue
if no value was present for the given key.Function.getOrDefault(Object, Object)
default boolean remove(int key)
key
- the key.Function.remove(Object)
@Deprecated default java.lang.Boolean put(java.lang.Integer key, java.lang.Boolean value)
key
- the key.value
- the value.null
if no value was present for the given key.Map.put(Object,Object)
@Deprecated default java.lang.Boolean get(java.lang.Object key)
key
- the key.null
if no value was present for the given key.Map.get(Object)
@Deprecated default java.lang.Boolean getOrDefault(java.lang.Object key, java.lang.Boolean defaultValue)
key
- the key.defaultValue
- the default value to return if not present.defaultValue
if no value was present for the
given key.Map.getOrDefault(Object, Object)
@Deprecated default java.lang.Boolean remove(java.lang.Object key)
key
- the key.null
if no value was present for the given key.Map.remove(Object)
default boolean containsKey(int 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.
key
- the key.key
.Function.containsKey(Object)
@Deprecated default boolean containsKey(java.lang.Object 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.
key
- the key.key
.Map.containsKey(Object)
default void defaultReturnValue(boolean rv)
get()
, put()
and remove()
to
denote that the map does not contain the specified key. It must be
0/false
/null
by default.rv
- the new default return value.defaultReturnValue()
default boolean defaultReturnValue()
This default implementation just return the default null value
of the type (null
for objects, 0 for scalars, false for Booleans).
@Deprecated default <T> java.util.function.Function<T,java.lang.Boolean> compose(java.util.function.Function<? super T,? extends java.lang.Integer> before)
compose
in interface java.util.function.Function<java.lang.Integer,java.lang.Boolean>
@Deprecated default <T> java.util.function.Function<java.lang.Integer,T> andThen(java.util.function.Function<? super java.lang.Boolean,? extends T> after)
andThen
in interface java.util.function.Function<java.lang.Integer,java.lang.Boolean>
default Int2ByteFunction andThenByte(Boolean2ByteFunction after)
default Byte2BooleanFunction composeByte(Byte2IntFunction before)
default Int2ShortFunction andThenShort(Boolean2ShortFunction after)
default Short2BooleanFunction composeShort(Short2IntFunction before)
default Int2IntFunction andThenInt(Boolean2IntFunction after)
default Int2BooleanFunction composeInt(Int2IntFunction before)
default Int2LongFunction andThenLong(Boolean2LongFunction after)
default Long2BooleanFunction composeLong(Long2IntFunction before)
default Int2CharFunction andThenChar(Boolean2CharFunction after)
default Char2BooleanFunction composeChar(Char2IntFunction before)
default Int2FloatFunction andThenFloat(Boolean2FloatFunction after)
default Float2BooleanFunction composeFloat(Float2IntFunction before)
default Int2DoubleFunction andThenDouble(Boolean2DoubleFunction after)
default Double2BooleanFunction composeDouble(Double2IntFunction before)
default <T> Int2ObjectFunction<T> andThenObject(Boolean2ObjectFunction<? extends T> after)
default <T> Object2BooleanFunction<T> composeObject(Object2IntFunction<? super T> before)
default <T> Int2ReferenceFunction<T> andThenReference(Boolean2ReferenceFunction<? extends T> after)
default <T> Reference2BooleanFunction<T> composeReference(Reference2IntFunction<? super T> before)