Interface Double2CharFunction
-
- All Superinterfaces:
java.util.function.DoubleToIntFunction,Function<java.lang.Double,java.lang.Character>,java.util.function.Function<java.lang.Double,java.lang.Character>
- All Known Subinterfaces:
Double2CharMap,Double2CharSortedMap
- All Known Implementing Classes:
AbstractDouble2CharFunction,AbstractDouble2CharMap,AbstractDouble2CharSortedMap,Double2CharArrayMap,Double2CharAVLTreeMap,Double2CharFunctions.EmptyFunction,Double2CharFunctions.PrimitiveFunction,Double2CharFunctions.Singleton,Double2CharFunctions.SynchronizedFunction,Double2CharFunctions.UnmodifiableFunction,Double2CharLinkedOpenHashMap,Double2CharMaps.EmptyMap,Double2CharMaps.Singleton,Double2CharMaps.SynchronizedMap,Double2CharMaps.UnmodifiableMap,Double2CharOpenCustomHashMap,Double2CharOpenHashMap,Double2CharRBTreeMap,Double2CharSortedMaps.EmptySortedMap,Double2CharSortedMaps.Singleton,Double2CharSortedMaps.SynchronizedSortedMap,Double2CharSortedMaps.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 Double2CharFunction extends Function<java.lang.Double,java.lang.Character>, 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 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 Double2ByteFunctionandThen(Char2ByteFunction after)default Double2CharFunctionandThen(Char2CharFunction after)default Double2DoubleFunctionandThen(Char2DoubleFunction after)default Double2FloatFunctionandThen(Char2FloatFunction after)default Double2IntFunctionandThen(Char2IntFunction after)default Double2LongFunctionandThen(Char2LongFunction after)default <T> Double2ObjectFunction<T>andThen(Char2ObjectFunction<T> after)default <T> Double2ReferenceFunction<T>andThen(Char2ReferenceFunction<T> after)default Double2ShortFunctionandThen(Char2ShortFunction after)default intapplyAsInt(double operand)default Byte2CharFunctioncompose(Byte2DoubleFunction before)default Char2CharFunctioncompose(Char2DoubleFunction before)default Double2CharFunctioncompose(Double2DoubleFunction before)default Float2CharFunctioncompose(Float2DoubleFunction before)default Int2CharFunctioncompose(Int2DoubleFunction before)default Long2CharFunctioncompose(Long2DoubleFunction before)default <T> Object2CharFunction<T>compose(Object2DoubleFunction<T> before)default <T> Reference2CharFunction<T>compose(Reference2DoubleFunction<T> before)default Short2CharFunctioncompose(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 chardefaultReturnValue()Gets the default return value.default voiddefaultReturnValue(char rv)Sets the default return value (optional operation).charget(double key)Returns the value to which the given key is mapped.default java.lang.Characterget(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default charput(double key, char value)Adds a pair to the map (optional operation).default java.lang.Characterput(java.lang.Double key, java.lang.Character value)Deprecated.Please use the corresponding type-specific method instead.default charremove(double key)Removes the mapping with the given key (optional operation).default java.lang.Characterremove(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
applyAsInt
default int applyAsInt(double operand)
- Specified by:
applyAsIntin interfacejava.util.function.DoubleToIntFunction- Since:
- 8.0.0
-
put
default char put(double key, char 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
char 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 char 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.Character put(java.lang.Double key, java.lang.Character 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.Character 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.Character 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.Character>- Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(char 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 char 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.
-
andThen
default Double2ByteFunction andThen(Char2ByteFunction after)
-
compose
default Byte2CharFunction compose(Byte2DoubleFunction before)
-
andThen
default Double2ShortFunction andThen(Char2ShortFunction after)
-
compose
default Short2CharFunction compose(Short2DoubleFunction before)
-
andThen
default Double2IntFunction andThen(Char2IntFunction after)
-
compose
default Int2CharFunction compose(Int2DoubleFunction before)
-
andThen
default Double2LongFunction andThen(Char2LongFunction after)
-
compose
default Long2CharFunction compose(Long2DoubleFunction before)
-
andThen
default Double2CharFunction andThen(Char2CharFunction after)
-
compose
default Char2CharFunction compose(Char2DoubleFunction before)
-
andThen
default Double2FloatFunction andThen(Char2FloatFunction after)
-
compose
default Float2CharFunction compose(Float2DoubleFunction before)
-
andThen
default Double2DoubleFunction andThen(Char2DoubleFunction after)
-
compose
default Double2CharFunction compose(Double2DoubleFunction before)
-
andThen
default <T> Double2ObjectFunction<T> andThen(Char2ObjectFunction<T> after)
-
compose
default <T> Object2CharFunction<T> compose(Object2DoubleFunction<T> before)
-
andThen
default <T> Double2ReferenceFunction<T> andThen(Char2ReferenceFunction<T> after)
-
compose
default <T> Reference2CharFunction<T> compose(Reference2DoubleFunction<T> before)
-
-