Package it.unimi.dsi.fastutil.objects

Class Reference2ShortFunctions.UnmodifiableFunction<K>

java.lang.Object
it.unimi.dsi.fastutil.objects.AbstractReference2ShortFunction<K>
it.unimi.dsi.fastutil.objects.Reference2ShortFunctions.UnmodifiableFunction<K>
All Implemented Interfaces:
Function<K,​java.lang.Short>, Reference2ShortFunction<K>, java.io.Serializable, java.util.function.Function<K,​java.lang.Short>, java.util.function.ToIntFunction<K>
Direct Known Subclasses:
Reference2ShortMaps.UnmodifiableMap
Enclosing class:
Reference2ShortFunctions
public static class Reference2ShortFunctions.UnmodifiableFunction<K>
extends AbstractReference2ShortFunction<K>
implements java.io.Serializable
An unmodifiable wrapper class for functions.
See Also:
Serialized Form

  • Method Summary

    Modifier and Type Method Description
    void clear()
    Removes all associations from this function (optional operation).
    boolean containsKey​(java.lang.Object k)
    Returns true if this function contains a mapping for the specified key.
    short defaultReturnValue()
    Gets the default return value.
    void defaultReturnValue​(short defRetValue)
    Sets the default return value (optional operation).
    boolean equals​(java.lang.Object o)  
    java.lang.Short get​(java.lang.Object k)
    Deprecated.
    Please use the corresponding type-specific method instead.
    short getOrDefault​(java.lang.Object k, short defaultValue)
    Returns the value associated by this function to the specified key, or give the specified value if not present.
    java.lang.Short getOrDefault​(java.lang.Object k, java.lang.Short defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    short getShort​(java.lang.Object k)
    Returns the value to which the given key is mapped.
    int hashCode()  
    short put​(K k, short v)
    Adds a pair to the map (optional operation).
    java.lang.Short put​(K k, java.lang.Short v)
    Deprecated.
    Please use the corresponding type-specific method instead.
    java.lang.Short remove​(java.lang.Object k)
    Deprecated.
    Please use the corresponding type-specific method instead.
    short removeShort​(java.lang.Object k)
    Removes the mapping with the given key (optional operation).
    int size()
    Returns the intended number of keys in this function, or -1 if no such number exists.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

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

    apply

    Methods inherited from interface java.util.function.Function

    compose

    Methods inherited from interface it.unimi.dsi.fastutil.objects.Reference2ShortFunction

    andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort

  • 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,​java.lang.Short>
      Returns:
      the intended number of keys in this function, or -1 if that number is not available.

    • defaultReturnValue

      public short defaultReturnValue()
      Description copied from interface: Reference2ShortFunction
      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 Reference2ShortFunction<K>
      Overrides:
      defaultReturnValue in class AbstractReference2ShortFunction<K>
      Returns:
      the current default return value.

    • defaultReturnValue

      public void defaultReturnValue​(short defRetValue)
      Description copied from interface: Reference2ShortFunction
      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 Reference2ShortFunction<K>
      Overrides:
      defaultReturnValue in class AbstractReference2ShortFunction<K>
      Parameters:
      defRetValue - the new default return value.
      See Also:
      Reference2ShortFunction.defaultReturnValue()

    • containsKey

      public boolean containsKey​(java.lang.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,​java.lang.Short>
      Parameters:
      k - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
      Map.containsKey(Object)

    • put

      public short put​(K k, short v)
      Description copied from interface: Reference2ShortFunction
      Adds a pair to the map (optional operation).
      Specified by:
      put in interface Reference2ShortFunction<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:
      Function.put(Object,Object)

    • getShort

      public short getShort​(java.lang.Object k)
      Description copied from interface: Reference2ShortFunction
      Returns the value to which the given key is mapped.
      Specified by:
      getShort in interface Reference2ShortFunction<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:
      Function.get(Object)

    • getOrDefault

      public short getOrDefault​(java.lang.Object k, short defaultValue)
      Description copied from interface: Reference2ShortFunction
      Returns the value associated by this function to the specified key, or give the specified value if not present.
      Specified by:
      getOrDefault in interface Reference2ShortFunction<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:
      Function.getOrDefault(Object, Object)

    • removeShort

      public short removeShort​(java.lang.Object k)
      Description copied from interface: Reference2ShortFunction
      Removes the mapping with the given key (optional operation).
      Specified by:
      removeShort in interface Reference2ShortFunction<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:
      Function.remove(Object)

    • clear

      public void clear()
      Description copied from interface: Function
      Removes all associations from this function (optional operation).
      Specified by:
      clear in interface Function<K,​java.lang.Short>
      See Also:
      Map.clear()

    • put

      @Deprecated public java.lang.Short put​(K k, java.lang.Short 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,​java.lang.Short>
      Specified by:
      put in interface Reference2ShortFunction<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:
      Map.put(Object,Object)

    • get

      @Deprecated public java.lang.Short get​(java.lang.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,​java.lang.Short>
      Specified by:
      get in interface Reference2ShortFunction<K>
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or null if no value was present for the given key.
      See Also:
      Map.get(Object)

    • getOrDefault

      @Deprecated public java.lang.Short getOrDefault​(java.lang.Object k, java.lang.Short 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,​java.lang.Short>
      Specified by:
      getOrDefault in interface Reference2ShortFunction<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:
      Map.getOrDefault(Object, Object)

    • remove

      @Deprecated public java.lang.Short remove​(java.lang.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,​java.lang.Short>
      Specified by:
      remove in interface Reference2ShortFunction<K>
      Parameters:
      k - the key.
      Returns:
      the old value, or null if no value was present for the given key.
      See Also:
      Map.remove(Object)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object