Interface Byte2ShortFunction
-
- All Superinterfaces:
Function<java.lang.Byte,java.lang.Short>
,java.util.function.Function<java.lang.Byte,java.lang.Short>
,java.util.function.IntUnaryOperator
- All Known Subinterfaces:
Byte2ShortMap
,Byte2ShortSortedMap
- All Known Implementing Classes:
AbstractByte2ShortFunction
,AbstractByte2ShortMap
,AbstractByte2ShortSortedMap
,Byte2ShortArrayMap
,Byte2ShortAVLTreeMap
,Byte2ShortFunctions.EmptyFunction
,Byte2ShortFunctions.PrimitiveFunction
,Byte2ShortFunctions.Singleton
,Byte2ShortFunctions.SynchronizedFunction
,Byte2ShortFunctions.UnmodifiableFunction
,Byte2ShortLinkedOpenHashMap
,Byte2ShortMaps.EmptyMap
,Byte2ShortMaps.Singleton
,Byte2ShortMaps.SynchronizedMap
,Byte2ShortMaps.UnmodifiableMap
,Byte2ShortOpenCustomHashMap
,Byte2ShortOpenHashMap
,Byte2ShortRBTreeMap
,Byte2ShortSortedMaps.EmptySortedMap
,Byte2ShortSortedMaps.Singleton
,Byte2ShortSortedMaps.SynchronizedSortedMap
,Byte2ShortSortedMaps.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 Byte2ShortFunction extends Function<java.lang.Byte,java.lang.Short>, 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 Byte2ByteFunction
andThen(Short2ByteFunction after)
default Byte2CharFunction
andThen(Short2CharFunction after)
default Byte2DoubleFunction
andThen(Short2DoubleFunction after)
default Byte2FloatFunction
andThen(Short2FloatFunction after)
default Byte2IntFunction
andThen(Short2IntFunction after)
default Byte2LongFunction
andThen(Short2LongFunction after)
default <T> Byte2ObjectFunction<T>
andThen(Short2ObjectFunction<T> after)
default <T> Byte2ReferenceFunction<T>
andThen(Short2ReferenceFunction<T> after)
default Byte2ShortFunction
andThen(Short2ShortFunction after)
default int
applyAsInt(int operand)
Deprecated.Please use primitive types which don't have to be widened as keys.default Byte2ShortFunction
compose(Byte2ByteFunction before)
default Char2ShortFunction
compose(Char2ByteFunction before)
default Double2ShortFunction
compose(Double2ByteFunction before)
default Float2ShortFunction
compose(Float2ByteFunction before)
default Int2ShortFunction
compose(Int2ByteFunction before)
default Long2ShortFunction
compose(Long2ByteFunction before)
default <T> Object2ShortFunction<T>
compose(Object2ByteFunction<T> before)
default <T> Reference2ShortFunction<T>
compose(Reference2ByteFunction<T> before)
default Short2ShortFunction
compose(Short2ByteFunction before)
default boolean
containsKey(byte 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(byte 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
put(byte key, short value)
Adds a pair to the map (optional operation).default java.lang.Short
put(java.lang.Byte key, java.lang.Short value)
Deprecated.Please use the corresponding type-specific method instead.default short
remove(byte 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.
-
-
-
Method Detail
-
applyAsInt
@Deprecated default int applyAsInt(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:
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
-
put
default short put(byte key, short 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
short get(byte 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 short remove(byte 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.Short put(java.lang.Byte key, java.lang.Short 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.Short 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 java.lang.Short 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(byte 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.Byte,java.lang.Short>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(short 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 short 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.
-
andThen
default Byte2ByteFunction andThen(Short2ByteFunction after)
-
compose
default Byte2ShortFunction compose(Byte2ByteFunction before)
-
andThen
default Byte2ShortFunction andThen(Short2ShortFunction after)
-
compose
default Short2ShortFunction compose(Short2ByteFunction before)
-
andThen
default Byte2IntFunction andThen(Short2IntFunction after)
-
compose
default Int2ShortFunction compose(Int2ByteFunction before)
-
andThen
default Byte2LongFunction andThen(Short2LongFunction after)
-
compose
default Long2ShortFunction compose(Long2ByteFunction before)
-
andThen
default Byte2CharFunction andThen(Short2CharFunction after)
-
compose
default Char2ShortFunction compose(Char2ByteFunction before)
-
andThen
default Byte2FloatFunction andThen(Short2FloatFunction after)
-
compose
default Float2ShortFunction compose(Float2ByteFunction before)
-
andThen
default Byte2DoubleFunction andThen(Short2DoubleFunction after)
-
compose
default Double2ShortFunction compose(Double2ByteFunction before)
-
andThen
default <T> Byte2ObjectFunction<T> andThen(Short2ObjectFunction<T> after)
-
compose
default <T> Object2ShortFunction<T> compose(Object2ByteFunction<T> before)
-
andThen
default <T> Byte2ReferenceFunction<T> andThen(Short2ReferenceFunction<T> after)
-
compose
default <T> Reference2ShortFunction<T> compose(Reference2ByteFunction<T> before)
-
-