Interface Double2ShortFunction
-
- All Known Subinterfaces:
Double2ShortMap,Double2ShortSortedMap
- All Known Implementing Classes:
AbstractDouble2ShortFunction,AbstractDouble2ShortMap,AbstractDouble2ShortSortedMap,Double2ShortArrayMap,Double2ShortAVLTreeMap,Double2ShortFunctions.EmptyFunction,Double2ShortFunctions.PrimitiveFunction,Double2ShortFunctions.Singleton,Double2ShortFunctions.SynchronizedFunction,Double2ShortFunctions.UnmodifiableFunction,Double2ShortLinkedOpenHashMap,Double2ShortMaps.EmptyMap,Double2ShortMaps.Singleton,Double2ShortMaps.SynchronizedMap,Double2ShortMaps.UnmodifiableMap,Double2ShortOpenCustomHashMap,Double2ShortOpenHashMap,Double2ShortRBTreeMap,Double2ShortSortedMaps.EmptySortedMap,Double2ShortSortedMaps.Singleton,Double2ShortSortedMaps.SynchronizedSortedMap,Double2ShortSortedMaps.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 Double2ShortFunction extends Function<Double,Short>, DoubleToIntFunction
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 Double2ByteFunctionandThenByte(Short2ByteFunction after)default Double2CharFunctionandThenChar(Short2CharFunction after)default Double2DoubleFunctionandThenDouble(Short2DoubleFunction after)default Double2FloatFunctionandThenFloat(Short2FloatFunction after)default Double2IntFunctionandThenInt(Short2IntFunction after)default Double2LongFunctionandThenLong(Short2LongFunction after)default <T> Double2ObjectFunction<T>andThenObject(Short2ObjectFunction<T> after)default <T> Double2ReferenceFunction<T>andThenReference(Short2ReferenceFunction<T> after)default Double2ShortFunctionandThenShort(Short2ShortFunction after)default intapplyAsInt(double operand)default Byte2ShortFunctioncomposeByte(Byte2DoubleFunction before)default Char2ShortFunctioncomposeChar(Char2DoubleFunction before)default Double2ShortFunctioncomposeDouble(Double2DoubleFunction before)default Float2ShortFunctioncomposeFloat(Float2DoubleFunction before)default Int2ShortFunctioncomposeInt(Int2DoubleFunction before)default Long2ShortFunctioncomposeLong(Long2DoubleFunction before)default <T> Object2ShortFunction<T>composeObject(Object2DoubleFunction<T> before)default <T> Reference2ShortFunction<T>composeReference(Reference2DoubleFunction<T> before)default Short2ShortFunctioncomposeShort(Short2DoubleFunction before)default booleancontainsKey(double key)Returns true if this function contains a mapping for the specified key.default booleancontainsKey(Object key)Deprecated.Please use the corresponding type-specific method instead.default shortdefaultReturnValue()Gets the default return value.default voiddefaultReturnValue(short rv)Sets the default return value (optional operation).shortget(double key)Returns the value to which the given key is mapped.default Shortget(Object key)Deprecated.Please use the corresponding type-specific method instead.default shortput(double key, short value)Adds a pair to the map (optional operation).default Shortput(Double key, Short value)Deprecated.Please use the corresponding type-specific method instead.default shortremove(double key)Removes the mapping with the given key (optional operation).default Shortremove(Object key)Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
applyAsInt
default int applyAsInt(double operand)
- Specified by:
applyAsIntin interfaceDoubleToIntFunction- Since:
- 8.0.0
-
put
default short put(double key, short 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
short 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 short 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 Short put(Double key, Short value)
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).- Specified by:
putin interfaceFunction<Double,Short>- Parameters:
key- the key.value- the value.- Returns:
- the old value, or
nullif no value was present for the given key. - See Also:
Map.put(Object,Object)
-
get
@Deprecated default Short get(Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.- Specified by:
getin interfaceFunction<Double,Short>- Parameters:
key- the key.- Returns:
- the corresponding value, or
nullif no value was present for the given key. - See Also:
Map.get(Object)
-
remove
@Deprecated default Short remove(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).- Specified by:
removein interfaceFunction<Double,Short>- Parameters:
key- the key.- Returns:
- the old value, or
nullif no value was present for the given key. - See Also:
Map.remove(Object)
-
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(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<Double,Short>- Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(short 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 short 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.
-
andThenByte
default Double2ByteFunction andThenByte(Short2ByteFunction after)
-
composeByte
default Byte2ShortFunction composeByte(Byte2DoubleFunction before)
-
andThenShort
default Double2ShortFunction andThenShort(Short2ShortFunction after)
-
composeShort
default Short2ShortFunction composeShort(Short2DoubleFunction before)
-
andThenInt
default Double2IntFunction andThenInt(Short2IntFunction after)
-
composeInt
default Int2ShortFunction composeInt(Int2DoubleFunction before)
-
andThenLong
default Double2LongFunction andThenLong(Short2LongFunction after)
-
composeLong
default Long2ShortFunction composeLong(Long2DoubleFunction before)
-
andThenChar
default Double2CharFunction andThenChar(Short2CharFunction after)
-
composeChar
default Char2ShortFunction composeChar(Char2DoubleFunction before)
-
andThenFloat
default Double2FloatFunction andThenFloat(Short2FloatFunction after)
-
composeFloat
default Float2ShortFunction composeFloat(Float2DoubleFunction before)
-
andThenDouble
default Double2DoubleFunction andThenDouble(Short2DoubleFunction after)
-
composeDouble
default Double2ShortFunction composeDouble(Double2DoubleFunction before)
-
andThenObject
default <T> Double2ObjectFunction<T> andThenObject(Short2ObjectFunction<T> after)
-
composeObject
default <T> Object2ShortFunction<T> composeObject(Object2DoubleFunction<T> before)
-
andThenReference
default <T> Double2ReferenceFunction<T> andThenReference(Short2ReferenceFunction<T> after)
-
composeReference
default <T> Reference2ShortFunction<T> composeReference(Reference2DoubleFunction<T> before)
-
-