Interface Reference2LongFunction<K>
- All Superinterfaces:
Function<K,,Long> Function<K,,Long> ToLongFunction<K>
- 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 TypeMethodDescriptionDeprecated.Please use the corresponding type-specific method instead.default Reference2ByteFunction<K>andThenByte(Long2ByteFunction after) default Reference2CharFunction<K>andThenChar(Long2CharFunction after) default Reference2DoubleFunction<K>andThenDouble(Long2DoubleFunction after) default Reference2FloatFunction<K>andThenFloat(Long2FloatFunction after) default Reference2IntFunction<K>andThenInt(Long2IntFunction after) default Reference2LongFunction<K>andThenLong(Long2LongFunction after) default <T> Reference2ObjectFunction<K,T> andThenObject(Long2ObjectFunction<? extends T> after) default <T> Reference2ReferenceFunction<K,T> andThenReference(Long2ReferenceFunction<? extends T> after) default Reference2ShortFunction<K>andThenShort(Long2ShortFunction after) default longapplyAsLong(K operand) default Byte2LongFunctioncomposeByte(Byte2ReferenceFunction<K> before) default Char2LongFunctioncomposeChar(Char2ReferenceFunction<K> before) default Double2LongFunctioncomposeDouble(Double2ReferenceFunction<K> before) default Float2LongFunctioncomposeFloat(Float2ReferenceFunction<K> before) default Int2LongFunctioncomposeInt(Int2ReferenceFunction<K> before) default Long2LongFunctioncomposeLong(Long2ReferenceFunction<K> before) default <T> Object2LongFunction<T>composeObject(Object2ReferenceFunction<? super T, ? extends K> before) default <T> Reference2LongFunction<T>composeReference(Reference2ReferenceFunction<? super T, ? extends K> before) default Short2LongFunctioncomposeShort(Short2ReferenceFunction<K> before) default longGets the default return value.default voiddefaultReturnValue(long rv) Sets the default return value (optional operation).default LongDeprecated.Please use the corresponding type-specific method instead.longReturns the value to which the given key is mapped.default longgetOrDefault(Object key, long defaultValue) Returns the value associated by this function to the specified key, or give the specified value if not present.default LonggetOrDefault(Object key, Long defaultValue) Deprecated.Please use the corresponding type-specific method instead.default longAdds a pair to the map (optional operation).default LongDeprecated.Please use the corresponding type-specific method instead.default LongDeprecated.Please use the corresponding type-specific method instead.default longremoveLong(Object key) Removes the mapping with the given key (optional operation).Methods inherited from interface it.unimi.dsi.fastutil.Function
apply, clear, containsKey, size
-
Method Details
-
applyAsLong
- Specified by:
applyAsLongin interfaceToLongFunction<K>- 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:
-
getLong
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
defaultValueif no value was present for the given key. - Since:
- 8.5.0
- See Also:
-
removeLong
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:
getOrDefaultin interfaceFunction<K,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:
-
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). -
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
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.
-
andThen
Deprecated.Please use the corresponding type-specific method instead. -
andThenByte
-
composeByte
-
andThenShort
-
composeShort
-
andThenInt
-
composeInt
-
andThenLong
-
composeLong
-
andThenChar
-
composeChar
-
andThenFloat
-
composeFloat
-
andThenDouble
-
composeDouble
-
andThenObject
-
composeObject
default <T> Object2LongFunction<T> composeObject(Object2ReferenceFunction<? super T, ? extends K> before) -
andThenReference
default <T> Reference2ReferenceFunction<K,T> andThenReference(Long2ReferenceFunction<? extends T> after) -
composeReference
default <T> Reference2LongFunction<T> composeReference(Reference2ReferenceFunction<? super T, ? extends K> before)
-