Interface Short2FloatFunction
- All Known Subinterfaces:
Short2FloatMap
,Short2FloatSortedMap
- All Known Implementing Classes:
AbstractShort2FloatFunction
,AbstractShort2FloatMap
,AbstractShort2FloatSortedMap
,Short2FloatArrayMap
,Short2FloatAVLTreeMap
,Short2FloatFunctions.EmptyFunction
,Short2FloatFunctions.PrimitiveFunction
,Short2FloatFunctions.Singleton
,Short2FloatFunctions.SynchronizedFunction
,Short2FloatFunctions.UnmodifiableFunction
,Short2FloatLinkedOpenHashMap
,Short2FloatMaps.EmptyMap
,Short2FloatMaps.Singleton
,Short2FloatMaps.SynchronizedMap
,Short2FloatMaps.UnmodifiableMap
,Short2FloatOpenCustomHashMap
,Short2FloatOpenHashMap
,Short2FloatRBTreeMap
,Short2FloatSortedMaps.EmptySortedMap
,Short2FloatSortedMaps.Singleton
,Short2FloatSortedMaps.SynchronizedSortedMap
,Short2FloatSortedMaps.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 Short2FloatFunction extends Function<Short,Float>, IntToDoubleFunction
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
.
- See Also:
Function
-
Method Summary
Modifier and Type Method Description default Short2ByteFunction
andThen(Float2ByteFunction after)
default Short2CharFunction
andThen(Float2CharFunction after)
default Short2DoubleFunction
andThen(Float2DoubleFunction after)
default Short2FloatFunction
andThen(Float2FloatFunction after)
default Short2IntFunction
andThen(Float2IntFunction after)
default Short2LongFunction
andThen(Float2LongFunction after)
default <T> Short2ObjectFunction<T>
andThen(Float2ObjectFunction<T> after)
default <T> Short2ReferenceFunction<T>
andThen(Float2ReferenceFunction<T> after)
default Short2ShortFunction
andThen(Float2ShortFunction after)
default double
applyAsDouble(int operand)
Deprecated.Please use primitive types which don't have to be widened as keys.default Byte2FloatFunction
compose(Byte2ShortFunction before)
default Char2FloatFunction
compose(Char2ShortFunction before)
default Double2FloatFunction
compose(Double2ShortFunction before)
default Float2FloatFunction
compose(Float2ShortFunction before)
default Int2FloatFunction
compose(Int2ShortFunction before)
default Long2FloatFunction
compose(Long2ShortFunction before)
default <T> Object2FloatFunction<T>
compose(Object2ShortFunction<T> before)
default <T> Reference2FloatFunction<T>
compose(Reference2ShortFunction<T> before)
default Short2FloatFunction
compose(Short2ShortFunction before)
default boolean
containsKey(short key)
Returns true if this function contains a mapping for the specified key.default boolean
containsKey(Object key)
Deprecated.Please use the corresponding type-specific method instead.default float
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(float rv)
Sets the default return value (optional operation).float
get(short key)
Returns the value to which the given key is mapped.default Float
get(Object key)
Deprecated.Please use the corresponding type-specific method instead.default float
put(short key, float value)
Adds a pair to the map (optional operation).default Float
put(Short key, Float value)
Deprecated.Please use the corresponding type-specific method instead.default float
remove(short key)
Removes the mapping with the given key (optional operation).default Float
remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
Method Details
-
applyAsDouble
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:
applyAsDouble
in interfaceIntToDoubleFunction
- Throws:
IllegalArgumentException
- If the given operand is not an element of the key domain.- Since:
- 8.0.0
-
put
default float put(short key, float 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
float 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 float 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.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).- Specified by:
put
in interfaceFunction<Short,Float>
- Parameters:
key
- the key.value
- the value.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.put(Object,Object)
-
get
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.- Specified by:
get
in interfaceFunction<Short,Float>
- Parameters:
key
- the key.- Returns:
- the corresponding value, or
null
if no value was present for the given key. - See Also:
Map.get(Object)
-
remove
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).- Specified by:
remove
in interfaceFunction<Short,Float>
- Parameters:
key
- the key.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.remove(Object)
-
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.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<Short,Float>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(float 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 float 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
-
compose
-
andThen
-
compose
-
andThen
-
compose
-
andThen
-
compose
-
andThen
-
compose
-
andThen
-
compose
-
andThen
-
compose
-
andThen
-
compose
-
andThen
-
compose
-