Interface Char2LongFunction
- All Known Subinterfaces:
Char2LongMap
,Char2LongSortedMap
- All Known Implementing Classes:
AbstractChar2LongFunction
,AbstractChar2LongMap
,AbstractChar2LongSortedMap
,Char2LongArrayMap
,Char2LongAVLTreeMap
,Char2LongFunctions.EmptyFunction
,Char2LongFunctions.PrimitiveFunction
,Char2LongFunctions.Singleton
,Char2LongFunctions.SynchronizedFunction
,Char2LongFunctions.UnmodifiableFunction
,Char2LongLinkedOpenHashMap
,Char2LongMaps.EmptyMap
,Char2LongMaps.Singleton
,Char2LongMaps.SynchronizedMap
,Char2LongMaps.UnmodifiableMap
,Char2LongOpenCustomHashMap
,Char2LongOpenHashMap
,Char2LongRBTreeMap
,Char2LongSortedMaps.EmptySortedMap
,Char2LongSortedMaps.Singleton
,Char2LongSortedMaps.SynchronizedSortedMap
,Char2LongSortedMaps.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 Char2LongFunction extends Function<Character,Long>, IntToLongFunction
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 <T> Function<Character,T>
andThen(Function<? super Long,? extends T> after)
Deprecated.Please use the corresponding type-specific method instead.default Char2ByteFunction
andThenByte(Long2ByteFunction after)
default Char2CharFunction
andThenChar(Long2CharFunction after)
default Char2DoubleFunction
andThenDouble(Long2DoubleFunction after)
default Char2FloatFunction
andThenFloat(Long2FloatFunction after)
default Char2IntFunction
andThenInt(Long2IntFunction after)
default Char2LongFunction
andThenLong(Long2LongFunction after)
default <T> Char2ObjectFunction<T>
andThenObject(Long2ObjectFunction<? extends T> after)
default <T> Char2ReferenceFunction<T>
andThenReference(Long2ReferenceFunction<? extends T> after)
default Char2ShortFunction
andThenShort(Long2ShortFunction after)
default long
applyAsLong(int operand)
Deprecated.Please use primitive types which do not have to be widened as keys.default <T> Function<T,Long>
compose(Function<? super T,? extends Character> before)
Deprecated.Please use the corresponding type-specific method instead.default Byte2LongFunction
composeByte(Byte2CharFunction before)
default Char2LongFunction
composeChar(Char2CharFunction before)
default Double2LongFunction
composeDouble(Double2CharFunction before)
default Float2LongFunction
composeFloat(Float2CharFunction before)
default Int2LongFunction
composeInt(Int2CharFunction before)
default Long2LongFunction
composeLong(Long2CharFunction before)
default <T> Object2LongFunction<T>
composeObject(Object2CharFunction<? super T> before)
default <T> Reference2LongFunction<T>
composeReference(Reference2CharFunction<? super T> before)
default Short2LongFunction
composeShort(Short2CharFunction before)
default boolean
containsKey(char 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 long
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(long rv)
Sets the default return value (optional operation).long
get(char key)
Returns the value to which the given key is mapped.default Long
get(Object key)
Deprecated.Please use the corresponding type-specific method instead.default long
getOrDefault(char key, long defaultValue)
Returns the value associated by this function to the specified key, or give the specified value if not present.default Long
getOrDefault(Object key, Long defaultValue)
Deprecated.Please use the corresponding type-specific method instead.default long
put(char key, long value)
Adds a pair to the map (optional operation).default Long
put(Character key, Long value)
Deprecated.Please use the corresponding type-specific method instead.default long
remove(char key)
Removes the mapping with the given key (optional operation).default Long
remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.
-
Method Details
-
applyAsLong
Deprecated.Please use primitive types which do not have to be widened as keys.- Specified by:
applyAsLong
in interfaceIntToLongFunction
- Throws:
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 long put(char key, long 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
long get(char 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 long getOrDefault(char key, long 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 long remove(char 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<Character,Long>
- 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<Character,Long>
- Parameters:
key
- the key.- Returns:
- the corresponding value, or
null
if no value was present for the given key. - See Also:
Map.get(Object)
-
getOrDefault
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<Character,Long>
- 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.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<Character,Long>
- 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(char 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<Character,Long>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
defaultReturnValue
default void defaultReturnValue(long 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 long 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.Please use the corresponding type-specific method instead. -
andThen
Deprecated.Please use the corresponding type-specific method instead. -
andThenByte
-
composeByte
-
andThenShort
-
composeShort
-
andThenInt
-
composeInt
-
andThenLong
-
composeLong
-
andThenChar
-
composeChar
-
andThenFloat
-
composeFloat
-
andThenDouble
-
composeDouble
-
andThenObject
-
composeObject
-
andThenReference
-
composeReference
-