Interface Double2ReferenceFunction<V>
- All Superinterfaces:
DoubleFunction<V>
,Function<Double,
,V> Function<Double,
V>
- All Known Subinterfaces:
Double2ReferenceMap<V>
,Double2ReferenceSortedMap<V>
- All Known Implementing Classes:
AbstractDouble2ReferenceFunction
,AbstractDouble2ReferenceMap
,AbstractDouble2ReferenceSortedMap
,Double2ReferenceArrayMap
,Double2ReferenceAVLTreeMap
,Double2ReferenceFunctions.EmptyFunction
,Double2ReferenceFunctions.PrimitiveFunction
,Double2ReferenceFunctions.Singleton
,Double2ReferenceFunctions.SynchronizedFunction
,Double2ReferenceFunctions.UnmodifiableFunction
,Double2ReferenceLinkedOpenHashMap
,Double2ReferenceMaps.EmptyMap
,Double2ReferenceMaps.Singleton
,Double2ReferenceMaps.SynchronizedMap
,Double2ReferenceMaps.UnmodifiableMap
,Double2ReferenceOpenCustomHashMap
,Double2ReferenceOpenHashMap
,Double2ReferenceRBTreeMap
,Double2ReferenceSortedMaps.EmptySortedMap
,Double2ReferenceSortedMaps.Singleton
,Double2ReferenceSortedMaps.SynchronizedSortedMap
,Double2ReferenceSortedMaps.UnmodifiableSortedMap
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
Function
; provides some additional methods that use polymorphism to avoid
(un)boxing.
Type-specific versions of get()
, put()
and remove()
cannot rely on
null
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 the
defaultReturnValue()
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-specific
containsKey()
, 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()
and remove()
for maps with primitive-type keys or values return null
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
not null
.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault Double2ByteFunction
andThenByte
(Reference2ByteFunction<V> after) default Double2CharFunction
andThenChar
(Reference2CharFunction<V> after) default Double2DoubleFunction
andThenDouble
(Reference2DoubleFunction<V> after) default Double2FloatFunction
andThenFloat
(Reference2FloatFunction<V> after) default Double2IntFunction
andThenInt
(Reference2IntFunction<V> after) default Double2LongFunction
andThenLong
(Reference2LongFunction<V> after) default <T> Double2ObjectFunction
<T> andThenObject
(Reference2ObjectFunction<? super V, ? extends T> after) default <T> Double2ReferenceFunction
<T> andThenReference
(Reference2ReferenceFunction<? super V, ? extends T> after) default Double2ShortFunction
andThenShort
(Reference2ShortFunction<V> after) default V
apply
(double operand) Deprecated.Please use the corresponding type-specific method instead.default Byte2ReferenceFunction
<V> composeByte
(Byte2DoubleFunction before) default Char2ReferenceFunction
<V> composeChar
(Char2DoubleFunction before) default Double2ReferenceFunction
<V> composeDouble
(Double2DoubleFunction before) default Float2ReferenceFunction
<V> composeFloat
(Float2DoubleFunction before) default Int2ReferenceFunction
<V> composeInt
(Int2DoubleFunction before) default Long2ReferenceFunction
<V> composeLong
(Long2DoubleFunction before) default <T> Object2ReferenceFunction
<T, V> composeObject
(Object2DoubleFunction<? super T> before) default <T> Reference2ReferenceFunction
<T, V> composeReference
(Reference2DoubleFunction<? super T> before) default Short2ReferenceFunction
<V> composeShort
(Short2DoubleFunction before) default boolean
containsKey
(double key) Returns true if this function contains a mapping for the specified key.default boolean
containsKey
(Object key) Deprecated.Please use the corresponding type-specific method instead.default V
Gets the default return value.default void
defaultReturnValue
(V rv) Sets the default return value (optional operation).get
(double key) Returns the value to which the given key is mapped.default V
Deprecated.Please use the corresponding type-specific method instead.default V
getOrDefault
(double key, V defaultValue) Returns the value associated by this function to the specified key, or give the specified value if not present.default V
getOrDefault
(Object key, V defaultValue) Deprecated.Please use the corresponding type-specific method instead.default V
Adds a pair to the map (optional operation).default V
Deprecated.Please use the corresponding type-specific method instead.default V
remove
(double key) Removes the mapping with the given key (optional operation).default V
Deprecated.Please use the corresponding type-specific method instead.
-
Method Details
-
apply
- Specified by:
apply
in interfaceDoubleFunction<V>
- Since:
- 8.0.0
-
put
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:
-
get
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:
-
getOrDefault
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
defaultValue
if no value was present for the given key. - Since:
- 8.5.0
- See Also:
-
remove
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:
-
put
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation). -
get
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key. -
getOrDefault
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:
getOrDefault
in interfaceFunction<Double,
V> - Parameters:
key
- the key.defaultValue
- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValue
if no value was present for the given key. - See Also:
-
remove
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:
-
containsKey
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<Double,
V> - Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
-
defaultReturnValue
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
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.
-
compose
Deprecated.Please use the corresponding type-specific method instead. -
andThenByte
-
composeByte
-
andThenShort
-
composeShort
-
andThenInt
-
composeInt
-
andThenLong
-
composeLong
-
andThenChar
-
composeChar
-
andThenFloat
-
composeFloat
-
andThenDouble
-
composeDouble
-
andThenObject
default <T> Double2ObjectFunction<T> andThenObject(Reference2ObjectFunction<? super V, ? extends T> after) -
composeObject
-
andThenReference
default <T> Double2ReferenceFunction<T> andThenReference(Reference2ReferenceFunction<? super V, ? extends T> after) -
composeReference
default <T> Reference2ReferenceFunction<T,V> composeReference(Reference2DoubleFunction<? super T> before)
-