Interface Short2ReferenceFunction<V>
-
- All Superinterfaces:
Function<java.lang.Short,V>
,java.util.function.Function<java.lang.Short,V>
,java.util.function.IntFunction<V>
- All Known Subinterfaces:
Short2ReferenceMap<V>
,Short2ReferenceSortedMap<V>
- All Known Implementing Classes:
AbstractShort2ReferenceFunction
,AbstractShort2ReferenceMap
,AbstractShort2ReferenceSortedMap
,Short2ReferenceArrayMap
,Short2ReferenceAVLTreeMap
,Short2ReferenceFunctions.EmptyFunction
,Short2ReferenceFunctions.PrimitiveFunction
,Short2ReferenceFunctions.Singleton
,Short2ReferenceFunctions.SynchronizedFunction
,Short2ReferenceFunctions.UnmodifiableFunction
,Short2ReferenceLinkedOpenHashMap
,Short2ReferenceMaps.EmptyMap
,Short2ReferenceMaps.Singleton
,Short2ReferenceMaps.SynchronizedMap
,Short2ReferenceMaps.UnmodifiableMap
,Short2ReferenceOpenCustomHashMap
,Short2ReferenceOpenHashMap
,Short2ReferenceRBTreeMap
,Short2ReferenceSortedMaps.EmptySortedMap
,Short2ReferenceSortedMaps.Singleton
,Short2ReferenceSortedMaps.SynchronizedSortedMap
,Short2ReferenceSortedMaps.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 Short2ReferenceFunction<V> extends Function<java.lang.Short,V>, java.util.function.IntFunction<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 Short2ByteFunction
andThenByte(Reference2ByteFunction<V> after)
default Short2CharFunction
andThenChar(Reference2CharFunction<V> after)
default Short2DoubleFunction
andThenDouble(Reference2DoubleFunction<V> after)
default Short2FloatFunction
andThenFloat(Reference2FloatFunction<V> after)
default Short2IntFunction
andThenInt(Reference2IntFunction<V> after)
default Short2LongFunction
andThenLong(Reference2LongFunction<V> after)
default <T> Short2ObjectFunction<T>
andThenObject(Reference2ObjectFunction<V,T> after)
default <T> Short2ReferenceFunction<T>
andThenReference(Reference2ReferenceFunction<V,T> after)
default Short2ShortFunction
andThenShort(Reference2ShortFunction<V> after)
default V
apply(int operand)
Deprecated.Please use primitive types which don't have to be widened as keys.default Byte2ReferenceFunction<V>
composeByte(Byte2ShortFunction before)
default Char2ReferenceFunction<V>
composeChar(Char2ShortFunction before)
default Double2ReferenceFunction<V>
composeDouble(Double2ShortFunction before)
default Float2ReferenceFunction<V>
composeFloat(Float2ShortFunction before)
default Int2ReferenceFunction<V>
composeInt(Int2ShortFunction before)
default Long2ReferenceFunction<V>
composeLong(Long2ShortFunction before)
default <T> Object2ReferenceFunction<T,V>
composeObject(Object2ShortFunction<T> before)
default <T> Reference2ReferenceFunction<T,V>
composeReference(Reference2ShortFunction<T> before)
default Short2ReferenceFunction<V>
composeShort(Short2ShortFunction before)
default boolean
containsKey(short 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(short 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
put(short key, V value)
Adds a pair to the map (optional operation).default V
put(java.lang.Short key, V value)
Deprecated.Please use the corresponding type-specific method instead.default V
remove(short 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
@Deprecated default V apply(int 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:
apply
in interfacejava.util.function.IntFunction<V>
- Throws:
java.lang.IllegalArgumentException
- If the given operand is not an element of the key domain.- Since:
- 8.0.0
-
put
default V put(short 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(short 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 V remove(short 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.Short 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.
-
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(short 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.Short,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.
-
andThenByte
default Short2ByteFunction andThenByte(Reference2ByteFunction<V> after)
-
composeByte
default Byte2ReferenceFunction<V> composeByte(Byte2ShortFunction before)
-
andThenShort
default Short2ShortFunction andThenShort(Reference2ShortFunction<V> after)
-
composeShort
default Short2ReferenceFunction<V> composeShort(Short2ShortFunction before)
-
andThenInt
default Short2IntFunction andThenInt(Reference2IntFunction<V> after)
-
composeInt
default Int2ReferenceFunction<V> composeInt(Int2ShortFunction before)
-
andThenLong
default Short2LongFunction andThenLong(Reference2LongFunction<V> after)
-
composeLong
default Long2ReferenceFunction<V> composeLong(Long2ShortFunction before)
-
andThenChar
default Short2CharFunction andThenChar(Reference2CharFunction<V> after)
-
composeChar
default Char2ReferenceFunction<V> composeChar(Char2ShortFunction before)
-
andThenFloat
default Short2FloatFunction andThenFloat(Reference2FloatFunction<V> after)
-
composeFloat
default Float2ReferenceFunction<V> composeFloat(Float2ShortFunction before)
-
andThenDouble
default Short2DoubleFunction andThenDouble(Reference2DoubleFunction<V> after)
-
composeDouble
default Double2ReferenceFunction<V> composeDouble(Double2ShortFunction before)
-
andThenObject
default <T> Short2ObjectFunction<T> andThenObject(Reference2ObjectFunction<V,T> after)
-
composeObject
default <T> Object2ReferenceFunction<T,V> composeObject(Object2ShortFunction<T> before)
-
andThenReference
default <T> Short2ReferenceFunction<T> andThenReference(Reference2ReferenceFunction<V,T> after)
-
composeReference
default <T> Reference2ReferenceFunction<T,V> composeReference(Reference2ShortFunction<T> before)
-
-