Package it.unimi.dsi.fastutil.objects

Class Object2BooleanMaps.UnmodifiableMap<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2BooleanFunction<K>

it.unimi.dsi.fastutil.objects.Object2BooleanFunctions.UnmodifiableFunction<K>

it.unimi.dsi.fastutil.objects.Object2BooleanMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Function<K,Boolean>, Object2BooleanFunction<K>, Object2BooleanMap<K>, Serializable, Function<K,Boolean>, Predicate<K>, Map<K,Boolean>

Direct Known Subclasses:

Object2BooleanSortedMaps.UnmodifiableSortedMap

Enclosing class:

Object2BooleanMaps

public static class Object2BooleanMaps.UnmodifiableMap<K>
extends Object2BooleanFunctions.UnmodifiableFunction<K>
implements Object2BooleanMap<K>, 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.Object2BooleanMap

Object2BooleanMap.Entry<K>, Object2BooleanMap.FastEntrySet<K>

Method Summary

Modifier and Type	Method	Description
Boolean	compute(K key, BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)
boolean	computeBoolean(K key, BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)	Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
boolean	computeBooleanIfPresent(K key, BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)	If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
boolean	computeIfAbsent(K key, Object2BooleanFunction<? super K> mappingFunction)	If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map, unless the key is not present in the given mapping function.
Boolean	computeIfAbsent(K key, Function<? super K,? extends Boolean> mappingFunction)
boolean	computeIfAbsent(K key, Predicate<? super K> mappingFunction)	If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.
Boolean	computeIfPresent(K key, BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)
boolean	containsValue(boolean v)	Returns true if this map maps one or more keys to the specified value.
boolean	containsValue(Object ov)	Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Map.Entry<K,Boolean>>	entrySet()	Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super Boolean> action)
boolean	getOrDefault(Object key, boolean defaultValue)	Returns the value associated by this function to the specified key, or give the specified value if not present.
Boolean	getOrDefault(Object key, Boolean defaultValue)	Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
ObjectSet<K>	keySet()
boolean	merge(K key, boolean value, BiFunction<? super Boolean,? super Boolean,? extends Boolean> remappingFunction)	If the specified key is not already associated with a value, associates it with the given value.
Boolean	merge(K key, Boolean value, BiFunction<? super Boolean,? super Boolean,? extends Boolean> remappingFunction)	Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Object2BooleanMap.Entry<K>>	object2BooleanEntrySet()	Returns a type-specific set view of the mappings contained in this map.
void	putAll(Map<? extends K,? extends Boolean> m)
boolean	putIfAbsent(K key, boolean value)	If the specified key is not already associated with a value, associates it with the given value and returns the default return value, else returns the current value.
Boolean	putIfAbsent(K key, Boolean value)	Deprecated. Please use the corresponding type-specific method instead.
boolean	remove(Object key, boolean value)	Removes the entry for the specified key only if it is currently mapped to the specified value.
boolean	remove(Object key, Object value)	Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, boolean value)	Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(K key, boolean oldValue, boolean newValue)	Replaces the entry for the specified key only if currently mapped to the specified value.
Boolean	replace(K key, Boolean value)	Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, Boolean oldValue, Boolean newValue)	Deprecated. Please use the corresponding type-specific method instead.
void	replaceAll(BiFunction<? super K,? super Boolean,? extends Boolean> function)
BooleanCollection	values()

Methods inherited from class it.unimi.dsi.fastutil.objects.Object2BooleanFunctions.UnmodifiableFunction

clear, containsKey, defaultReturnValue, defaultReturnValue, get, getBoolean, put, put, remove, removeBoolean, size, 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.Object2BooleanFunction

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

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

clear, computeBooleanIfAbsent, computeBooleanIfAbsentPartial, containsKey, defaultReturnValue, defaultReturnValue, get, mergeBoolean, put, remove, size

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Details

containsValue

public boolean containsValue(boolean v)

Description copied from interface: Object2BooleanMap

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Object2BooleanMap<K>

See Also:

Map.containsValue(Object)

containsValue

@Deprecated
public boolean containsValue(Object ov)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

containsValue in interface Map<K,Boolean>

Specified by:

containsValue in interface Object2BooleanMap<K>

putAll

public void putAll(Map<? extends K,? extends Boolean> m)

Specified by:

putAll in interface Map<K,Boolean>

object2BooleanEntrySet

public ObjectSet<Object2BooleanMap.Entry<K>> object2BooleanEntrySet()

Description copied from interface: Object2BooleanMap

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 Map.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:

object2BooleanEntrySet in interface Object2BooleanMap<K>

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

Map.entrySet()

entrySet

@Deprecated
public ObjectSet<Map.Entry<K,Boolean>> entrySet()

Deprecated.

Please use the corresponding type-specific method instead.

Returns a set view of the mappings contained in this map.

Specified by:

entrySet in interface Map<K,Boolean>

Specified by:

entrySet in interface Object2BooleanMap<K>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public ObjectSet<K> keySet()

Description copied from interface: Object2BooleanMap

Specified by:

keySet in interface Map<K,Boolean>

Specified by:

keySet in interface Object2BooleanMap<K>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public BooleanCollection values()

Description copied from interface: Object2BooleanMap

Specified by:

values in interface Map<K,Boolean>

Specified by:

values in interface Object2BooleanMap<K>

Returns:

a set view of the values contained in this map.

See Also:

Map.values()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Boolean>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,Boolean>

Overrides:

hashCode in class Object2BooleanFunctions.UnmodifiableFunction<K>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,Boolean>

Overrides:

equals in class Object2BooleanFunctions.UnmodifiableFunction<K>

getOrDefault

public boolean getOrDefault(Object key,
boolean defaultValue)

Description copied from interface: Object2BooleanFunction

Returns the value associated by this function to the specified key, or give the specified value if not present.

Specified by:

getOrDefault in interface Object2BooleanFunction<K>

Specified by:

getOrDefault in interface Object2BooleanMap<K>

Overrides:

getOrDefault in class Object2BooleanFunctions.UnmodifiableFunction<K>

Parameters:

key - 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)

forEach

public void forEach(BiConsumer<? super K,? super Boolean> action)

Specified by:

forEach in interface Map<K,Boolean>

Specified by:

forEach in interface Object2BooleanMap<K>

replaceAll

public void replaceAll(BiFunction<? super K,? super Boolean,? extends Boolean> function)

Specified by:

replaceAll in interface Map<K,Boolean>

putIfAbsent

public boolean putIfAbsent(K key,
boolean value)

Description copied from interface: Object2BooleanMap

If the specified key is not already associated with a value, associates it with the given value and returns the default return value, else returns the current value.

Specified by:

putIfAbsent in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

Returns:

the previous value associated with the specified key, or the default return value if there was no mapping for the key.

See Also:

Map.putIfAbsent(Object, Object)

remove

public boolean remove(Object key,
boolean value)

Description copied from interface: Object2BooleanMap

Removes the entry for the specified key only if it is currently mapped to the specified value.

Specified by:

remove in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is associated.

value - value expected to be associated with the specified key.

Returns:

true if the value was removed.

See Also:

Map.remove(Object, Object)

replace

public boolean replace(K key,
boolean value)

Description copied from interface: Object2BooleanMap

Replaces the entry for the specified key only if it is currently mapped to some value.

Specified by:

replace in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is associated.

value - value to be associated with the specified key.

Returns:

the previous value associated with the specified key, or the default return value if there was no mapping for the key.

See Also:

Map.replace(Object, Object)

replace

public boolean replace(K key,
boolean oldValue,
boolean newValue)

Description copied from interface: Object2BooleanMap

Replaces the entry for the specified key only if currently mapped to the specified value.

Specified by:

replace in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is associated.

oldValue - value expected to be associated with the specified key.

newValue - value to be associated with the specified key.

Returns:

true if the value was replaced.

See Also:

Map.replace(Object, Object, Object)

computeIfAbsent

public boolean computeIfAbsent(K key,
Predicate<? super K> mappingFunction)

Description copied from interface: Object2BooleanMap

If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.

Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the mappingFunction cannot return null. If such a behavior is needed, please use the corresponding nullable version.

Specified by:

computeIfAbsent in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is to be associated.

mappingFunction - the function to compute a value.

Returns:

the current (existing or computed) value associated with the specified key.

See Also:

Map.computeIfAbsent(Object, java.util.function.Function)

computeIfAbsent

public boolean computeIfAbsent(K key,
Object2BooleanFunction<? super K> mappingFunction)

Description copied from interface: Object2BooleanMap

If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map, unless the key is not present in the given mapping function.

This version of computeIfAbsent() uses a type-specific version of fastutil's Function. Since Function has a containsKey() method, it is possible to avoid adding a key by having containsKey() return false for that key.

Specified by:

computeIfAbsent in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is to be associated.

mappingFunction - the function to compute a value.

Returns:

the current (existing or computed) value associated with the specified key.

See Also:

Map.computeIfAbsent(Object, java.util.function.Function)

computeBooleanIfPresent

public boolean computeBooleanIfPresent(K key,
BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)

Description copied from interface: Object2BooleanMap

If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.

Specified by:

computeBooleanIfPresent in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is to be associated.

remappingFunction - the function to compute a value.

Returns:

the new value associated with the specified key, or the default return value if none.

See Also:

Map.computeIfPresent(Object, java.util.function.BiFunction)

computeBoolean

public boolean computeBoolean(K key,
BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)

Description copied from interface: Object2BooleanMap

Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).

If the function returns null, the mapping is removed (or remains absent if initially absent). If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.

Specified by:

computeBoolean in interface Object2BooleanMap<K>

Parameters:

key - key with which the specified value is to be associated.

remappingFunction - the function to compute a value.

Returns:

the new value associated with the specified key, or the default return value if none.

See Also:

Map.compute(Object, java.util.function.BiFunction)

merge

public boolean merge(K key,
boolean value,
BiFunction<? super Boolean,? super Boolean,? extends Boolean> remappingFunction)

Description copied from interface: Object2BooleanMap

If the specified key is not already associated with a value, associates it with the given value. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null.

Specified by:

merge in interface Object2BooleanMap<K>

Parameters:

key - key with which the resulting value is to be associated.

value - the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.

remappingFunction - the function to recompute a value if present.

Returns:

the new value associated with the specified key, or the default return value if no value is associated with the key.

See Also:

Map.merge(Object, Object, java.util.function.BiFunction)

getOrDefault

@Deprecated
public Boolean getOrDefault(Object key,
Boolean 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,Boolean>

Specified by:

getOrDefault in interface Map<K,Boolean>

Specified by:

getOrDefault in interface Object2BooleanFunction<K>

Specified by:

getOrDefault in interface Object2BooleanMap<K>

Overrides:

getOrDefault in class Object2BooleanFunctions.UnmodifiableFunction<K>

Parameters:

key - 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 boolean remove(Object key,
Object value)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

remove in interface Map<K,Boolean>

Specified by:

remove in interface Object2BooleanMap<K>

replace

@Deprecated
public Boolean replace(K key,
Boolean value)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

replace in interface Map<K,Boolean>

Specified by:

replace in interface Object2BooleanMap<K>

replace

@Deprecated
public boolean replace(K key,
Boolean oldValue,
Boolean newValue)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

replace in interface Map<K,Boolean>

Specified by:

replace in interface Object2BooleanMap<K>

putIfAbsent

@Deprecated
public Boolean putIfAbsent(K key,
Boolean value)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

putIfAbsent in interface Map<K,Boolean>

Specified by:

putIfAbsent in interface Object2BooleanMap<K>

computeIfAbsent

public Boolean computeIfAbsent(K key,
Function<? super K,? extends Boolean> mappingFunction)

Specified by:

computeIfAbsent in interface Map<K,Boolean>

computeIfPresent

public Boolean computeIfPresent(K key,
BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)

Specified by:

computeIfPresent in interface Map<K,Boolean>

compute

public Boolean compute(K key,
BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)

Specified by:

compute in interface Map<K,Boolean>

merge

@Deprecated
public Boolean merge(K key,
Boolean value,
BiFunction<? super Boolean,? super Boolean,? extends Boolean> remappingFunction)

Deprecated.

Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

merge in interface Map<K,Boolean>

Specified by:

merge in interface Object2BooleanMap<K>