Interface Double2ByteFunction
-
- All Superinterfaces:
java.util.function.DoubleToIntFunction
,Function<java.lang.Double,java.lang.Byte>
,java.util.function.Function<java.lang.Double,java.lang.Byte>
- All Known Subinterfaces:
Double2ByteMap
,Double2ByteSortedMap
- All Known Implementing Classes:
AbstractDouble2ByteFunction
,AbstractDouble2ByteMap
,AbstractDouble2ByteSortedMap
,Double2ByteArrayMap
,Double2ByteAVLTreeMap
,Double2ByteFunctions.EmptyFunction
,Double2ByteFunctions.PrimitiveFunction
,Double2ByteFunctions.Singleton
,Double2ByteFunctions.SynchronizedFunction
,Double2ByteFunctions.UnmodifiableFunction
,Double2ByteLinkedOpenHashMap
,Double2ByteMaps.EmptyMap
,Double2ByteMaps.Singleton
,Double2ByteMaps.SynchronizedMap
,Double2ByteMaps.UnmodifiableMap
,Double2ByteOpenCustomHashMap
,Double2ByteOpenHashMap
,Double2ByteRBTreeMap
,Double2ByteSortedMaps.EmptySortedMap
,Double2ByteSortedMaps.Singleton
,Double2ByteSortedMaps.SynchronizedSortedMap
,Double2ByteSortedMaps.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 Double2ByteFunction extends Function<java.lang.Double,java.lang.Byte>, java.util.function.DoubleToIntFunction
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 Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default Double2ByteFunction
andThen(Byte2ByteFunction after)
default Double2CharFunction
andThen(Byte2CharFunction after)
default Double2DoubleFunction
andThen(Byte2DoubleFunction after)
default Double2FloatFunction
andThen(Byte2FloatFunction after)
default Double2IntFunction
andThen(Byte2IntFunction after)
default Double2LongFunction
andThen(Byte2LongFunction after)
default <T> Double2ObjectFunction<T>
andThen(Byte2ObjectFunction<T> after)
default <T> Double2ReferenceFunction<T>
andThen(Byte2ReferenceFunction<T> after)
default Double2ShortFunction
andThen(Byte2ShortFunction after)
default int
applyAsInt(double operand)
default Byte2ByteFunction
compose(Byte2DoubleFunction before)
default Char2ByteFunction
compose(Char2DoubleFunction before)
default Double2ByteFunction
compose(Double2DoubleFunction before)
default Float2ByteFunction
compose(Float2DoubleFunction before)
default Int2ByteFunction
compose(Int2DoubleFunction before)
default Long2ByteFunction
compose(Long2DoubleFunction before)
default <T> Object2ByteFunction<T>
compose(Object2DoubleFunction<T> before)
default <T> Reference2ByteFunction<T>
compose(Reference2DoubleFunction<T> before)
default Short2ByteFunction
compose(Short2DoubleFunction before)
default boolean
containsKey(double 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 byte
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(byte rv)
Sets the default return value (optional operation).byte
get(double key)
Returns the value to which the given key is mapped.default java.lang.Byte
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default byte
put(double key, byte value)
Adds a pair to the map (optional operation).default java.lang.Byte
put(java.lang.Double key, java.lang.Byte value)
Deprecated.Please use the corresponding type-specific method instead.default byte
remove(double key)
Removes the mapping with the given key (optional operation).default java.lang.Byte
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
applyAsInt
default int applyAsInt(double operand)
- Specified by:
applyAsInt
in interfacejava.util.function.DoubleToIntFunction
- Since:
- 8.0.0
-
put
default byte put(double key, byte 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
byte get(double 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 byte remove(double 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.Byte put(java.lang.Double key, java.lang.Byte 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.Byte 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.Byte 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(double 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.Double,java.lang.Byte>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(byte 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 byte 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.
-
andThen
default Double2ByteFunction andThen(Byte2ByteFunction after)
-
compose
default Byte2ByteFunction compose(Byte2DoubleFunction before)
-
andThen
default Double2ShortFunction andThen(Byte2ShortFunction after)
-
compose
default Short2ByteFunction compose(Short2DoubleFunction before)
-
andThen
default Double2IntFunction andThen(Byte2IntFunction after)
-
compose
default Int2ByteFunction compose(Int2DoubleFunction before)
-
andThen
default Double2LongFunction andThen(Byte2LongFunction after)
-
compose
default Long2ByteFunction compose(Long2DoubleFunction before)
-
andThen
default Double2CharFunction andThen(Byte2CharFunction after)
-
compose
default Char2ByteFunction compose(Char2DoubleFunction before)
-
andThen
default Double2FloatFunction andThen(Byte2FloatFunction after)
-
compose
default Float2ByteFunction compose(Float2DoubleFunction before)
-
andThen
default Double2DoubleFunction andThen(Byte2DoubleFunction after)
-
compose
default Double2ByteFunction compose(Double2DoubleFunction before)
-
andThen
default <T> Double2ObjectFunction<T> andThen(Byte2ObjectFunction<T> after)
-
compose
default <T> Object2ByteFunction<T> compose(Object2DoubleFunction<T> before)
-
andThen
default <T> Double2ReferenceFunction<T> andThen(Byte2ReferenceFunction<T> after)
-
compose
default <T> Reference2ByteFunction<T> compose(Reference2DoubleFunction<T> before)
-
-