Interface Short2ByteFunction
-
- All Superinterfaces:
Function<java.lang.Short,java.lang.Byte>
,java.util.function.Function<java.lang.Short,java.lang.Byte>
,java.util.function.IntUnaryOperator
- All Known Subinterfaces:
Short2ByteMap
,Short2ByteSortedMap
- All Known Implementing Classes:
AbstractShort2ByteFunction
,AbstractShort2ByteMap
,AbstractShort2ByteSortedMap
,Short2ByteArrayMap
,Short2ByteAVLTreeMap
,Short2ByteFunctions.EmptyFunction
,Short2ByteFunctions.PrimitiveFunction
,Short2ByteFunctions.Singleton
,Short2ByteFunctions.SynchronizedFunction
,Short2ByteFunctions.UnmodifiableFunction
,Short2ByteLinkedOpenHashMap
,Short2ByteMaps.EmptyMap
,Short2ByteMaps.Singleton
,Short2ByteMaps.SynchronizedMap
,Short2ByteMaps.UnmodifiableMap
,Short2ByteOpenCustomHashMap
,Short2ByteOpenHashMap
,Short2ByteRBTreeMap
,Short2ByteSortedMaps.EmptySortedMap
,Short2ByteSortedMaps.Singleton
,Short2ByteSortedMaps.SynchronizedSortedMap
,Short2ByteSortedMaps.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 Short2ByteFunction extends Function<java.lang.Short,java.lang.Byte>, java.util.function.IntUnaryOperator
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 <T> java.util.function.Function<java.lang.Short,T>
andThen(java.util.function.Function<? super java.lang.Byte,? extends T> after)
Deprecated.Please use the corresponding type-specific method instead.default Short2ByteFunction
andThenByte(Byte2ByteFunction after)
default Short2CharFunction
andThenChar(Byte2CharFunction after)
default Short2DoubleFunction
andThenDouble(Byte2DoubleFunction after)
default Short2FloatFunction
andThenFloat(Byte2FloatFunction after)
default Short2IntFunction
andThenInt(Byte2IntFunction after)
default Short2LongFunction
andThenLong(Byte2LongFunction after)
default <T> Short2ObjectFunction<T>
andThenObject(Byte2ObjectFunction<? extends T> after)
default <T> Short2ReferenceFunction<T>
andThenReference(Byte2ReferenceFunction<? extends T> after)
default Short2ShortFunction
andThenShort(Byte2ShortFunction 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.Byte>
compose(java.util.function.Function<? super T,? extends java.lang.Short> before)
Deprecated.Please use the corresponding type-specific method instead.default Byte2ByteFunction
composeByte(Byte2ShortFunction before)
default Char2ByteFunction
composeChar(Char2ShortFunction before)
default Double2ByteFunction
composeDouble(Double2ShortFunction before)
default Float2ByteFunction
composeFloat(Float2ShortFunction before)
default Int2ByteFunction
composeInt(Int2ShortFunction before)
default Long2ByteFunction
composeLong(Long2ShortFunction before)
default <T> Object2ByteFunction<T>
composeObject(Object2ShortFunction<? super T> before)
default <T> Reference2ByteFunction<T>
composeReference(Reference2ShortFunction<? super T> before)
default Short2ByteFunction
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 byte
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(byte rv)
Sets the default return value (optional operation).byte
get(short key)
Returns the value to which the given key is mapped.default java.lang.Byte
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default byte
getOrDefault(short key, byte defaultValue)
Returns the value associated by this function to the specified key, or give the specified value if not present.default java.lang.Byte
getOrDefault(java.lang.Object key, java.lang.Byte defaultValue)
Deprecated.Please use the corresponding type-specific method instead.default byte
put(short key, byte value)
Adds a pair to the map (optional operation).default java.lang.Byte
put(java.lang.Short key, java.lang.Byte value)
Deprecated.Please use the corresponding type-specific method instead.default byte
remove(short key)
Removes the mapping with the given key (optional operation).default java.lang.Byte
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
-
-
Method Detail
-
applyAsInt
@Deprecated default int applyAsInt(int operand)
Deprecated.Please use primitive types which do not have to be widened as keys.- Specified by:
applyAsInt
in interfacejava.util.function.IntUnaryOperator
- Throws:
java.lang.IllegalArgumentException
- If the given operand is not an element of the key domain.- Since:
- 8.0.0
- Implementation Specification:
- This default implementation delegates to the type-specific
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 ofShort2IntFunction
).
-
put
default byte put(short key, byte 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
byte 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)
-
getOrDefault
default byte getOrDefault(short key, byte 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 byte 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 java.lang.Byte put(java.lang.Short key, java.lang.Byte 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 java.lang.Byte 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 java.lang.Byte getOrDefault(java.lang.Object key, java.lang.Byte 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.Short,java.lang.Byte>
- 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 java.lang.Byte 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,java.lang.Byte>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(byte 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 byte 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,java.lang.Byte> compose(java.util.function.Function<? super T,? extends java.lang.Short> before)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
compose
in interfacejava.util.function.Function<java.lang.Short,java.lang.Byte>
-
andThen
@Deprecated default <T> java.util.function.Function<java.lang.Short,T> andThen(java.util.function.Function<? super java.lang.Byte,? extends T> after)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
andThen
in interfacejava.util.function.Function<java.lang.Short,java.lang.Byte>
-
andThenByte
default Short2ByteFunction andThenByte(Byte2ByteFunction after)
-
composeByte
default Byte2ByteFunction composeByte(Byte2ShortFunction before)
-
andThenShort
default Short2ShortFunction andThenShort(Byte2ShortFunction after)
-
composeShort
default Short2ByteFunction composeShort(Short2ShortFunction before)
-
andThenInt
default Short2IntFunction andThenInt(Byte2IntFunction after)
-
composeInt
default Int2ByteFunction composeInt(Int2ShortFunction before)
-
andThenLong
default Short2LongFunction andThenLong(Byte2LongFunction after)
-
composeLong
default Long2ByteFunction composeLong(Long2ShortFunction before)
-
andThenChar
default Short2CharFunction andThenChar(Byte2CharFunction after)
-
composeChar
default Char2ByteFunction composeChar(Char2ShortFunction before)
-
andThenFloat
default Short2FloatFunction andThenFloat(Byte2FloatFunction after)
-
composeFloat
default Float2ByteFunction composeFloat(Float2ShortFunction before)
-
andThenDouble
default Short2DoubleFunction andThenDouble(Byte2DoubleFunction after)
-
composeDouble
default Double2ByteFunction composeDouble(Double2ShortFunction before)
-
andThenObject
default <T> Short2ObjectFunction<T> andThenObject(Byte2ObjectFunction<? extends T> after)
-
composeObject
default <T> Object2ByteFunction<T> composeObject(Object2ShortFunction<? super T> before)
-
andThenReference
default <T> Short2ReferenceFunction<T> andThenReference(Byte2ReferenceFunction<? extends T> after)
-
composeReference
default <T> Reference2ByteFunction<T> composeReference(Reference2ShortFunction<? super T> before)
-
-