Interface Float2LongFunction
-
- All Known Subinterfaces:
Float2LongMap
,Float2LongSortedMap
- All Known Implementing Classes:
AbstractFloat2LongFunction
,AbstractFloat2LongMap
,AbstractFloat2LongSortedMap
,Float2LongArrayMap
,Float2LongAVLTreeMap
,Float2LongFunctions.EmptyFunction
,Float2LongFunctions.PrimitiveFunction
,Float2LongFunctions.Singleton
,Float2LongFunctions.SynchronizedFunction
,Float2LongFunctions.UnmodifiableFunction
,Float2LongLinkedOpenHashMap
,Float2LongMaps.EmptyMap
,Float2LongMaps.Singleton
,Float2LongMaps.SynchronizedMap
,Float2LongMaps.UnmodifiableMap
,Float2LongOpenCustomHashMap
,Float2LongOpenHashMap
,Float2LongRBTreeMap
,Float2LongSortedMaps.EmptySortedMap
,Float2LongSortedMaps.Singleton
,Float2LongSortedMaps.SynchronizedSortedMap
,Float2LongSortedMaps.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 Float2LongFunction extends Function<Float,Long>, DoubleToLongFunction
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 Float2ByteFunction
andThenByte(Long2ByteFunction after)
default Float2CharFunction
andThenChar(Long2CharFunction after)
default Float2DoubleFunction
andThenDouble(Long2DoubleFunction after)
default Float2FloatFunction
andThenFloat(Long2FloatFunction after)
default Float2IntFunction
andThenInt(Long2IntFunction after)
default Float2LongFunction
andThenLong(Long2LongFunction after)
default <T> Float2ObjectFunction<T>
andThenObject(Long2ObjectFunction<T> after)
default <T> Float2ReferenceFunction<T>
andThenReference(Long2ReferenceFunction<T> after)
default Float2ShortFunction
andThenShort(Long2ShortFunction after)
default long
applyAsLong(double operand)
Deprecated.Please use primitive types which don't have to be widened as keys.default Byte2LongFunction
composeByte(Byte2FloatFunction before)
default Char2LongFunction
composeChar(Char2FloatFunction before)
default Double2LongFunction
composeDouble(Double2FloatFunction before)
default Float2LongFunction
composeFloat(Float2FloatFunction before)
default Int2LongFunction
composeInt(Int2FloatFunction before)
default Long2LongFunction
composeLong(Long2FloatFunction before)
default <T> Object2LongFunction<T>
composeObject(Object2FloatFunction<T> before)
default <T> Reference2LongFunction<T>
composeReference(Reference2FloatFunction<T> before)
default Short2LongFunction
composeShort(Short2FloatFunction before)
default boolean
containsKey(float 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 long
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(long rv)
Sets the default return value (optional operation).long
get(float key)
Returns the value to which the given key is mapped.default Long
get(Object key)
Deprecated.Please use the corresponding type-specific method instead.default long
put(float key, long value)
Adds a pair to the map (optional operation).default Long
put(Float key, Long value)
Deprecated.Please use the corresponding type-specific method instead.default long
remove(float key)
Removes the mapping with the given key (optional operation).default Long
remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
applyAsLong
@Deprecated default long applyAsLong(double 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:
applyAsLong
in interfaceDoubleToLongFunction
- Throws:
IllegalArgumentException
- If the given operand is not an element of the key domain.- Since:
- 8.0.0
-
put
default long put(float 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(float 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 long remove(float 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 Long put(Float key, Long 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:
put
in interfaceFunction<Float,Long>
- Parameters:
key
- the key.value
- the value.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.put(Object,Object)
-
get
@Deprecated default Long 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:
get
in interfaceFunction<Float,Long>
- Parameters:
key
- the key.- Returns:
- the corresponding value, or
null
if no value was present for the given key. - See Also:
Map.get(Object)
-
remove
@Deprecated default Long 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:
remove
in interfaceFunction<Float,Long>
- Parameters:
key
- the key.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.remove(Object)
-
containsKey
default boolean containsKey(float 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:
containsKey
in interfaceFunction<Float,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
/null
by 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 (
null
for objects, 0 for scalars, false for Booleans).- Returns:
- the current default return value.
-
andThenByte
default Float2ByteFunction andThenByte(Long2ByteFunction after)
-
composeByte
default Byte2LongFunction composeByte(Byte2FloatFunction before)
-
andThenShort
default Float2ShortFunction andThenShort(Long2ShortFunction after)
-
composeShort
default Short2LongFunction composeShort(Short2FloatFunction before)
-
andThenInt
default Float2IntFunction andThenInt(Long2IntFunction after)
-
composeInt
default Int2LongFunction composeInt(Int2FloatFunction before)
-
andThenLong
default Float2LongFunction andThenLong(Long2LongFunction after)
-
composeLong
default Long2LongFunction composeLong(Long2FloatFunction before)
-
andThenChar
default Float2CharFunction andThenChar(Long2CharFunction after)
-
composeChar
default Char2LongFunction composeChar(Char2FloatFunction before)
-
andThenFloat
default Float2FloatFunction andThenFloat(Long2FloatFunction after)
-
composeFloat
default Float2LongFunction composeFloat(Float2FloatFunction before)
-
andThenDouble
default Float2DoubleFunction andThenDouble(Long2DoubleFunction after)
-
composeDouble
default Double2LongFunction composeDouble(Double2FloatFunction before)
-
andThenObject
default <T> Float2ObjectFunction<T> andThenObject(Long2ObjectFunction<T> after)
-
composeObject
default <T> Object2LongFunction<T> composeObject(Object2FloatFunction<T> before)
-
andThenReference
default <T> Float2ReferenceFunction<T> andThenReference(Long2ReferenceFunction<T> after)
-
composeReference
default <T> Reference2LongFunction<T> composeReference(Reference2FloatFunction<T> before)
-
-