Interface Int2CharFunction
-
- All Known Subinterfaces:
Int2CharMap
,Int2CharSortedMap
- All Known Implementing Classes:
AbstractInt2CharFunction
,AbstractInt2CharMap
,AbstractInt2CharSortedMap
,Int2CharArrayMap
,Int2CharAVLTreeMap
,Int2CharFunctions.EmptyFunction
,Int2CharFunctions.PrimitiveFunction
,Int2CharFunctions.Singleton
,Int2CharFunctions.SynchronizedFunction
,Int2CharFunctions.UnmodifiableFunction
,Int2CharLinkedOpenHashMap
,Int2CharMaps.EmptyMap
,Int2CharMaps.Singleton
,Int2CharMaps.SynchronizedMap
,Int2CharMaps.UnmodifiableMap
,Int2CharOpenCustomHashMap
,Int2CharOpenHashMap
,Int2CharRBTreeMap
,Int2CharSortedMaps.EmptySortedMap
,Int2CharSortedMaps.Singleton
,Int2CharSortedMaps.SynchronizedSortedMap
,Int2CharSortedMaps.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 Int2CharFunction extends Function<Integer,Character>, 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 Int2ByteFunction
andThenByte(Char2ByteFunction after)
default Int2CharFunction
andThenChar(Char2CharFunction after)
default Int2DoubleFunction
andThenDouble(Char2DoubleFunction after)
default Int2FloatFunction
andThenFloat(Char2FloatFunction after)
default Int2IntFunction
andThenInt(Char2IntFunction after)
default Int2LongFunction
andThenLong(Char2LongFunction after)
default <T> Int2ObjectFunction<T>
andThenObject(Char2ObjectFunction<T> after)
default <T> Int2ReferenceFunction<T>
andThenReference(Char2ReferenceFunction<T> after)
default Int2ShortFunction
andThenShort(Char2ShortFunction after)
default int
applyAsInt(int operand)
default Byte2CharFunction
composeByte(Byte2IntFunction before)
default Char2CharFunction
composeChar(Char2IntFunction before)
default Double2CharFunction
composeDouble(Double2IntFunction before)
default Float2CharFunction
composeFloat(Float2IntFunction before)
default Int2CharFunction
composeInt(Int2IntFunction before)
default Long2CharFunction
composeLong(Long2IntFunction before)
default <T> Object2CharFunction<T>
composeObject(Object2IntFunction<T> before)
default <T> Reference2CharFunction<T>
composeReference(Reference2IntFunction<T> before)
default Short2CharFunction
composeShort(Short2IntFunction before)
default boolean
containsKey(int 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 char
defaultReturnValue()
Gets the default return value.default void
defaultReturnValue(char rv)
Sets the default return value (optional operation).char
get(int key)
Returns the value to which the given key is mapped.default Character
get(Object key)
Deprecated.Please use the corresponding type-specific method instead.default char
put(int key, char value)
Adds a pair to the map (optional operation).default Character
put(Integer key, Character value)
Deprecated.Please use the corresponding type-specific method instead.default char
remove(int key)
Removes the mapping with the given key (optional operation).default Character
remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.-
Methods inherited from interface java.util.function.IntUnaryOperator
andThen, compose
-
-
-
-
Method Detail
-
applyAsInt
default int applyAsInt(int operand)
- Specified by:
applyAsInt
in interfaceIntUnaryOperator
- Since:
- 8.0.0
-
put
default char put(int 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)
-
get
char get(int 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 char remove(int 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 Character put(Integer key, Character value)
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<Integer,Character>
- 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 default Character get(Object key)
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<Integer,Character>
- 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 default Character remove(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).- Specified by:
remove
in interfaceFunction<Integer,Character>
- 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(int 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(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<Integer,Character>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
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.
-
andThenByte
default Int2ByteFunction andThenByte(Char2ByteFunction after)
-
composeByte
default Byte2CharFunction composeByte(Byte2IntFunction before)
-
andThenShort
default Int2ShortFunction andThenShort(Char2ShortFunction after)
-
composeShort
default Short2CharFunction composeShort(Short2IntFunction before)
-
andThenInt
default Int2IntFunction andThenInt(Char2IntFunction after)
-
composeInt
default Int2CharFunction composeInt(Int2IntFunction before)
-
andThenLong
default Int2LongFunction andThenLong(Char2LongFunction after)
-
composeLong
default Long2CharFunction composeLong(Long2IntFunction before)
-
andThenChar
default Int2CharFunction andThenChar(Char2CharFunction after)
-
composeChar
default Char2CharFunction composeChar(Char2IntFunction before)
-
andThenFloat
default Int2FloatFunction andThenFloat(Char2FloatFunction after)
-
composeFloat
default Float2CharFunction composeFloat(Float2IntFunction before)
-
andThenDouble
default Int2DoubleFunction andThenDouble(Char2DoubleFunction after)
-
composeDouble
default Double2CharFunction composeDouble(Double2IntFunction before)
-
andThenObject
default <T> Int2ObjectFunction<T> andThenObject(Char2ObjectFunction<T> after)
-
composeObject
default <T> Object2CharFunction<T> composeObject(Object2IntFunction<T> before)
-
andThenReference
default <T> Int2ReferenceFunction<T> andThenReference(Char2ReferenceFunction<T> after)
-
composeReference
default <T> Reference2CharFunction<T> composeReference(Reference2IntFunction<T> before)
-
-