Class Object2CharFunctions.UnmodifiableFunction<K>

java.lang.Object
it.unimi.dsi.fastutil.objects.AbstractObject2CharFunction<K>
it.unimi.dsi.fastutil.objects.Object2CharFunctions.UnmodifiableFunction<K>
All Implemented Interfaces:
Function<K,Character>, Object2CharFunction<K>, Serializable, Function<K,Character>, ToIntFunction<K>
Direct Known Subclasses:
Object2CharMaps.UnmodifiableMap
Enclosing class:
Object2CharFunctions

public static class Object2CharFunctions.UnmodifiableFunction<K> extends AbstractObject2CharFunction<K> implements Serializable
An unmodifiable wrapper class for functions.
See Also:
  • Method Details

    • size

      public int size()
      Description copied from interface: Function
      Returns the intended number of keys in this function, or -1 if no such number exists.

      Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible. This default implementation, in particular, returns -1.

      Specified by:
      size in interface Function<K,Character>
      Returns:
      the intended number of keys in this function, or -1 if that number is not available.
    • defaultReturnValue

      public char defaultReturnValue()
      Description copied from interface: Object2CharFunction
      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).

      Specified by:
      defaultReturnValue in interface Object2CharFunction<K>
      Overrides:
      defaultReturnValue in class AbstractObject2CharFunction<K>
      Returns:
      the current default return value.
    • defaultReturnValue

      public void defaultReturnValue(char defRetValue)
      Description copied from interface: Object2CharFunction
      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.
      Specified by:
      defaultReturnValue in interface Object2CharFunction<K>
      Overrides:
      defaultReturnValue in class AbstractObject2CharFunction<K>
      Parameters:
      defRetValue - the new default return value.
      See Also:
    • containsKey

      public boolean containsKey(Object k)
      Description copied from interface: Function
      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 interface Function<K,Character>
      Parameters:
      k - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
    • put

      public char put(K k, char v)
      Description copied from interface: Object2CharFunction
      Adds a pair to the map (optional operation).
      Specified by:
      put in interface Object2CharFunction<K>
      Parameters:
      k - the key.
      v - the value.
      Returns:
      the old value, or the default return value if no value was present for the given key.
      See Also:
    • getChar

      public char getChar(Object k)
      Description copied from interface: Object2CharFunction
      Returns the value to which the given key is mapped.
      Specified by:
      getChar in interface Object2CharFunction<K>
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or the default return value if no value was present for the given key.
      See Also:
    • getOrDefault

      public char getOrDefault(Object k, char defaultValue)
      Description copied from interface: Object2CharFunction
      Returns the value associated by this function to the specified key, or give the specified value if not present.
      Specified by:
      getOrDefault in interface Object2CharFunction<K>
      Parameters:
      k - 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.
      See Also:
    • removeChar

      public char removeChar(Object k)
      Description copied from interface: Object2CharFunction
      Removes the mapping with the given key (optional operation).
      Specified by:
      removeChar in interface Object2CharFunction<K>
      Parameters:
      k - the key.
      Returns:
      the old value, or the default return value if no value was present for the given key.
      See Also:
    • clear

      public void clear()
      Description copied from interface: Function
      Removes all associations from this function (optional operation).
      Specified by:
      clear in interface Function<K,Character>
      See Also:
    • put

      @Deprecated public Character put(K k, Character v)
      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 interface Function<K,Character>
      Specified by:
      put in interface Object2CharFunction<K>
      Parameters:
      k - the key.
      v - the value.
      Returns:
      the old value, or null if no value was present for the given key.
      See Also:
    • get

      @Deprecated public Character get(Object k)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the value associated by this function to the specified key.
      Specified by:
      get in interface Function<K,Character>
      Specified by:
      get in interface Object2CharFunction<K>
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or null if no value was present for the given key.
      See Also:
    • getOrDefault

      @Deprecated public Character getOrDefault(Object k, Character defaultValue)
      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 interface Function<K,Character>
      Specified by:
      getOrDefault in interface Object2CharFunction<K>
      Parameters:
      k - 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:
    • remove

      @Deprecated public Character remove(Object k)
      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 interface Function<K,Character>
      Specified by:
      remove in interface Object2CharFunction<K>
      Parameters:
      k - the key.
      Returns:
      the old value, or null if no value was present for the given key.
      See Also:
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object