Interface Int2BooleanMap
-
- All Superinterfaces:
Function<java.lang.Integer,java.lang.Boolean>
,java.util.function.Function<java.lang.Integer,java.lang.Boolean>
,Int2BooleanFunction
,java.util.function.IntPredicate
,java.util.Map<java.lang.Integer,java.lang.Boolean>
- All Known Subinterfaces:
Int2BooleanSortedMap
- All Known Implementing Classes:
AbstractInt2BooleanMap
,AbstractInt2BooleanSortedMap
,Int2BooleanArrayMap
,Int2BooleanAVLTreeMap
,Int2BooleanLinkedOpenHashMap
,Int2BooleanMaps.EmptyMap
,Int2BooleanMaps.Singleton
,Int2BooleanMaps.SynchronizedMap
,Int2BooleanMaps.UnmodifiableMap
,Int2BooleanOpenCustomHashMap
,Int2BooleanOpenHashMap
,Int2BooleanRBTreeMap
,Int2BooleanSortedMaps.EmptySortedMap
,Int2BooleanSortedMaps.Singleton
,Int2BooleanSortedMaps.SynchronizedSortedMap
,Int2BooleanSortedMaps.UnmodifiableSortedMap
public interface Int2BooleanMap extends Int2BooleanFunction, java.util.Map<java.lang.Integer,java.lang.Boolean>
A type-specificMap
; provides some additional methods that use polymorphism to avoid (un)boxing, and handling of a default return value.Besides extending the corresponding type-specific function, this interface strengthens
Map.entrySet()
,keySet()
andvalues()
. Moreover, a number of methods, such assize()
,defaultReturnValue()
, etc., are un-defaulted as their function default do not make sense for a map. Maps returning entry sets of typeInt2BooleanMap.FastEntrySet
support also fast iteration.A submap or subset may or may not have an independent default return value (which however must be initialized to the default return value of the originator).
- See Also:
Map
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Int2BooleanMap.Entry
A type-specificMap.Entry
; provides some additional methods that use polymorphism to avoid (un)boxing.static interface
Int2BooleanMap.FastEntrySet
An entry set providing fast iteration.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default void
clear()
Removes all of the mappings from this map (optional operation).default boolean
compute(int key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).default java.lang.Boolean
compute(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.default boolean
computeIfAbsent(int key, java.util.function.IntPredicate 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.default java.lang.Boolean
computeIfAbsent(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,? extends java.lang.Boolean> mappingFunction)
Deprecated.Please use the corresponding type-specific method instead.default boolean
computeIfAbsentNullable(int key, java.util.function.IntFunction<? extends java.lang.Boolean> 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 it isnull
.default boolean
computeIfAbsentPartial(int key, Int2BooleanFunction 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.default boolean
computeIfPresent(int key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.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.default java.lang.Boolean
computeIfPresent(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.boolean
containsKey(int key)
Returns true if this function contains a mapping for the specified key.default boolean
containsKey(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.boolean
containsValue(boolean value)
Returnstrue
if this map maps one or more keys to the specified value.default boolean
containsValue(java.lang.Object value)
Deprecated.Please use the corresponding type-specific method instead.boolean
defaultReturnValue()
Gets the default return value.void
defaultReturnValue(boolean rv)
Sets the default return value (optional operation).default ObjectSet<java.util.Map.Entry<java.lang.Integer,java.lang.Boolean>>
entrySet()
Deprecated.Please use the corresponding type-specific method instead.default java.lang.Boolean
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default boolean
getOrDefault(int key, boolean defaultValue)
Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.default java.lang.Boolean
getOrDefault(java.lang.Object key, java.lang.Boolean defaultValue)
Deprecated.Please use the corresponding type-specific method instead.ObjectSet<Int2BooleanMap.Entry>
int2BooleanEntrySet()
Returns a type-specific set view of the mappings contained in this map.IntSet
keySet()
default boolean
merge(int key, boolean value, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
.default java.lang.Boolean
merge(java.lang.Integer key, java.lang.Boolean value, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.default java.lang.Boolean
put(java.lang.Integer key, java.lang.Boolean value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
putIfAbsent(int 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.default java.lang.Boolean
putIfAbsent(java.lang.Integer key, java.lang.Boolean value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(int key, boolean value)
Removes the entry for the specified key only if it is currently mapped to the specified value.default java.lang.Boolean
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(java.lang.Object key, java.lang.Object value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
replace(int key, boolean value)
Replaces the entry for the specified key only if it is currently mapped to some value.default boolean
replace(int key, boolean oldValue, boolean newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.default java.lang.Boolean
replace(java.lang.Integer key, java.lang.Boolean value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
replace(java.lang.Integer key, java.lang.Boolean oldValue, java.lang.Boolean newValue)
Deprecated.Please use the corresponding type-specific method instead.int
size()
Returns the number of key/value mappings in this map.BooleanCollection
values()
-
Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2BooleanFunction
get, put, remove, test
-
-
-
-
Method Detail
-
size
int size()
Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.
-
clear
default void clear()
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
-
defaultReturnValue
void defaultReturnValue(boolean rv)
Sets the default return value (optional operation). This value must be returned by type-specific versions ofget()
,put()
andremove()
to denote that the map does not contain the specified key. It must be 0/false
by default.- Specified by:
defaultReturnValue
in interfaceInt2BooleanFunction
- Parameters:
rv
- the new default return value.- See Also:
defaultReturnValue()
-
defaultReturnValue
boolean defaultReturnValue()
Gets the default return value.- Specified by:
defaultReturnValue
in interfaceInt2BooleanFunction
- Returns:
- the current default return value.
-
int2BooleanEntrySet
ObjectSet<Int2BooleanMap.Entry> int2BooleanEntrySet()
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 anObjectSet
of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
Map.entrySet()
-
entrySet
@Deprecated default ObjectSet<java.util.Map.Entry<java.lang.Integer,java.lang.Boolean>> entrySet()
Deprecated.Please use the corresponding type-specific method instead.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 interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
- Returns:
- a set view of the mappings contained in this map.
- See Also:
Map.entrySet()
-
put
@Deprecated default java.lang.Boolean put(java.lang.Integer key, java.lang.Boolean value)
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
put
in interfaceFunction<java.lang.Integer,java.lang.Boolean>
- Specified by:
put
in interfaceInt2BooleanFunction
- Specified by:
put
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
- Parameters:
key
- the key.value
- 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 default java.lang.Boolean get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
get
in interfaceFunction<java.lang.Integer,java.lang.Boolean>
- Specified by:
get
in interfaceInt2BooleanFunction
- Specified by:
get
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
- Parameters:
key
- the key.- Returns:
- the corresponding value, or
null
if no value was present for the given key. - See Also:
Map.get(Object)
-
remove
@Deprecated default java.lang.Boolean remove(java.lang.Object key)
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).This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
remove
in interfaceFunction<java.lang.Integer,java.lang.Boolean>
- Specified by:
remove
in interfaceInt2BooleanFunction
- Specified by:
remove
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
- Parameters:
key
- the key.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.remove(Object)
-
keySet
IntSet keySet()
Note that this specification strengthens the one given in
Map.keySet()
.- Specified by:
keySet
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
- Returns:
- a set view of the keys contained in this map.
- See Also:
Map.keySet()
-
values
BooleanCollection values()
Note that this specification strengthens the one given in
Map.values()
.- Specified by:
values
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
- Returns:
- a set view of the values contained in this map.
- See Also:
Map.values()
-
containsKey
boolean containsKey(int key)
Returns true if this function contains a mapping for the specified key.- Specified by:
containsKey
in interfaceInt2BooleanFunction
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
containsKey
@Deprecated default boolean containsKey(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns true if this function contains a mapping for the specified key.This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
containsKey
in interfaceFunction<java.lang.Integer,java.lang.Boolean>
- Specified by:
containsKey
in interfaceInt2BooleanFunction
- Specified by:
containsKey
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
containsValue
boolean containsValue(boolean value)
Returnstrue
if this map maps one or more keys to the specified value.- See Also:
Map.containsValue(Object)
-
containsValue
@Deprecated default boolean containsValue(java.lang.Object value)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
containsValue
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
getOrDefault
default boolean getOrDefault(int key, boolean defaultValue)
Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.- Parameters:
key
- the key.defaultValue
- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or the
defaultValue
if this map contains no mapping for the key. - Since:
- 8.0.0
- See Also:
Map.getOrDefault(Object, Object)
-
putIfAbsent
default boolean putIfAbsent(int 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.- 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.
- Since:
- 8.0.0
- See Also:
Map.putIfAbsent(Object, Object)
-
remove
default boolean remove(int key, boolean value)
Removes the entry for the specified key only if it is currently mapped to the specified value.- 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.- Since:
- 8.0.0
- See Also:
Map.remove(Object, Object)
-
replace
default boolean replace(int key, boolean oldValue, boolean newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.- 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.- Since:
- 8.0.0
- See Also:
Map.replace(Object, Object, Object)
-
replace
default boolean replace(int key, boolean value)
Replaces the entry for the specified key only if it is currently mapped to some value.- 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.
- Since:
- 8.0.0
- See Also:
Map.replace(Object, Object)
-
computeIfAbsent
default boolean computeIfAbsent(int key, java.util.function.IntPredicate 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.Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the
mappingFunction
cannot returnnull
. If such a behavior is needed, please use the corresponding nullable version.- 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.
- Since:
- 8.0.0
- See Also:
Map.computeIfAbsent(Object, java.util.function.Function)
-
computeIfAbsentNullable
default boolean computeIfAbsentNullable(int key, java.util.function.IntFunction<? extends java.lang.Boolean> 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 it isnull
.Note that this version of computeIfAbsent() should be used only if you plan to return
null
in the mapping function.- 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,
or the default return value if the computed value is
null
. - Since:
- 8.0.0
- See Also:
Map.computeIfAbsent(Object, java.util.function.Function)
-
computeIfAbsentPartial
default boolean computeIfAbsentPartial(int key, Int2BooleanFunction 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.This version of computeIfAbsent() uses a type-specific version of
fastutil
'sFunction
. SinceFunction
has acontainsKey()
method, it is possible to avoid adding a key by havingcontainsKey()
returnfalse
for that key.- 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.
- Since:
- 8.0.0
- See Also:
Map.computeIfAbsent(Object, java.util.function.Function)
-
computeIfPresent
default boolean computeIfPresent(int key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.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.- 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.
- Since:
- 8.0.0
- See Also:
Map.computeIfPresent(Object, java.util.function.BiFunction)
-
compute
default boolean compute(int key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
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.- 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.
- Since:
- 8.0.0
- See Also:
Map.compute(Object, java.util.function.BiFunction)
-
merge
default boolean merge(int key, boolean value, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result isnull
.- 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.
- Since:
- 8.0.0
- See Also:
Map.merge(Object, Object, java.util.function.BiFunction)
-
getOrDefault
@Deprecated default java.lang.Boolean getOrDefault(java.lang.Object key, java.lang.Boolean defaultValue)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
getOrDefault
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
putIfAbsent
@Deprecated default java.lang.Boolean putIfAbsent(java.lang.Integer key, java.lang.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 interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
remove
@Deprecated default boolean remove(java.lang.Object key, java.lang.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 interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
replace
@Deprecated default boolean replace(java.lang.Integer key, java.lang.Boolean oldValue, java.lang.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 interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
replace
@Deprecated default java.lang.Boolean replace(java.lang.Integer key, java.lang.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 interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
computeIfAbsent
@Deprecated default java.lang.Boolean computeIfAbsent(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,? extends java.lang.Boolean> mappingFunction)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
computeIfAbsent
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
computeIfPresent
@Deprecated default java.lang.Boolean computeIfPresent(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
computeIfPresent
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
compute
@Deprecated default java.lang.Boolean compute(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
compute
in interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
merge
@Deprecated default java.lang.Boolean merge(java.lang.Integer key, java.lang.Boolean value, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.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 interfacejava.util.Map<java.lang.Integer,java.lang.Boolean>
-
-