Interface Byte2BooleanFunction
-
- All Superinterfaces:
Function<java.lang.Byte,java.lang.Boolean>,java.util.function.Function<java.lang.Byte,java.lang.Boolean>,java.util.function.IntPredicate
- All Known Subinterfaces:
Byte2BooleanMap,Byte2BooleanSortedMap
- All Known Implementing Classes:
AbstractByte2BooleanFunction,AbstractByte2BooleanMap,AbstractByte2BooleanSortedMap,Byte2BooleanArrayMap,Byte2BooleanAVLTreeMap,Byte2BooleanFunctions.EmptyFunction,Byte2BooleanFunctions.PrimitiveFunction,Byte2BooleanFunctions.Singleton,Byte2BooleanFunctions.SynchronizedFunction,Byte2BooleanFunctions.UnmodifiableFunction,Byte2BooleanLinkedOpenHashMap,Byte2BooleanMaps.EmptyMap,Byte2BooleanMaps.Singleton,Byte2BooleanMaps.SynchronizedMap,Byte2BooleanMaps.UnmodifiableMap,Byte2BooleanOpenCustomHashMap,Byte2BooleanOpenHashMap,Byte2BooleanRBTreeMap,Byte2BooleanSortedMaps.EmptySortedMap,Byte2BooleanSortedMaps.Singleton,Byte2BooleanSortedMaps.SynchronizedSortedMap,Byte2BooleanSortedMaps.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 Byte2BooleanFunction extends Function<java.lang.Byte,java.lang.Boolean>, java.util.function.IntPredicate
A type-specificFunction; provides some additional methods that use polymorphism to avoid (un)boxing.Type-specific versions of
get(),put()andremove()cannot rely onnullto 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 returnnullto 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 Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default Byte2ByteFunctionandThen(Boolean2ByteFunction after)default Byte2CharFunctionandThen(Boolean2CharFunction after)default Byte2DoubleFunctionandThen(Boolean2DoubleFunction after)default Byte2FloatFunctionandThen(Boolean2FloatFunction after)default Byte2IntFunctionandThen(Boolean2IntFunction after)default Byte2LongFunctionandThen(Boolean2LongFunction after)default <T> Byte2ObjectFunction<T>andThen(Boolean2ObjectFunction<T> after)default <T> Byte2ReferenceFunction<T>andThen(Boolean2ReferenceFunction<T> after)default Byte2ShortFunctionandThen(Boolean2ShortFunction after)default Byte2BooleanFunctioncompose(Byte2ByteFunction before)default Char2BooleanFunctioncompose(Char2ByteFunction before)default Double2BooleanFunctioncompose(Double2ByteFunction before)default Float2BooleanFunctioncompose(Float2ByteFunction before)default Int2BooleanFunctioncompose(Int2ByteFunction before)default Long2BooleanFunctioncompose(Long2ByteFunction before)default <T> Object2BooleanFunction<T>compose(Object2ByteFunction<T> before)default <T> Reference2BooleanFunction<T>compose(Reference2ByteFunction<T> before)default Short2BooleanFunctioncompose(Short2ByteFunction before)default booleancontainsKey(byte key)Returns true if this function contains a mapping for the specified key.default booleancontainsKey(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default booleandefaultReturnValue()Gets the default return value.default voiddefaultReturnValue(boolean rv)Sets the default return value (optional operation).booleanget(byte key)Returns the value to which the given key is mapped.default java.lang.Booleanget(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default booleanput(byte key, boolean value)Adds a pair to the map (optional operation).default java.lang.Booleanput(java.lang.Byte key, java.lang.Boolean value)Deprecated.Please use the corresponding type-specific method instead.default booleanremove(byte key)Removes the mapping with the given key (optional operation).default java.lang.Booleanremove(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default booleantest(int operand)Deprecated.Please use primitive types which don't have to be widened as keys.
-
-
-
Method Detail
-
test
@Deprecated default boolean test(int operand)
Deprecated.Please use primitive types which don't have to be widened as keys.In this default implementation, the key gets narrowed down to the actual key type, throwing an exception if the given key can't be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. Its use is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g.,
Int2IntFunctioninstead ofShort2IntFunction).- Specified by:
testin interfacejava.util.function.IntPredicate- Throws:
java.lang.IllegalArgumentException- If the given operand is not an element of the key domain.- Since:
- 8.0.0
-
put
default boolean put(byte 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(byte 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(byte 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.Byte 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(byte 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:
containsKeyin interfaceFunction<java.lang.Byte,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/nullby 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 (
nullfor objects, 0 for scalars, false for Booleans).- Returns:
- the current default return value.
-
andThen
default Byte2ByteFunction andThen(Boolean2ByteFunction after)
-
compose
default Byte2BooleanFunction compose(Byte2ByteFunction before)
-
andThen
default Byte2ShortFunction andThen(Boolean2ShortFunction after)
-
compose
default Short2BooleanFunction compose(Short2ByteFunction before)
-
andThen
default Byte2IntFunction andThen(Boolean2IntFunction after)
-
compose
default Int2BooleanFunction compose(Int2ByteFunction before)
-
andThen
default Byte2LongFunction andThen(Boolean2LongFunction after)
-
compose
default Long2BooleanFunction compose(Long2ByteFunction before)
-
andThen
default Byte2CharFunction andThen(Boolean2CharFunction after)
-
compose
default Char2BooleanFunction compose(Char2ByteFunction before)
-
andThen
default Byte2FloatFunction andThen(Boolean2FloatFunction after)
-
compose
default Float2BooleanFunction compose(Float2ByteFunction before)
-
andThen
default Byte2DoubleFunction andThen(Boolean2DoubleFunction after)
-
compose
default Double2BooleanFunction compose(Double2ByteFunction before)
-
andThen
default <T> Byte2ObjectFunction<T> andThen(Boolean2ObjectFunction<T> after)
-
compose
default <T> Object2BooleanFunction<T> compose(Object2ByteFunction<T> before)
-
andThen
default <T> Byte2ReferenceFunction<T> andThen(Boolean2ReferenceFunction<T> after)
-
compose
default <T> Reference2BooleanFunction<T> compose(Reference2ByteFunction<T> before)
-
-