Char2ObjectFunctions.UnmodifiableFunction (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.chars.AbstractChar2ObjectFunction<V>
- - it.unimi.dsi.fastutil.chars.Char2ObjectFunctions.UnmodifiableFunction<V>

All Implemented Interfaces:

Char2ObjectFunction<V>, Function<java.lang.Character,V>, java.io.Serializable

Direct Known Subclasses:

Char2ObjectMaps.UnmodifiableMap

Enclosing class:

Char2ObjectFunctions
```
public static class Char2ObjectFunctions.UnmodifiableFunction<V>
extends AbstractChar2ObjectFunction<V>
implements java.io.Serializable
```
An unmodifiable wrapper class for functions.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all associations from this function (optional operation).
`boolean`	`containsKey(char k)`
`boolean`	`containsKey(java.lang.Object ok)` Returns true if this function contains a mapping for the specified key.
`V`	`defaultReturnValue()` Gets the default return value.
`void`	`defaultReturnValue(V defRetValue)` Sets the default return value.
`V`	`get(char k)` Returns the value to which the given key is mapped.
`V`	`get(java.lang.Object k)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`V`	`put(char k, V v)` Adds a pair to the map.
`V`	`remove(char k)` Removes the mapping with the given key.
`V`	`remove(java.lang.Object k)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`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 it.unimi.dsi.fastutil.chars.AbstractChar2ObjectFunction
put

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - 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.
    
    Specified by:
    
    size in interface Function<java.lang.Character,V>
    
    Returns:
    
    the intended number of keys in this function, or -1 if that number is not available.
  - containsKey
```
public boolean containsKey(char k)
```
    Specified by:
    
    containsKey in interface Char2ObjectFunction<V>
    
    See Also:
    
    Function.containsKey(Object)
  - defaultReturnValue
```
public V defaultReturnValue()
```
    Description copied from interface: Char2ObjectFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Char2ObjectFunction<V>
    
    Overrides:
    
    defaultReturnValue in class AbstractChar2ObjectFunction<V>
    
    Returns:
    
    the current default return value.
  - defaultReturnValue
```
public void defaultReturnValue(V defRetValue)
```
    Description copied from interface: Char2ObjectFunction
    
    Sets the default return value. 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 Char2ObjectFunction<V>
    
    Overrides:
    
    defaultReturnValue in class AbstractChar2ObjectFunction<V>
    
    Parameters:
    
    defRetValue - the new default return value.
    
    See Also:
    
    Char2ObjectFunction.defaultReturnValue()
  - put
```
public V put(char k,
             V v)
```
    Description copied from interface: Char2ObjectFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Char2ObjectFunction<V>
    
    Overrides:
    
    put in class AbstractChar2ObjectFunction<V>
    
    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)
  - clear
```
public void clear()
```
    Description copied from interface: Function
    
    Removes all associations from this function (optional operation).
    
    Specified by:
    
    clear in interface Function<java.lang.Character,V>
    
    Overrides:
    
    clear in class AbstractChar2ObjectFunction<V>
    
    See Also:
    
    Map.clear()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - remove
```
public V remove(char k)
```
    Description copied from interface: Char2ObjectFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Char2ObjectFunction<V>
    
    Overrides:
    
    remove in class AbstractChar2ObjectFunction<V>
    
    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)
  - get
```
public V get(char k)
```
    Description copied from interface: Char2ObjectFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    get in interface Char2ObjectFunction<V>
    
    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)
  - containsKey
```
public boolean containsKey(java.lang.Object ok)
```
    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.
    
    Specified by:
    
    containsKey in interface Function<java.lang.Character,V>
    
    Overrides:
    
    containsKey in class AbstractChar2ObjectFunction<V>
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - remove
```
public V remove(java.lang.Object k)
```
    Description copied from class: AbstractChar2ObjectFunction
    
    Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
    This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.
    
    Specified by:
    
    remove in interface Function<java.lang.Character,V>
    
    Overrides:
    
    remove in class AbstractChar2ObjectFunction<V>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    the old value, or null if no value was present for the given key.
    
    See Also:
    
    Map.remove(Object)
  - get
```
public V get(java.lang.Object k)
```
    Description copied from class: AbstractChar2ObjectFunction
    
    Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
    This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.
    
    Specified by:
    
    get in interface Function<java.lang.Character,V>
    
    Overrides:
    
    get in class AbstractChar2ObjectFunction<V>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    the corresponding value, or null if no value was present for the given key.
    
    See Also:
    
    Map.get(Object)

Class Char2ObjectFunctions.UnmodifiableFunction<V>

Method Summary

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2ObjectFunction

Methods inherited from class java.lang.Object

Method Detail

size

containsKey

defaultReturnValue

defaultReturnValue

put

clear

toString

remove

get

containsKey

remove

get