Interface Object2CharFunction<K>
-
- All Superinterfaces:
Function<K,java.lang.Character>
,java.util.function.Function<K,java.lang.Character>
,java.util.function.ToIntFunction<K>
- All Known Subinterfaces:
Object2CharMap<K>
,Object2CharSortedMap<K>
- All Known Implementing Classes:
AbstractObject2CharFunction
,AbstractObject2CharMap
,AbstractObject2CharSortedMap
,Object2CharArrayMap
,Object2CharAVLTreeMap
,Object2CharFunctions.EmptyFunction
,Object2CharFunctions.PrimitiveFunction
,Object2CharFunctions.Singleton
,Object2CharFunctions.SynchronizedFunction
,Object2CharFunctions.UnmodifiableFunction
,Object2CharLinkedOpenCustomHashMap
,Object2CharLinkedOpenHashMap
,Object2CharMaps.EmptyMap
,Object2CharMaps.Singleton
,Object2CharMaps.SynchronizedMap
,Object2CharMaps.UnmodifiableMap
,Object2CharOpenCustomHashMap
,Object2CharOpenHashMap
,Object2CharRBTreeMap
,Object2CharSortedMaps.EmptySortedMap
,Object2CharSortedMaps.Singleton
,Object2CharSortedMaps.SynchronizedSortedMap
,Object2CharSortedMaps.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 Object2CharFunction<K> extends Function<K,java.lang.Character>, java.util.function.ToIntFunction<K>
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 int
applyAsInt(K operand)
default char
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(char rv)
Sets the default return value (optional operation).default java.lang.Character
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.char
getChar(java.lang.Object key)
Returns the value to which the given key is mapped.default char
put(K key, char value)
Adds a pair to the map (optional operation).default java.lang.Character
put(K key, java.lang.Character value)
Deprecated.Please use the corresponding type-specific method instead.default java.lang.Character
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default char
removeChar(java.lang.Object key)
Removes the mapping with the given key (optional operation).-
Methods inherited from interface it.unimi.dsi.fastutil.Function
apply, clear, containsKey, size
-
-
-
-
Method Detail
-
applyAsInt
default int applyAsInt(K operand)
- Specified by:
applyAsInt
in interfacejava.util.function.ToIntFunction<K>
- Since:
- 8.0.0
-
put
default char put(K key, char 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)
-
getChar
char getChar(java.lang.Object 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)
-
removeChar
default char removeChar(java.lang.Object 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.Character put(K key, java.lang.Character 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.Character 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.Character 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).
-
defaultReturnValue
default void defaultReturnValue(char 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 char 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.
-
-