Interface Long2ByteFunction
-
- All Superinterfaces:
Function<java.lang.Long,java.lang.Byte>
,java.util.function.Function<java.lang.Long,java.lang.Byte>
,java.util.function.LongToIntFunction
- All Known Subinterfaces:
Long2ByteMap
,Long2ByteSortedMap
- All Known Implementing Classes:
AbstractLong2ByteFunction
,AbstractLong2ByteMap
,AbstractLong2ByteSortedMap
,Long2ByteArrayMap
,Long2ByteAVLTreeMap
,Long2ByteFunctions.EmptyFunction
,Long2ByteFunctions.PrimitiveFunction
,Long2ByteFunctions.Singleton
,Long2ByteFunctions.SynchronizedFunction
,Long2ByteFunctions.UnmodifiableFunction
,Long2ByteLinkedOpenHashMap
,Long2ByteMaps.EmptyMap
,Long2ByteMaps.Singleton
,Long2ByteMaps.SynchronizedMap
,Long2ByteMaps.UnmodifiableMap
,Long2ByteOpenCustomHashMap
,Long2ByteOpenHashMap
,Long2ByteRBTreeMap
,Long2ByteSortedMaps.EmptySortedMap
,Long2ByteSortedMaps.Singleton
,Long2ByteSortedMaps.SynchronizedSortedMap
,Long2ByteSortedMaps.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 Long2ByteFunction extends Function<java.lang.Long,java.lang.Byte>, java.util.function.LongToIntFunction
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 Long2ByteFunction
andThen(Byte2ByteFunction after)
default Long2CharFunction
andThen(Byte2CharFunction after)
default Long2DoubleFunction
andThen(Byte2DoubleFunction after)
default Long2FloatFunction
andThen(Byte2FloatFunction after)
default Long2IntFunction
andThen(Byte2IntFunction after)
default Long2LongFunction
andThen(Byte2LongFunction after)
default <T> Long2ObjectFunction<T>
andThen(Byte2ObjectFunction<T> after)
default <T> Long2ReferenceFunction<T>
andThen(Byte2ReferenceFunction<T> after)
default Long2ShortFunction
andThen(Byte2ShortFunction after)
default int
applyAsInt(long operand)
default Byte2ByteFunction
compose(Byte2LongFunction before)
default Char2ByteFunction
compose(Char2LongFunction before)
default Double2ByteFunction
compose(Double2LongFunction before)
default Float2ByteFunction
compose(Float2LongFunction before)
default Int2ByteFunction
compose(Int2LongFunction before)
default Long2ByteFunction
compose(Long2LongFunction before)
default <T> Object2ByteFunction<T>
compose(Object2LongFunction<T> before)
default <T> Reference2ByteFunction<T>
compose(Reference2LongFunction<T> before)
default Short2ByteFunction
compose(Short2LongFunction before)
default boolean
containsKey(long 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(long 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
put(long key, byte value)
Adds a pair to the map (optional operation).default java.lang.Byte
put(java.lang.Long key, java.lang.Byte value)
Deprecated.Please use the corresponding type-specific method instead.default byte
remove(long 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
default int applyAsInt(long operand)
- Specified by:
applyAsInt
in interfacejava.util.function.LongToIntFunction
- Since:
- 8.0.0
-
put
default byte put(long 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(long 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 byte remove(long 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.Long 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.
-
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(long 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.Long,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.
-
andThen
default Long2ByteFunction andThen(Byte2ByteFunction after)
-
compose
default Byte2ByteFunction compose(Byte2LongFunction before)
-
andThen
default Long2ShortFunction andThen(Byte2ShortFunction after)
-
compose
default Short2ByteFunction compose(Short2LongFunction before)
-
andThen
default Long2IntFunction andThen(Byte2IntFunction after)
-
compose
default Int2ByteFunction compose(Int2LongFunction before)
-
andThen
default Long2LongFunction andThen(Byte2LongFunction after)
-
compose
default Long2ByteFunction compose(Long2LongFunction before)
-
andThen
default Long2CharFunction andThen(Byte2CharFunction after)
-
compose
default Char2ByteFunction compose(Char2LongFunction before)
-
andThen
default Long2FloatFunction andThen(Byte2FloatFunction after)
-
compose
default Float2ByteFunction compose(Float2LongFunction before)
-
andThen
default Long2DoubleFunction andThen(Byte2DoubleFunction after)
-
compose
default Double2ByteFunction compose(Double2LongFunction before)
-
andThen
default <T> Long2ObjectFunction<T> andThen(Byte2ObjectFunction<T> after)
-
compose
default <T> Object2ByteFunction<T> compose(Object2LongFunction<T> before)
-
andThen
default <T> Long2ReferenceFunction<T> andThen(Byte2ReferenceFunction<T> after)
-
compose
default <T> Reference2ByteFunction<T> compose(Reference2LongFunction<T> before)
-
-