Interface Double2LongFunction
-
- All Superinterfaces:
java.util.function.DoubleToLongFunction,Function<java.lang.Double,java.lang.Long>,java.util.function.Function<java.lang.Double,java.lang.Long>
- All Known Subinterfaces:
Double2LongMap,Double2LongSortedMap
- All Known Implementing Classes:
AbstractDouble2LongFunction,AbstractDouble2LongMap,AbstractDouble2LongSortedMap,Double2LongArrayMap,Double2LongAVLTreeMap,Double2LongFunctions.EmptyFunction,Double2LongFunctions.PrimitiveFunction,Double2LongFunctions.Singleton,Double2LongFunctions.SynchronizedFunction,Double2LongFunctions.UnmodifiableFunction,Double2LongLinkedOpenHashMap,Double2LongMaps.EmptyMap,Double2LongMaps.Singleton,Double2LongMaps.SynchronizedMap,Double2LongMaps.UnmodifiableMap,Double2LongOpenCustomHashMap,Double2LongOpenHashMap,Double2LongRBTreeMap,Double2LongSortedMaps.EmptySortedMap,Double2LongSortedMaps.Singleton,Double2LongSortedMaps.SynchronizedSortedMap,Double2LongSortedMaps.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 Double2LongFunction extends Function<java.lang.Double,java.lang.Long>, java.util.function.DoubleToLongFunction
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 <T> java.util.function.Function<java.lang.Double,T>andThen(java.util.function.Function<? super java.lang.Long,? extends T> after)Deprecated.Please use the corresponding type-specific method instead.default Double2ByteFunctionandThenByte(Long2ByteFunction after)default Double2CharFunctionandThenChar(Long2CharFunction after)default Double2DoubleFunctionandThenDouble(Long2DoubleFunction after)default Double2FloatFunctionandThenFloat(Long2FloatFunction after)default Double2IntFunctionandThenInt(Long2IntFunction after)default Double2LongFunctionandThenLong(Long2LongFunction after)default <T> Double2ObjectFunction<T>andThenObject(Long2ObjectFunction<? extends T> after)default <T> Double2ReferenceFunction<T>andThenReference(Long2ReferenceFunction<? extends T> after)default Double2ShortFunctionandThenShort(Long2ShortFunction after)default longapplyAsLong(double operand)default <T> java.util.function.Function<T,java.lang.Long>compose(java.util.function.Function<? super T,? extends java.lang.Double> before)Deprecated.Please use the corresponding type-specific method instead.default Byte2LongFunctioncomposeByte(Byte2DoubleFunction before)default Char2LongFunctioncomposeChar(Char2DoubleFunction before)default Double2LongFunctioncomposeDouble(Double2DoubleFunction before)default Float2LongFunctioncomposeFloat(Float2DoubleFunction before)default Int2LongFunctioncomposeInt(Int2DoubleFunction before)default Long2LongFunctioncomposeLong(Long2DoubleFunction before)default <T> Object2LongFunction<T>composeObject(Object2DoubleFunction<? super T> before)default <T> Reference2LongFunction<T>composeReference(Reference2DoubleFunction<? super T> before)default Short2LongFunctioncomposeShort(Short2DoubleFunction before)default booleancontainsKey(double 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 longdefaultReturnValue()Gets the default return value.default voiddefaultReturnValue(long rv)Sets the default return value (optional operation).longget(double key)Returns the value to which the given key is mapped.default java.lang.Longget(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default longgetOrDefault(double key, long defaultValue)Returns the value associated by this function to the specified key, or give the specified value if not present.default java.lang.LonggetOrDefault(java.lang.Object key, java.lang.Long defaultValue)Deprecated.Please use the corresponding type-specific method instead.default longput(double key, long value)Adds a pair to the map (optional operation).default java.lang.Longput(java.lang.Double key, java.lang.Long value)Deprecated.Please use the corresponding type-specific method instead.default longremove(double key)Removes the mapping with the given key (optional operation).default java.lang.Longremove(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
applyAsLong
default long applyAsLong(double operand)
- Specified by:
applyAsLongin interfacejava.util.function.DoubleToLongFunction- Since:
- 8.0.0
-
put
default long put(double key, long 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
long 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)
-
getOrDefault
default long getOrDefault(double key, long 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
defaultValueif no value was present for the given key. - Since:
- 8.5.0
- See Also:
Function.getOrDefault(Object, Object)
-
remove
default long 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.Long put(java.lang.Double key, java.lang.Long 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.Long 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.
-
getOrDefault
@Deprecated default java.lang.Long getOrDefault(java.lang.Object key, java.lang.Long defaultValue)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:
getOrDefaultin interfaceFunction<java.lang.Double,java.lang.Long>- Parameters:
key- the key.defaultValue- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValueif no value was present for the given key. - See Also:
Map.getOrDefault(Object, Object)
-
remove
@Deprecated default java.lang.Long 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:
containsKeyin interfaceFunction<java.lang.Double,java.lang.Long>- Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(long 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 long 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.
-
compose
@Deprecated default <T> java.util.function.Function<T,java.lang.Long> compose(java.util.function.Function<? super T,? extends java.lang.Double> before)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
composein interfacejava.util.function.Function<java.lang.Double,java.lang.Long>
-
andThen
@Deprecated default <T> java.util.function.Function<java.lang.Double,T> andThen(java.util.function.Function<? super java.lang.Long,? extends T> after)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
andThenin interfacejava.util.function.Function<java.lang.Double,java.lang.Long>
-
andThenByte
default Double2ByteFunction andThenByte(Long2ByteFunction after)
-
composeByte
default Byte2LongFunction composeByte(Byte2DoubleFunction before)
-
andThenShort
default Double2ShortFunction andThenShort(Long2ShortFunction after)
-
composeShort
default Short2LongFunction composeShort(Short2DoubleFunction before)
-
andThenInt
default Double2IntFunction andThenInt(Long2IntFunction after)
-
composeInt
default Int2LongFunction composeInt(Int2DoubleFunction before)
-
andThenLong
default Double2LongFunction andThenLong(Long2LongFunction after)
-
composeLong
default Long2LongFunction composeLong(Long2DoubleFunction before)
-
andThenChar
default Double2CharFunction andThenChar(Long2CharFunction after)
-
composeChar
default Char2LongFunction composeChar(Char2DoubleFunction before)
-
andThenFloat
default Double2FloatFunction andThenFloat(Long2FloatFunction after)
-
composeFloat
default Float2LongFunction composeFloat(Float2DoubleFunction before)
-
andThenDouble
default Double2DoubleFunction andThenDouble(Long2DoubleFunction after)
-
composeDouble
default Double2LongFunction composeDouble(Double2DoubleFunction before)
-
andThenObject
default <T> Double2ObjectFunction<T> andThenObject(Long2ObjectFunction<? extends T> after)
-
composeObject
default <T> Object2LongFunction<T> composeObject(Object2DoubleFunction<? super T> before)
-
andThenReference
default <T> Double2ReferenceFunction<T> andThenReference(Long2ReferenceFunction<? extends T> after)
-
composeReference
default <T> Reference2LongFunction<T> composeReference(Reference2DoubleFunction<? super T> before)
-
-