Reference2BooleanMaps.UnmodifiableMap (fastutil 7.0.13)

java.lang.Object
- it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction<K>
- - it.unimi.dsi.fastutil.objects.Reference2BooleanFunctions.UnmodifiableFunction<K>
  - - it.unimi.dsi.fastutil.objects.Reference2BooleanMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Function<K,java.lang.Boolean>, Reference2BooleanFunction<K>, Reference2BooleanMap<K>, java.io.Serializable, java.util.Map<K,java.lang.Boolean>

Direct Known Subclasses:

Reference2BooleanSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2BooleanMaps
```
public static class Reference2BooleanMaps.UnmodifiableMap<K>
extends Reference2BooleanFunctions.UnmodifiableFunction<K>
implements Reference2BooleanMap<K>, java.io.Serializable
```
An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Reference2BooleanMap
  Reference2BooleanMap.Entry<K>, Reference2BooleanMap.FastEntrySet<K>

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(java.lang.Object k)` Returns true if this function contains a mapping for the specified key.
`boolean`	`containsValue(boolean v)`
`boolean`	`containsValue(java.lang.Object ov)`
`boolean`	`defaultReturnValue()` Gets the default return value.
`void`	`defaultReturnValue(boolean defRetValue)` Sets the default return value.
`ObjectSet<java.util.Map.Entry<K,java.lang.Boolean>>`	`entrySet()` Returns a set view of the mappings contained in this map.
`boolean`	`getBoolean(java.lang.Object k)` Returns the value to which the given key is mapped.
`boolean`	`isEmpty()`
`ReferenceSet<K>`	`keySet()` Returns a set view of the keys contained in this map.
`boolean`	`put(K k, boolean v)` Adds a pair to the map.
`void`	`putAll(java.util.Map<? extends K,? extends java.lang.Boolean> m)`
`ObjectSet<Reference2BooleanMap.Entry<K>>`	`reference2BooleanEntrySet()` Returns a type-specific set view of the mappings contained in this map.
`boolean`	`removeBoolean(java.lang.Object 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.
`java.lang.String`	`toString()`
`BooleanCollection`	`values()` Returns a set view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction
get, put, 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, put, remove

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, get, getOrDefault, hashCode, merge, put, 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<K,java.lang.Boolean>
    
    Specified by:
    
    size in interface java.util.Map<K,java.lang.Boolean>
    
    Overrides:
    
    size in class Reference2BooleanFunctions.UnmodifiableFunction<K>
    
    Returns:
    
    the intended number of keys in this function, or -1 if that number is not available.
  - 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.
    
    Specified by:
    
    containsKey in interface Function<K,java.lang.Boolean>
    
    Specified by:
    
    containsKey in interface java.util.Map<K,java.lang.Boolean>
    
    Overrides:
    
    containsKey in class Reference2BooleanFunctions.UnmodifiableFunction<K>
    
    Parameters:
    
    k - the key.
    
    Returns:
    
    true if this function associates a value to key.
    
    See Also:
    
    Map.containsKey(Object)
  - containsValue
```
public boolean containsValue(boolean v)
```
    Specified by:
    
    containsValue in interface Reference2BooleanMap<K>
    
    See Also:
    
    Map.containsValue(Object)
  - defaultReturnValue
```
public boolean defaultReturnValue()
```
    Description copied from interface: Reference2BooleanFunction
    
    Gets the default return value.
    
    Specified by:
    
    defaultReturnValue in interface Reference2BooleanFunction<K>
    
    Overrides:
    
    defaultReturnValue in class Reference2BooleanFunctions.UnmodifiableFunction<K>
    
    Returns:
    
    the current default return value.
  - defaultReturnValue
```
public void defaultReturnValue(boolean defRetValue)
```
    Description copied from interface: Reference2BooleanFunction
    
    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 Reference2BooleanFunction<K>
    
    Overrides:
    
    defaultReturnValue in class Reference2BooleanFunctions.UnmodifiableFunction<K>
    
    Parameters:
    
    defRetValue - the new default return value.
    
    See Also:
    
    Reference2BooleanFunction.defaultReturnValue()
  - put
```
public boolean put(K k,
                   boolean v)
```
    Description copied from interface: Reference2BooleanFunction
    
    Adds a pair to the map.
    
    Specified by:
    
    put in interface Reference2BooleanFunction<K>
    
    Overrides:
    
    put in class Reference2BooleanFunctions.UnmodifiableFunction<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)
  - putAll
```
public void putAll(java.util.Map<? extends K,? extends java.lang.Boolean> m)
```
    Specified by:
    
    putAll in interface java.util.Map<K,java.lang.Boolean>
  - reference2BooleanEntrySet
```
public ObjectSet<Reference2BooleanMap.Entry<K>> reference2BooleanEntrySet()
```
    Description copied from interface: Reference2BooleanMap
    
    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 Reference2BooleanMap.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:
    
    reference2BooleanEntrySet in interface Reference2BooleanMap<K>
    
    Returns:
    
    a type-specific set view of the mappings contained in this map.
    
    See Also:
    
    Reference2BooleanMap.entrySet()
  - keySet
```
public ReferenceSet<K> keySet()
```
    Description copied from interface: Reference2BooleanMap
    
    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 Reference2BooleanMap<K>
    
    Specified by:
    
    keySet in interface java.util.Map<K,java.lang.Boolean>
    
    Returns:
    
    a set view of the keys contained in this map.
    
    See Also:
    
    Map.keySet()
  - values
```
public BooleanCollection values()
```
    Description copied from interface: Reference2BooleanMap
    
    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 Reference2BooleanMap<K>
    
    Specified by:
    
    values in interface java.util.Map<K,java.lang.Boolean>
    
    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<K,java.lang.Boolean>
    
    Specified by:
    
    clear in interface java.util.Map<K,java.lang.Boolean>
    
    Overrides:
    
    clear in class Reference2BooleanFunctions.UnmodifiableFunction<K>
    
    See Also:
    
    Map.clear()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Reference2BooleanFunctions.UnmodifiableFunction<K>
  - containsValue
```
public boolean containsValue(java.lang.Object ov)
```
    Specified by:
    
    containsValue in interface java.util.Map<K,java.lang.Boolean>
  - removeBoolean
```
public boolean removeBoolean(java.lang.Object k)
```
    Description copied from interface: Reference2BooleanFunction
    
    Removes the mapping with the given key.
    
    Specified by:
    
    removeBoolean in interface Reference2BooleanFunction<K>
    
    Overrides:
    
    removeBoolean in class Reference2BooleanFunctions.UnmodifiableFunction<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)
  - getBoolean
```
public boolean getBoolean(java.lang.Object k)
```
    Description copied from interface: Reference2BooleanFunction
    
    Returns the value to which the given key is mapped.
    
    Specified by:
    
    getBoolean in interface Reference2BooleanFunction<K>
    
    Overrides:
    
    getBoolean in class Reference2BooleanFunctions.UnmodifiableFunction<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)
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<K,java.lang.Boolean>
  - entrySet
```
public ObjectSet<java.util.Map.Entry<K,java.lang.Boolean>> entrySet()
```
    Description copied from interface: Reference2BooleanMap
    
    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 Reference2BooleanMap<K>
    
    Specified by:
    
    entrySet in interface java.util.Map<K,java.lang.Boolean>
    
    Returns:
    
    a set view of the mappings contained in this map.
    
    See Also:
    
    Map.entrySet()

Class Reference2BooleanMaps.UnmodifiableMap<K>

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Reference2BooleanMap

Method Summary

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2BooleanFunction

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

reference2BooleanEntrySet

keySet

values

clear

toString

containsValue

removeBoolean

getBoolean

isEmpty

entrySet