Package it.unimi.dsi.fastutil.chars

Interface Char2ReferenceFunction<V>

All Superinterfaces:
it.unimi.dsi.fastutil.Function<java.lang.Character,​V>, java.util.function.Function<java.lang.Character,​V>, java.util.function.IntFunction<V>
All Known Subinterfaces:
Char2ReferenceMap<V>, Char2ReferenceSortedMap<V>
All Known Implementing Classes:
AbstractChar2ReferenceFunction, AbstractChar2ReferenceMap, AbstractChar2ReferenceSortedMap, Char2ReferenceArrayMap, Char2ReferenceAVLTreeMap, Char2ReferenceFunctions.EmptyFunction, Char2ReferenceFunctions.PrimitiveFunction, Char2ReferenceFunctions.Singleton, Char2ReferenceFunctions.SynchronizedFunction, Char2ReferenceFunctions.UnmodifiableFunction, Char2ReferenceLinkedOpenHashMap, Char2ReferenceMaps.EmptyMap, Char2ReferenceMaps.Singleton, Char2ReferenceMaps.SynchronizedMap, Char2ReferenceMaps.UnmodifiableMap, Char2ReferenceOpenCustomHashMap, Char2ReferenceOpenHashMap, Char2ReferenceRBTreeMap, Char2ReferenceSortedMaps.EmptySortedMap, Char2ReferenceSortedMaps.Singleton, Char2ReferenceSortedMaps.SynchronizedSortedMap, Char2ReferenceSortedMaps.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 Char2ReferenceFunction<V>
extends it.unimi.dsi.fastutil.Function<java.lang.Character,​V>, java.util.function.IntFunction<V>
A type-specific 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 Char2ByteFunction andThenByte​(Reference2ByteFunction<V> after)  
    default Char2CharFunction andThenChar​(Reference2CharFunction<V> after)  
    default it.unimi.dsi.fastutil.chars.Char2DoubleFunction andThenDouble​(it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<V> after)  
    default Char2FloatFunction andThenFloat​(Reference2FloatFunction<V> after)  
    default it.unimi.dsi.fastutil.chars.Char2IntFunction andThenInt​(it.unimi.dsi.fastutil.objects.Reference2IntFunction<V> after)  
    default it.unimi.dsi.fastutil.chars.Char2LongFunction andThenLong​(it.unimi.dsi.fastutil.objects.Reference2LongFunction<V> after)  
    default <T> it.unimi.dsi.fastutil.chars.Char2ObjectFunction<T> andThenObject​(it.unimi.dsi.fastutil.objects.Reference2ObjectFunction<? super V,​? extends T> after)  
    default <T> Char2ReferenceFunction<T> andThenReference​(Reference2ReferenceFunction<? super V,​? extends T> after)  
    default Char2ShortFunction andThenShort​(Reference2ShortFunction<V> after)  
    default V apply​(int operand)
    Deprecated.
    Please use primitive types which do not have to be widened as keys.
    default <T> java.util.function.Function<T,​V> compose​(java.util.function.Function<? super T,​? extends java.lang.Character> before)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default Byte2ReferenceFunction<V> composeByte​(Byte2CharFunction before)  
    default Char2ReferenceFunction<V> composeChar​(Char2CharFunction before)  
    default it.unimi.dsi.fastutil.doubles.Double2ReferenceFunction<V> composeDouble​(it.unimi.dsi.fastutil.doubles.Double2CharFunction before)  
    default Float2ReferenceFunction<V> composeFloat​(Float2CharFunction before)  
    default it.unimi.dsi.fastutil.ints.Int2ReferenceFunction<V> composeInt​(it.unimi.dsi.fastutil.ints.Int2CharFunction before)  
    default it.unimi.dsi.fastutil.longs.Long2ReferenceFunction<V> composeLong​(it.unimi.dsi.fastutil.longs.Long2CharFunction before)  
    default <T> it.unimi.dsi.fastutil.objects.Object2ReferenceFunction<T,​V> composeObject​(it.unimi.dsi.fastutil.objects.Object2CharFunction<? super T> before)  
    default <T> Reference2ReferenceFunction<T,​V> composeReference​(Reference2CharFunction<? super T> before)  
    default Short2ReferenceFunction<V> composeShort​(Short2CharFunction before)  
    default boolean containsKey​(char 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 V defaultReturnValue()
    Gets the default return value.
    default void defaultReturnValue​(V rv)
    Sets the default return value (optional operation).
    V get​(char key)
    Returns the value to which the given key is mapped.
    default V get​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V getOrDefault​(char key, V defaultValue)
    Returns the value associated by this function to the specified key, or give the specified value if not present.
    default V getOrDefault​(java.lang.Object key, V defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V put​(char key, V value)
    Adds a pair to the map (optional operation).
    default V put​(java.lang.Character key, V value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V remove​(char key)
    Removes the mapping with the given key (optional operation).
    default V remove​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.

    Methods inherited from interface it.unimi.dsi.fastutil.Function

    apply, clear, size

    Methods inherited from interface java.util.function.Function

    andThen

  • Method Details

    • apply

      @Deprecated default V apply​(int operand)
      Deprecated.
      Please use primitive types which do not have to be widened as keys.
      Specified by:
      apply in interface java.util.function.IntFunction<V>
      Throws:
      java.lang.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 of Short2IntFunction).

    • put

      default V put​(char key, V 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

      V 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 V getOrDefault​(char key, V 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 V 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 default V put​(java.lang.Character key, V value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      put in interface it.unimi.dsi.fastutil.Function<java.lang.Character,​V>

    • get

      @Deprecated default V get​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      get in interface it.unimi.dsi.fastutil.Function<java.lang.Character,​V>

    • getOrDefault

      @Deprecated default V getOrDefault​(java.lang.Object key, V defaultValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      getOrDefault in interface it.unimi.dsi.fastutil.Function<java.lang.Character,​V>

    • remove

      @Deprecated default V remove​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      remove in interface it.unimi.dsi.fastutil.Function<java.lang.Character,​V>

    • 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 default boolean containsKey​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      containsKey in interface it.unimi.dsi.fastutil.Function<java.lang.Character,​V>

    • defaultReturnValue

      default void defaultReturnValue​(V rv)
      Sets the default return value (optional operation). This value must be returned by type-specific versions of get(), put() and remove() 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 V 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 default <T> java.util.function.Function<T,​V> compose​(java.util.function.Function<? super T,​? extends java.lang.Character> before)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      compose in interface java.util.function.Function<java.lang.Character,​V>

    • andThenByte

      default Char2ByteFunction andThenByte​(Reference2ByteFunction<V> after)

    • composeByte

      default Byte2ReferenceFunction<V> composeByte​(Byte2CharFunction before)

    • andThenShort

      default Char2ShortFunction andThenShort​(Reference2ShortFunction<V> after)

    • composeShort

      default Short2ReferenceFunction<V> composeShort​(Short2CharFunction before)

    • andThenInt

      default it.unimi.dsi.fastutil.chars.Char2IntFunction andThenInt​(it.unimi.dsi.fastutil.objects.Reference2IntFunction<V> after)

    • composeInt

      default it.unimi.dsi.fastutil.ints.Int2ReferenceFunction<V> composeInt​(it.unimi.dsi.fastutil.ints.Int2CharFunction before)

    • andThenLong

      default it.unimi.dsi.fastutil.chars.Char2LongFunction andThenLong​(it.unimi.dsi.fastutil.objects.Reference2LongFunction<V> after)

    • composeLong

      default it.unimi.dsi.fastutil.longs.Long2ReferenceFunction<V> composeLong​(it.unimi.dsi.fastutil.longs.Long2CharFunction before)

    • andThenChar

      default Char2CharFunction andThenChar​(Reference2CharFunction<V> after)

    • composeChar

      default Char2ReferenceFunction<V> composeChar​(Char2CharFunction before)

    • andThenFloat

      default Char2FloatFunction andThenFloat​(Reference2FloatFunction<V> after)

    • composeFloat

      default Float2ReferenceFunction<V> composeFloat​(Float2CharFunction before)

    • andThenDouble

      default it.unimi.dsi.fastutil.chars.Char2DoubleFunction andThenDouble​(it.unimi.dsi.fastutil.objects.Reference2DoubleFunction<V> after)

    • composeDouble

      default it.unimi.dsi.fastutil.doubles.Double2ReferenceFunction<V> composeDouble​(it.unimi.dsi.fastutil.doubles.Double2CharFunction before)

    • andThenObject

      default <T> it.unimi.dsi.fastutil.chars.Char2ObjectFunction<T> andThenObject​(it.unimi.dsi.fastutil.objects.Reference2ObjectFunction<? super V,​? extends T> after)

    • composeObject

      default <T> it.unimi.dsi.fastutil.objects.Object2ReferenceFunction<T,​V> composeObject​(it.unimi.dsi.fastutil.objects.Object2CharFunction<? super T> before)

    • andThenReference

      default <T> Char2ReferenceFunction<T> andThenReference​(Reference2ReferenceFunction<? super V,​? extends T> after)

    • composeReference

      default <T> Reference2ReferenceFunction<T,​V> composeReference​(Reference2CharFunction<? super T> before)