Char2IntMaps.UnmodifiableMap (fastutil 7.0.8)

java.lang.Object
- it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction
- - it.unimi.dsi.fastutil.chars.Char2IntFunctions.UnmodifiableFunction
  - - it.unimi.dsi.fastutil.chars.Char2IntMaps.UnmodifiableMap

All Implemented Interfaces:

Char2IntFunction, Char2IntMap, Function<Character,Integer>, Serializable, Map<Character,Integer>

Direct Known Subclasses:

Char2IntSortedMaps.UnmodifiableSortedMap

Enclosing class:

Char2IntMaps
```
public static class Char2IntMaps.UnmodifiableMap
extends Char2IntFunctions.UnmodifiableFunction
implements Char2IntMap, Serializable
```
An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2IntMap
  Char2IntMap.Entry, Char2IntMap.FastEntrySet

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectSet<Char2IntMap.Entry>`	`char2IntEntrySet()` Returns a type-specific set view of the mappings contained in this map.
`void`	`clear()` Removes all associations from this function (optional operation).
`boolean`	`containsKey(char k)`
`boolean`	`containsKey(Object ok)` Returns true if this function contains a mapping for the specified key.
`boolean`	`containsValue(int v)`
`boolean`	`containsValue(Object ov)`
`int`	`defaultReturnValue()` Gets the default return value.
`void`	`defaultReturnValue(int defRetValue)` Sets the default return value.
`ObjectSet<Map.Entry<Character,Integer>>`	`entrySet()` Returns a set view of the mappings contained in this map.
`int`	`get(char k)` Returns the value to which the given key is mapped.
`boolean`	`isEmpty()`
`CharSet`	`keySet()` Returns a set view of the keys contained in this map.
`Integer`	`put(Character k, Integer v)` Delegates to the corresponding type-specific method, taking care of returning `null` on a missing key.
`int`	`put(char k, int v)` Adds a pair to the map.
`void`	`putAll(Map<? extends Character,? extends Integer> m)`
`int`	`remove(char k)` Removes the mapping with the given key.
`int`	`size()` Returns the intended number of keys in this function, or -1 if no such number exists.
`String`	`toString()`
`IntCollection`	`values()` Returns a set view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction
get, remove

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

Methods inherited from interface it.unimi.dsi.fastutil.Function
get, remove

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, get, getOrDefault, hashCode, merge, putIfAbsent, remove, remove, replace, replace, replaceAll

- 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<Character,Integer>
    
    Specified by:
    
    size in interface Map<Character,Integer>
    
    Overrides:
    
    size in class Char2IntFunctions.UnmodifiableFunction
    
    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 Char2IntFunction
    
    Overrides:
    
    containsKey in class Char2IntFunctions.UnmodifiableFunction
    
    See Also:
    
    Function.containsKey(Object)
  - containsValue
```
public boolean containsValue(int v)
```
    Specified by:
    
    containsValue in interface Char2IntMap
    
    See Also:
    
    Map.containsValue(Object)
  - defaultReturnValue
```
public int defaultReturnValue()
```
    Description copied from interface: Char2IntFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Char2IntFunction
    
    Overrides:
    
    defaultReturnValue in class Char2IntFunctions.UnmodifiableFunction
    
    Returns:
    
    the current default return value.
  - defaultReturnValue
```
public void defaultReturnValue(int defRetValue)
```
    Description copied from interface: Char2IntFunction
    
    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 Char2IntFunction
    
    Overrides:
    
    defaultReturnValue in class Char2IntFunctions.UnmodifiableFunction
    
    Parameters:
    
    defRetValue - the new default return value.
    
    See Also:
    
    Char2IntFunction.defaultReturnValue()
  - put
```
public int put(char k,
               int v)
```
    Description copied from interface: Char2IntFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Char2IntFunction
    
    Overrides:
    
    put in class Char2IntFunctions.UnmodifiableFunction
    
    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)
  - putAll
```
public void putAll(Map<? extends Character,? extends Integer> m)
```
    Specified by:
    
    putAll in interface Map<Character,Integer>
  - char2IntEntrySet
```
public ObjectSet<Char2IntMap.Entry> char2IntEntrySet()
```
    Description copied from interface: Char2IntMap
    
    Returns a type-specific set view of the mappings contained in this map.
    This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Char2IntMap.entrySet() so that it returns an ObjectSet of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).
    
    Specified by:
    
    char2IntEntrySet in interface Char2IntMap
    
    Returns:
    
    a type-specific set view of the mappings contained in this map.
    
    See Also:
    
    Char2IntMap.entrySet()
  - keySet
```
public CharSet keySet()
```
    Description copied from interface: Char2IntMap
    
    Returns a set view of the keys contained in this map.
    Note that this specification strengthens the one given in Map.keySet().
    
    Specified by:
    
    keySet in interface Char2IntMap
    
    Specified by:
    
    keySet in interface Map<Character,Integer>
    
    Returns:
    
    a set view of the keys contained in this map.
    
    See Also:
    
    Map.keySet()
  - values
```
public IntCollection values()
```
    Description copied from interface: Char2IntMap
    
    Returns a set view of the values contained in this map.
    Note that this specification strengthens the one given in Map.values().
    
    Specified by:
    
    values in interface Char2IntMap
    
    Specified by:
    
    values in interface Map<Character,Integer>
    
    Returns:
    
    a set view of the values contained in this map.
    
    See Also:
    
    Map.values()
  - clear
```
public void clear()
```
    Description copied from interface: Function
    
    Removes all associations from this function (optional operation).
    
    Specified by:
    
    clear in interface Function<Character,Integer>
    
    Specified by:
    
    clear in interface Map<Character,Integer>
    
    Overrides:
    
    clear in class Char2IntFunctions.UnmodifiableFunction
    
    See Also:
    
    Map.clear()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Char2IntFunctions.UnmodifiableFunction
  - put
```
public Integer put(Character k,
                   Integer v)
```
    Description copied from class: AbstractChar2IntFunction
    
    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:
    
    put in interface Function<Character,Integer>
    
    Specified by:
    
    put in interface Map<Character,Integer>
    
    Overrides:
    
    put in class AbstractChar2IntFunction
    
    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)
  - remove
```
public int remove(char k)
```
    Description copied from interface: Char2IntFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    remove in interface Char2IntFunction
    
    Overrides:
    
    remove in class Char2IntFunctions.UnmodifiableFunction
    
    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 int get(char k)
```
    Description copied from interface: Char2IntFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    get in interface Char2IntFunction
    
    Overrides:
    
    get in class Char2IntFunctions.UnmodifiableFunction
    
    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(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<Character,Integer>
    
    Specified by:
    
    containsKey in interface Map<Character,Integer>
    
    Overrides:
    
    containsKey in class Char2IntFunctions.UnmodifiableFunction
    
    Parameters:
    
    ok - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(Object ov)
```
    Specified by:
    
    containsValue in interface Map<Character,Integer>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<Character,Integer>
  - entrySet
```
public ObjectSet<Map.Entry<Character,Integer>> entrySet()
```
    Description copied from interface: Char2IntMap
    
    Returns a set view of the mappings contained in this map.
    Note that this specification strengthens the one given in Map.entrySet().
    
    Specified by:
    
    entrySet in interface Char2IntMap
    
    Specified by:
    
    entrySet in interface Map<Character,Integer>
    
    Returns:
    
    a set view of the mappings contained in this map.
    
    See Also:
    
    Map.entrySet()

Class Char2IntMaps.UnmodifiableMap

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2IntMap

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

Method Detail

size

containsKey

containsValue

defaultReturnValue

defaultReturnValue

put

putAll

char2IntEntrySet

keySet

values

clear

toString

put

remove

get

containsKey

containsValue

isEmpty

entrySet