Interface Long2ReferenceFunction<V>
-
- All Superinterfaces:
Function<java.lang.Long,V>
,java.util.function.Function<java.lang.Long,V>
,java.util.function.LongFunction<V>
- All Known Subinterfaces:
Long2ReferenceMap<V>
,Long2ReferenceSortedMap<V>
- All Known Implementing Classes:
AbstractLong2ReferenceFunction
,AbstractLong2ReferenceMap
,AbstractLong2ReferenceSortedMap
,Long2ReferenceArrayMap
,Long2ReferenceAVLTreeMap
,Long2ReferenceFunctions.EmptyFunction
,Long2ReferenceFunctions.PrimitiveFunction
,Long2ReferenceFunctions.Singleton
,Long2ReferenceFunctions.SynchronizedFunction
,Long2ReferenceFunctions.UnmodifiableFunction
,Long2ReferenceLinkedOpenHashMap
,Long2ReferenceMaps.EmptyMap
,Long2ReferenceMaps.Singleton
,Long2ReferenceMaps.SynchronizedMap
,Long2ReferenceMaps.UnmodifiableMap
,Long2ReferenceOpenCustomHashMap
,Long2ReferenceOpenHashMap
,Long2ReferenceRBTreeMap
,Long2ReferenceSortedMaps.EmptySortedMap
,Long2ReferenceSortedMaps.Singleton
,Long2ReferenceSortedMaps.SynchronizedSortedMap
,Long2ReferenceSortedMaps.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 Long2ReferenceFunction<V> extends Function<java.lang.Long,V>, java.util.function.LongFunction<V>
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 Long2ByteFunction
andThenByte(Reference2ByteFunction<V> after)
default Long2CharFunction
andThenChar(Reference2CharFunction<V> after)
default Long2DoubleFunction
andThenDouble(Reference2DoubleFunction<V> after)
default Long2FloatFunction
andThenFloat(Reference2FloatFunction<V> after)
default Long2IntFunction
andThenInt(Reference2IntFunction<V> after)
default Long2LongFunction
andThenLong(Reference2LongFunction<V> after)
default <T> Long2ObjectFunction<T>
andThenObject(Reference2ObjectFunction<? super V,? extends T> after)
default <T> Long2ReferenceFunction<T>
andThenReference(Reference2ReferenceFunction<? super V,? extends T> after)
default Long2ShortFunction
andThenShort(Reference2ShortFunction<V> after)
default V
apply(long operand)
default <T> java.util.function.Function<T,V>
compose(java.util.function.Function<? super T,? extends java.lang.Long> before)
Deprecated.Please use the corresponding type-specific method instead.default Byte2ReferenceFunction<V>
composeByte(Byte2LongFunction before)
default Char2ReferenceFunction<V>
composeChar(Char2LongFunction before)
default Double2ReferenceFunction<V>
composeDouble(Double2LongFunction before)
default Float2ReferenceFunction<V>
composeFloat(Float2LongFunction before)
default Int2ReferenceFunction<V>
composeInt(Int2LongFunction before)
default Long2ReferenceFunction<V>
composeLong(Long2LongFunction before)
default <T> Object2ReferenceFunction<T,V>
composeObject(Object2LongFunction<? super T> before)
default <T> Reference2ReferenceFunction<T,V>
composeReference(Reference2LongFunction<? super T> before)
default Short2ReferenceFunction<V>
composeShort(Short2LongFunction before)
default boolean
containsKey(long key)
Returns true if this function contains a mapping for the specified key.default boolean
containsKey(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default V
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(V rv)
Sets the default return value (optional operation).V
get(long key)
Returns the value to which the given key is mapped.default V
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default V
getOrDefault(long 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(java.lang.Object key, V defaultValue)
Deprecated.Please use the corresponding type-specific method instead.default V
put(long key, V value)
Adds a pair to the map (optional operation).default V
put(java.lang.Long key, V value)
Deprecated.Please use the corresponding type-specific method instead.default V
remove(long key)
Removes the mapping with the given key (optional operation).default V
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
apply
default V apply(long operand)
- Specified by:
apply
in interfacejava.util.function.LongFunction<V>
- Since:
- 8.0.0
-
put
default V put(long key, V 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
V get(long 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)
-
getOrDefault
default V getOrDefault(long key, V defaultValue)
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:
Function.getOrDefault(Object, Object)
-
remove
default V remove(long 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 V put(java.lang.Long key, V 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 V 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.
-
getOrDefault
@Deprecated default V getOrDefault(java.lang.Object key, V defaultValue)
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<java.lang.Long,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:
Map.getOrDefault(Object, Object)
-
remove
@Deprecated default V 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(long 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:
containsKey
in interfaceFunction<java.lang.Long,V>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(V 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 V 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 default <T> java.util.function.Function<T,V> compose(java.util.function.Function<? super T,? extends java.lang.Long> before)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
compose
in interfacejava.util.function.Function<java.lang.Long,V>
-
andThenByte
default Long2ByteFunction andThenByte(Reference2ByteFunction<V> after)
-
composeByte
default Byte2ReferenceFunction<V> composeByte(Byte2LongFunction before)
-
andThenShort
default Long2ShortFunction andThenShort(Reference2ShortFunction<V> after)
-
composeShort
default Short2ReferenceFunction<V> composeShort(Short2LongFunction before)
-
andThenInt
default Long2IntFunction andThenInt(Reference2IntFunction<V> after)
-
composeInt
default Int2ReferenceFunction<V> composeInt(Int2LongFunction before)
-
andThenLong
default Long2LongFunction andThenLong(Reference2LongFunction<V> after)
-
composeLong
default Long2ReferenceFunction<V> composeLong(Long2LongFunction before)
-
andThenChar
default Long2CharFunction andThenChar(Reference2CharFunction<V> after)
-
composeChar
default Char2ReferenceFunction<V> composeChar(Char2LongFunction before)
-
andThenFloat
default Long2FloatFunction andThenFloat(Reference2FloatFunction<V> after)
-
composeFloat
default Float2ReferenceFunction<V> composeFloat(Float2LongFunction before)
-
andThenDouble
default Long2DoubleFunction andThenDouble(Reference2DoubleFunction<V> after)
-
composeDouble
default Double2ReferenceFunction<V> composeDouble(Double2LongFunction before)
-
andThenObject
default <T> Long2ObjectFunction<T> andThenObject(Reference2ObjectFunction<? super V,? extends T> after)
-
composeObject
default <T> Object2ReferenceFunction<T,V> composeObject(Object2LongFunction<? super T> before)
-
andThenReference
default <T> Long2ReferenceFunction<T> andThenReference(Reference2ReferenceFunction<? super V,? extends T> after)
-
composeReference
default <T> Reference2ReferenceFunction<T,V> composeReference(Reference2LongFunction<? super T> before)
-
-