Interface Short2BooleanFunction
- All Known Subinterfaces:
Short2BooleanMap
,Short2BooleanSortedMap
- All Known Implementing Classes:
AbstractShort2BooleanFunction
,AbstractShort2BooleanMap
,AbstractShort2BooleanSortedMap
,Short2BooleanArrayMap
,Short2BooleanAVLTreeMap
,Short2BooleanFunctions.EmptyFunction
,Short2BooleanFunctions.PrimitiveFunction
,Short2BooleanFunctions.Singleton
,Short2BooleanFunctions.SynchronizedFunction
,Short2BooleanFunctions.UnmodifiableFunction
,Short2BooleanLinkedOpenHashMap
,Short2BooleanMaps.EmptyMap
,Short2BooleanMaps.Singleton
,Short2BooleanMaps.SynchronizedMap
,Short2BooleanMaps.UnmodifiableMap
,Short2BooleanOpenCustomHashMap
,Short2BooleanOpenHashMap
,Short2BooleanRBTreeMap
,Short2BooleanSortedMaps.EmptySortedMap
,Short2BooleanSortedMaps.Singleton
,Short2BooleanSortedMaps.SynchronizedSortedMap
,Short2BooleanSortedMaps.UnmodifiableSortedMap
- 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 Short2ByteFunction
andThenByte
(Boolean2ByteFunction after) default Short2CharFunction
andThenChar
(Boolean2CharFunction after) default Short2DoubleFunction
default Short2FloatFunction
default Short2IntFunction
andThenInt
(Boolean2IntFunction after) default Short2LongFunction
andThenLong
(Boolean2LongFunction after) default <T> Short2ObjectFunction
<T> andThenObject
(Boolean2ObjectFunction<? extends T> after) default <T> Short2ReferenceFunction
<T> andThenReference
(Boolean2ReferenceFunction<? extends T> after) default Short2ShortFunction
Deprecated.Please use the corresponding type-specific method instead.default Byte2BooleanFunction
composeByte
(Byte2ShortFunction before) default Char2BooleanFunction
composeChar
(Char2ShortFunction before) default Double2BooleanFunction
composeDouble
(Double2ShortFunction before) default Float2BooleanFunction
composeFloat
(Float2ShortFunction before) default Int2BooleanFunction
composeInt
(Int2ShortFunction before) default Long2BooleanFunction
composeLong
(Long2ShortFunction before) default <T> Object2BooleanFunction
<T> composeObject
(Object2ShortFunction<? super T> before) default <T> Reference2BooleanFunction
<T> composeReference
(Reference2ShortFunction<? super T> before) default Short2BooleanFunction
composeShort
(Short2ShortFunction before) default boolean
containsKey
(short key) Returns true if this function contains a mapping for the specified key.default boolean
containsKey
(Object key) Deprecated.Please use the corresponding type-specific method instead.default boolean
Gets the default return value.default void
defaultReturnValue
(boolean rv) Sets the default return value (optional operation).boolean
get
(short key) Returns the value to which the given key is mapped.default Boolean
Deprecated.Please use the corresponding type-specific method instead.default boolean
getOrDefault
(short key, boolean defaultValue) Returns the value associated by this function to the specified key, or give the specified value if not present.default Boolean
getOrDefault
(Object key, Boolean defaultValue) Deprecated.Please use the corresponding type-specific method instead.default boolean
put
(short key, boolean value) Adds a pair to the map (optional operation).default Boolean
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove
(short key) Removes the mapping with the given key (optional operation).default Boolean
Deprecated.Please use the corresponding type-specific method instead.default boolean
test
(int operand) Deprecated.Please use primitive types which do not have to be widened as keys.Methods inherited from interface java.util.function.IntPredicate
and, negate, or
-
Method Details
-
test
Deprecated.Please use primitive types which do not have to be widened as keys.- Specified by:
test
in interfaceIntPredicate
- Throws:
IllegalArgumentException
- If the given operand is not an element of the key domain.- Since:
- 8.0.0
- Implementation Specification:
- This default implementation delegates to the type-specific
get()
method after narrowing down the key to the actual key type, throwing an exception if the given key cannot be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. The use of this method is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g.,Int2IntFunction
instead ofShort2IntFunction
).
-
put
default boolean put(short 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(short 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(short 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
defaultValue
if no value was present for the given key. - Since:
- 8.5.0
- See Also:
-
remove
default boolean remove(short 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:
getOrDefault
in interfaceFunction<Short,
Boolean> - Parameters:
key
- the key.defaultValue
- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValue
if 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(short 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:
containsKey
in interfaceFunction<Short,
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
/null
by 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 (
null
for 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
default <T> Short2ReferenceFunction<T> andThenReference(Boolean2ReferenceFunction<? extends T> after) -
composeReference
default <T> Reference2BooleanFunction<T> composeReference(Reference2ShortFunction<? super T> before)
-