@FunctionalInterface public interface Char2ShortFunction extends Function<java.lang.Character,java.lang.Short>, java.util.function.IntUnaryOperator
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 <T> java.util.function.Function<java.lang.Character,T> |
andThen(java.util.function.Function<? super java.lang.Short,? extends T> after)
Deprecated.
Please use the corresponding type-specific method instead.
|
default Char2ByteFunction |
andThenByte(Short2ByteFunction after) |
default Char2CharFunction |
andThenChar(Short2CharFunction after) |
default Char2DoubleFunction |
andThenDouble(Short2DoubleFunction after) |
default Char2FloatFunction |
andThenFloat(Short2FloatFunction after) |
default Char2IntFunction |
andThenInt(Short2IntFunction after) |
default Char2LongFunction |
andThenLong(Short2LongFunction after) |
default <T> Char2ObjectFunction<T> |
andThenObject(Short2ObjectFunction<? extends T> after) |
default <T> Char2ReferenceFunction<T> |
andThenReference(Short2ReferenceFunction<? extends T> after) |
default Char2ShortFunction |
andThenShort(Short2ShortFunction after) |
default int |
applyAsInt(int operand)
Deprecated.
Please use primitive types which do not have to be widened as keys.
|
default <T> java.util.function.Function<T,java.lang.Short> |
compose(java.util.function.Function<? super T,? extends java.lang.Character> before)
Deprecated.
Please use the corresponding type-specific method instead.
|
default Byte2ShortFunction |
composeByte(Byte2CharFunction before) |
default Char2ShortFunction |
composeChar(Char2CharFunction before) |
default Double2ShortFunction |
composeDouble(Double2CharFunction before) |
default Float2ShortFunction |
composeFloat(Float2CharFunction before) |
default Int2ShortFunction |
composeInt(Int2CharFunction before) |
default Long2ShortFunction |
composeLong(Long2CharFunction before) |
default <T> Object2ShortFunction<T> |
composeObject(Object2CharFunction<? super T> before) |
default <T> Reference2ShortFunction<T> |
composeReference(Reference2CharFunction<? super T> before) |
default Short2ShortFunction |
composeShort(Short2CharFunction before) |
default boolean |
containsKey(char 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 short |
defaultReturnValue()
Gets the default return value.
|
default void |
defaultReturnValue(short rv)
Sets the default return value (optional operation).
|
short |
get(char key)
Returns the value to which the given key is mapped.
|
default java.lang.Short |
get(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default short |
getOrDefault(char key,
short defaultValue)
Returns the value associated by this function to the specified key, or give the specified
value if not present.
|
default java.lang.Short |
getOrDefault(java.lang.Object key,
java.lang.Short defaultValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
default java.lang.Short |
put(java.lang.Character key,
java.lang.Short value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default short |
put(char key,
short value)
Adds a pair to the map (optional operation).
|
default short |
remove(char key)
Removes the mapping with the given key (optional operation).
|
default java.lang.Short |
remove(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
@Deprecated default int applyAsInt(int operand)
applyAsInt
in interface java.util.function.IntUnaryOperator
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 short put(char key, short value)
key
- the key.value
- the value.Function.put(Object,Object)
short get(char key)
key
- the key.Function.get(Object)
default short getOrDefault(char key, short 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 short remove(char key)
key
- the key.Function.remove(Object)
@Deprecated default java.lang.Short put(java.lang.Character key, java.lang.Short value)
key
- the key.value
- the value.null
if no value was present for the given key.Map.put(Object,Object)
@Deprecated default java.lang.Short get(java.lang.Object key)
key
- the key.null
if no value was present for the given key.Map.get(Object)
@Deprecated default java.lang.Short getOrDefault(java.lang.Object key, java.lang.Short 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 java.lang.Short remove(java.lang.Object key)
key
- the key.null
if no value was present for the given key.Map.remove(Object)
default boolean containsKey(char 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(short 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 short 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,java.lang.Short> compose(java.util.function.Function<? super T,? extends java.lang.Character> before)
compose
in interface java.util.function.Function<java.lang.Character,java.lang.Short>
@Deprecated default <T> java.util.function.Function<java.lang.Character,T> andThen(java.util.function.Function<? super java.lang.Short,? extends T> after)
andThen
in interface java.util.function.Function<java.lang.Character,java.lang.Short>
default Char2ByteFunction andThenByte(Short2ByteFunction after)
default Byte2ShortFunction composeByte(Byte2CharFunction before)
default Char2ShortFunction andThenShort(Short2ShortFunction after)
default Short2ShortFunction composeShort(Short2CharFunction before)
default Char2IntFunction andThenInt(Short2IntFunction after)
default Int2ShortFunction composeInt(Int2CharFunction before)
default Char2LongFunction andThenLong(Short2LongFunction after)
default Long2ShortFunction composeLong(Long2CharFunction before)
default Char2CharFunction andThenChar(Short2CharFunction after)
default Char2ShortFunction composeChar(Char2CharFunction before)
default Char2FloatFunction andThenFloat(Short2FloatFunction after)
default Float2ShortFunction composeFloat(Float2CharFunction before)
default Char2DoubleFunction andThenDouble(Short2DoubleFunction after)
default Double2ShortFunction composeDouble(Double2CharFunction before)
default <T> Char2ObjectFunction<T> andThenObject(Short2ObjectFunction<? extends T> after)
default <T> Object2ShortFunction<T> composeObject(Object2CharFunction<? super T> before)
default <T> Char2ReferenceFunction<T> andThenReference(Short2ReferenceFunction<? extends T> after)
default <T> Reference2ShortFunction<T> composeReference(Reference2CharFunction<? super T> before)