Interface Reference2ReferenceFunction<K,V>
-
- All Superinterfaces:
Function<K,V>
,java.util.function.Function<K,V>
- All Known Subinterfaces:
Reference2ReferenceMap<K,V>
,Reference2ReferenceSortedMap<K,V>
- All Known Implementing Classes:
AbstractReference2ReferenceFunction
,AbstractReference2ReferenceMap
,AbstractReference2ReferenceSortedMap
,Reference2ReferenceArrayMap
,Reference2ReferenceFunctions.EmptyFunction
,Reference2ReferenceFunctions.Singleton
,Reference2ReferenceFunctions.SynchronizedFunction
,Reference2ReferenceFunctions.UnmodifiableFunction
,Reference2ReferenceLinkedOpenHashMap
,Reference2ReferenceMaps.EmptyMap
,Reference2ReferenceMaps.Singleton
,Reference2ReferenceMaps.SynchronizedMap
,Reference2ReferenceMaps.UnmodifiableMap
,Reference2ReferenceOpenCustomHashMap
,Reference2ReferenceOpenHashMap
,Reference2ReferenceSortedMaps.EmptySortedMap
,Reference2ReferenceSortedMaps.Singleton
,Reference2ReferenceSortedMaps.SynchronizedSortedMap
,Reference2ReferenceSortedMaps.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 Reference2ReferenceFunction<K,V> extends Function<K,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
-
Methods inherited from interface it.unimi.dsi.fastutil.Function
apply, clear, containsKey, size
-
-
-
-
Method Detail
-
put
default V put(K key, V value)
Adds a pair to the map (optional operation).- Specified by:
put
in interfaceFunction<K,V>
- 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(java.lang.Object key)
Returns the value to which the given key is mapped.- Specified by:
get
in interfaceFunction<K,V>
- 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 V remove(java.lang.Object key)
Removes the mapping with the given key (optional operation).- Specified by:
remove
in interfaceFunction<K,V>
- 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)
-
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.
-
andThenByte
default Reference2ByteFunction<K> andThenByte(Reference2ByteFunction<V> after)
-
composeByte
default Byte2ReferenceFunction<V> composeByte(Byte2ReferenceFunction<K> before)
-
andThenShort
default Reference2ShortFunction<K> andThenShort(Reference2ShortFunction<V> after)
-
composeShort
default Short2ReferenceFunction<V> composeShort(Short2ReferenceFunction<K> before)
-
andThenInt
default Reference2IntFunction<K> andThenInt(Reference2IntFunction<V> after)
-
composeInt
default Int2ReferenceFunction<V> composeInt(Int2ReferenceFunction<K> before)
-
andThenLong
default Reference2LongFunction<K> andThenLong(Reference2LongFunction<V> after)
-
composeLong
default Long2ReferenceFunction<V> composeLong(Long2ReferenceFunction<K> before)
-
andThenChar
default Reference2CharFunction<K> andThenChar(Reference2CharFunction<V> after)
-
composeChar
default Char2ReferenceFunction<V> composeChar(Char2ReferenceFunction<K> before)
-
andThenFloat
default Reference2FloatFunction<K> andThenFloat(Reference2FloatFunction<V> after)
-
composeFloat
default Float2ReferenceFunction<V> composeFloat(Float2ReferenceFunction<K> before)
-
andThenDouble
default Reference2DoubleFunction<K> andThenDouble(Reference2DoubleFunction<V> after)
-
composeDouble
default Double2ReferenceFunction<V> composeDouble(Double2ReferenceFunction<K> before)
-
andThenObject
default <T> Reference2ObjectFunction<K,T> andThenObject(Reference2ObjectFunction<V,T> after)
-
composeObject
default <T> Object2ReferenceFunction<T,V> composeObject(Object2ReferenceFunction<T,K> before)
-
andThenReference
default <T> Reference2ReferenceFunction<K,T> andThenReference(Reference2ReferenceFunction<V,T> after)
-
composeReference
default <T> Reference2ReferenceFunction<T,V> composeReference(Reference2ReferenceFunction<T,K> before)
-
-