Interface Byte2DoubleFunction
-
- All Superinterfaces:
Function<java.lang.Byte,java.lang.Double>
,java.util.function.Function<java.lang.Byte,java.lang.Double>
,java.util.function.IntToDoubleFunction
- All Known Subinterfaces:
Byte2DoubleMap
,Byte2DoubleSortedMap
- All Known Implementing Classes:
AbstractByte2DoubleFunction
,AbstractByte2DoubleMap
,AbstractByte2DoubleSortedMap
,Byte2DoubleArrayMap
,Byte2DoubleAVLTreeMap
,Byte2DoubleFunctions.EmptyFunction
,Byte2DoubleFunctions.PrimitiveFunction
,Byte2DoubleFunctions.Singleton
,Byte2DoubleFunctions.SynchronizedFunction
,Byte2DoubleFunctions.UnmodifiableFunction
,Byte2DoubleLinkedOpenHashMap
,Byte2DoubleMaps.EmptyMap
,Byte2DoubleMaps.Singleton
,Byte2DoubleMaps.SynchronizedMap
,Byte2DoubleMaps.UnmodifiableMap
,Byte2DoubleOpenCustomHashMap
,Byte2DoubleOpenHashMap
,Byte2DoubleRBTreeMap
,Byte2DoubleSortedMaps.EmptySortedMap
,Byte2DoubleSortedMaps.Singleton
,Byte2DoubleSortedMaps.SynchronizedSortedMap
,Byte2DoubleSortedMaps.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 Byte2DoubleFunction extends Function<java.lang.Byte,java.lang.Double>, java.util.function.IntToDoubleFunction
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 Byte2ByteFunction
andThenByte(Double2ByteFunction after)
default Byte2CharFunction
andThenChar(Double2CharFunction after)
default Byte2DoubleFunction
andThenDouble(Double2DoubleFunction after)
default Byte2FloatFunction
andThenFloat(Double2FloatFunction after)
default Byte2IntFunction
andThenInt(Double2IntFunction after)
default Byte2LongFunction
andThenLong(Double2LongFunction after)
default <T> Byte2ObjectFunction<T>
andThenObject(Double2ObjectFunction<T> after)
default <T> Byte2ReferenceFunction<T>
andThenReference(Double2ReferenceFunction<T> after)
default Byte2ShortFunction
andThenShort(Double2ShortFunction after)
default double
applyAsDouble(int operand)
Deprecated.Please use primitive types which don't have to be widened as keys.default Byte2DoubleFunction
composeByte(Byte2ByteFunction before)
default Char2DoubleFunction
composeChar(Char2ByteFunction before)
default Double2DoubleFunction
composeDouble(Double2ByteFunction before)
default Float2DoubleFunction
composeFloat(Float2ByteFunction before)
default Int2DoubleFunction
composeInt(Int2ByteFunction before)
default Long2DoubleFunction
composeLong(Long2ByteFunction before)
default <T> Object2DoubleFunction<T>
composeObject(Object2ByteFunction<T> before)
default <T> Reference2DoubleFunction<T>
composeReference(Reference2ByteFunction<T> before)
default Short2DoubleFunction
composeShort(Short2ByteFunction before)
default boolean
containsKey(byte 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 double
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(double rv)
Sets the default return value (optional operation).double
get(byte key)
Returns the value to which the given key is mapped.default java.lang.Double
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default double
put(byte key, double value)
Adds a pair to the map (optional operation).default java.lang.Double
put(java.lang.Byte key, java.lang.Double value)
Deprecated.Please use the corresponding type-specific method instead.default double
remove(byte key)
Removes the mapping with the given key (optional operation).default java.lang.Double
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
applyAsDouble
@Deprecated default double applyAsDouble(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.,
Int2IntFunction
instead ofShort2IntFunction
).- Specified by:
applyAsDouble
in interfacejava.util.function.IntToDoubleFunction
- Throws:
java.lang.IllegalArgumentException
- If the given operand is not an element of the key domain.- Since:
- 8.0.0
-
put
default double put(byte key, double 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
double 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 double 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.Double put(java.lang.Byte key, java.lang.Double 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.Double 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.Double 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:
containsKey
in interfaceFunction<java.lang.Byte,java.lang.Double>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(double 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 double 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.
-
andThenByte
default Byte2ByteFunction andThenByte(Double2ByteFunction after)
-
composeByte
default Byte2DoubleFunction composeByte(Byte2ByteFunction before)
-
andThenShort
default Byte2ShortFunction andThenShort(Double2ShortFunction after)
-
composeShort
default Short2DoubleFunction composeShort(Short2ByteFunction before)
-
andThenInt
default Byte2IntFunction andThenInt(Double2IntFunction after)
-
composeInt
default Int2DoubleFunction composeInt(Int2ByteFunction before)
-
andThenLong
default Byte2LongFunction andThenLong(Double2LongFunction after)
-
composeLong
default Long2DoubleFunction composeLong(Long2ByteFunction before)
-
andThenChar
default Byte2CharFunction andThenChar(Double2CharFunction after)
-
composeChar
default Char2DoubleFunction composeChar(Char2ByteFunction before)
-
andThenFloat
default Byte2FloatFunction andThenFloat(Double2FloatFunction after)
-
composeFloat
default Float2DoubleFunction composeFloat(Float2ByteFunction before)
-
andThenDouble
default Byte2DoubleFunction andThenDouble(Double2DoubleFunction after)
-
composeDouble
default Double2DoubleFunction composeDouble(Double2ByteFunction before)
-
andThenObject
default <T> Byte2ObjectFunction<T> andThenObject(Double2ObjectFunction<T> after)
-
composeObject
default <T> Object2DoubleFunction<T> composeObject(Object2ByteFunction<T> before)
-
andThenReference
default <T> Byte2ReferenceFunction<T> andThenReference(Double2ReferenceFunction<T> after)
-
composeReference
default <T> Reference2DoubleFunction<T> composeReference(Reference2ByteFunction<T> before)
-
-