@FunctionalInterface public interface Short2ReferenceFunction<V> extends Function<java.lang.Short,V>, java.util.function.IntFunction<V>
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
.
Function
Modifier and Type | Method and 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<? super V,? extends T> after) |
default <T> Short2ReferenceFunction<T> |
andThenReference(Reference2ReferenceFunction<? super V,? extends T> after) |
default Short2ShortFunction |
andThenShort(Reference2ShortFunction<V> after) |
default V |
apply(int operand)
Deprecated.
Please use primitive types which do not have to be widened as keys.
|
default <T> java.util.function.Function<T,V> |
compose(java.util.function.Function<? super T,? extends java.lang.Short> before)
Deprecated.
Please use the corresponding type-specific method instead.
|
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<? super T> before) |
default <T> Reference2ReferenceFunction<T,V> |
composeReference(Reference2ShortFunction<? super T> before) |
default Short2ReferenceFunction<V> |
composeShort(Short2ShortFunction before) |
default boolean |
containsKey(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
containsKey(short key)
Returns true if this function contains a mapping for the specified key.
|
default V |
defaultReturnValue()
Gets the default return value.
|
default void |
defaultReturnValue(V rv)
Sets the default return value (optional operation).
|
default V |
get(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
V |
get(short key)
Returns the value to which the given key is mapped.
|
default V |
getOrDefault(java.lang.Object key,
V defaultValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
getOrDefault(short key,
V defaultValue)
Returns the value associated by this function to the specified key, or give the specified
value if not present.
|
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(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
remove(short key)
Removes the mapping with the given key (optional operation).
|
@Deprecated default V apply(int operand)
apply
in interface java.util.function.IntFunction<V>
java.lang.IllegalArgumentException
- If the given operand is not an element of the key domain.get()
method after narrowing down the key to the
actual key type, throwing an exception if the given key cannot be
represented in the restricted domain. This is done for interoperability
with the Java 8 function environment. The use of this method is discouraged, as
unexpected errors can occur. Instead, the corresponding classes should be
used (e.g., Int2IntFunction
instead of
Short2IntFunction
).default V put(short key, V value)
key
- the key.value
- the value.Function.put(Object,Object)
V get(short key)
key
- the key.Function.get(Object)
default V getOrDefault(short key, V defaultValue)
key
- the key.defaultValue
- the value to return if not present.defaultValue
if no value was present for the given key.Function.getOrDefault(Object, Object)
default V remove(short key)
key
- the key.Function.remove(Object)
@Deprecated default V put(java.lang.Short key, V value)
key
- the key.value
- the value.null
if no value was present for the given key.Map.put(Object,Object)
@Deprecated default V get(java.lang.Object key)
key
- the key.null
if no value was present for the given key.Map.get(Object)
@Deprecated default V getOrDefault(java.lang.Object key, V defaultValue)
key
- the key.defaultValue
- the default value to return if not present.defaultValue
if no value was present for the
given key.Map.getOrDefault(Object, Object)
@Deprecated default V remove(java.lang.Object key)
key
- the key.null
if no value was present for the given key.Map.remove(Object)
default boolean containsKey(short 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.
key
- the key.key
.Function.containsKey(Object)
@Deprecated default boolean containsKey(java.lang.Object 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.
key
- the key.key
.Map.containsKey(Object)
default void defaultReturnValue(V rv)
get()
, put()
and remove()
to
denote that the map does not contain the specified key. It must be
0/false
/null
by default.rv
- the new default return value.defaultReturnValue()
default V defaultReturnValue()
This default implementation just return the default null value
of the type (null
for objects, 0 for scalars, false for Booleans).
@Deprecated default <T> java.util.function.Function<T,V> compose(java.util.function.Function<? super T,? extends java.lang.Short> before)
compose
in interface java.util.function.Function<java.lang.Short,V>
default Short2ByteFunction andThenByte(Reference2ByteFunction<V> after)
default Byte2ReferenceFunction<V> composeByte(Byte2ShortFunction before)
default Short2ShortFunction andThenShort(Reference2ShortFunction<V> after)
default Short2ReferenceFunction<V> composeShort(Short2ShortFunction before)
default Short2IntFunction andThenInt(Reference2IntFunction<V> after)
default Int2ReferenceFunction<V> composeInt(Int2ShortFunction before)
default Short2LongFunction andThenLong(Reference2LongFunction<V> after)
default Long2ReferenceFunction<V> composeLong(Long2ShortFunction before)
default Short2CharFunction andThenChar(Reference2CharFunction<V> after)
default Char2ReferenceFunction<V> composeChar(Char2ShortFunction before)
default Short2FloatFunction andThenFloat(Reference2FloatFunction<V> after)
default Float2ReferenceFunction<V> composeFloat(Float2ShortFunction before)
default Short2DoubleFunction andThenDouble(Reference2DoubleFunction<V> after)
default Double2ReferenceFunction<V> composeDouble(Double2ShortFunction before)
default <T> Short2ObjectFunction<T> andThenObject(Reference2ObjectFunction<? super V,? extends T> after)
default <T> Object2ReferenceFunction<T,V> composeObject(Object2ShortFunction<? super T> before)
default <T> Short2ReferenceFunction<T> andThenReference(Reference2ReferenceFunction<? super V,? extends T> after)
default <T> Reference2ReferenceFunction<T,V> composeReference(Reference2ShortFunction<? super T> before)