Interface Short2BooleanMap
- All Superinterfaces:
it.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>,java.util.function.Function<java.lang.Short,java.lang.Boolean>,java.util.function.IntPredicate,java.util.Map<java.lang.Short,java.lang.Boolean>,Short2BooleanFunction
- All Known Subinterfaces:
Short2BooleanSortedMap
- All Known Implementing Classes:
AbstractShort2BooleanMap,AbstractShort2BooleanSortedMap,Short2BooleanArrayMap,Short2BooleanAVLTreeMap,Short2BooleanLinkedOpenHashMap,Short2BooleanMaps.EmptyMap,Short2BooleanMaps.Singleton,Short2BooleanMaps.SynchronizedMap,Short2BooleanMaps.UnmodifiableMap,Short2BooleanOpenCustomHashMap,Short2BooleanOpenHashMap,Short2BooleanRBTreeMap,Short2BooleanSortedMaps.EmptySortedMap,Short2BooleanSortedMaps.Singleton,Short2BooleanSortedMaps.SynchronizedSortedMap,Short2BooleanSortedMaps.UnmodifiableSortedMap
public interface Short2BooleanMap extends Short2BooleanFunction, java.util.Map<java.lang.Short,java.lang.Boolean>
Map; 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() and values(). Moreover, a number of methods, such as size(), defaultReturnValue(), etc., are un-defaulted
as their function default do not make sense for a map.
Maps returning entry sets of type Short2BooleanMap.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 interfaceShort2BooleanMap.EntryA type-specificMap.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.static interfaceShort2BooleanMap.FastEntrySetAn entry set providing fast iteration. -
Method Summary
Modifier and Type Method Description default voidclear()Removes all of the mappings from this map (optional operation).default booleancompute(short key, java.util.function.BiFunction<? super java.lang.Short,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)Attempts to compute a mapping for the specified key and its current mapped value (ornullif there is no current mapping).default java.lang.Booleancompute(java.lang.Short key, java.util.function.BiFunction<? super java.lang.Short,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)Deprecated.Please use the corresponding type-specific method instead.default booleancomputeIfAbsent(short key, Short2BooleanFunction 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 booleancomputeIfAbsent(short 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.BooleancomputeIfAbsent(java.lang.Short key, java.util.function.Function<? super java.lang.Short,? extends java.lang.Boolean> mappingFunction)Deprecated.Please use the corresponding type-specific method instead.default booleancomputeIfAbsentNullable(short 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 booleancomputeIfAbsentPartial(short key, Short2BooleanFunction mappingFunction)Deprecated.Please usecomputeIfAbsent()instead.default booleancomputeIfPresent(short key, java.util.function.BiFunction<? super java.lang.Short,? 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.BooleancomputeIfPresent(java.lang.Short key, java.util.function.BiFunction<? super java.lang.Short,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)Deprecated.Please use the corresponding type-specific method instead.booleancontainsKey(short key)Returns true if this function contains a mapping for the specified key.default booleancontainsKey(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.booleancontainsValue(boolean value)Returnstrueif this map maps one or more keys to the specified value.default booleancontainsValue(java.lang.Object value)Deprecated.Please use the corresponding type-specific method instead.booleandefaultReturnValue()Gets the default return value.voiddefaultReturnValue(boolean rv)Sets the default return value (optional operation).default it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<java.lang.Short,java.lang.Boolean>>entrySet()Deprecated.Please use the corresponding type-specific method instead.default voidforEach(java.util.function.BiConsumer<? super java.lang.Short,? super java.lang.Boolean> consumer)default java.lang.Booleanget(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default booleangetOrDefault(short key, boolean defaultValue)Returns the value to which the specified key is mapped, or thedefaultValueif this map contains no mapping for the key.default java.lang.BooleangetOrDefault(java.lang.Object key, java.lang.Boolean defaultValue)Deprecated.Please use the corresponding type-specific method instead.ShortSetkeySet()default booleanmerge(short 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.Booleanmerge(java.lang.Short 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.Booleanput(java.lang.Short key, java.lang.Boolean value)Deprecated.Please use the corresponding type-specific method instead.default booleanputIfAbsent(short 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.BooleanputIfAbsent(java.lang.Short key, java.lang.Boolean value)Deprecated.Please use the corresponding type-specific method instead.default booleanremove(short key, boolean value)Removes the entry for the specified key only if it is currently mapped to the specified value.default java.lang.Booleanremove(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.default booleanremove(java.lang.Object key, java.lang.Object value)Deprecated.Please use the corresponding type-specific method instead.default booleanreplace(short key, boolean value)Replaces the entry for the specified key only if it is currently mapped to some value.default booleanreplace(short key, boolean oldValue, boolean newValue)Replaces the entry for the specified key only if currently mapped to the specified value.default java.lang.Booleanreplace(java.lang.Short key, java.lang.Boolean value)Deprecated.Please use the corresponding type-specific method instead.default booleanreplace(java.lang.Short key, java.lang.Boolean oldValue, java.lang.Boolean newValue)Deprecated.Please use the corresponding type-specific method instead.it.unimi.dsi.fastutil.objects.ObjectSet<Short2BooleanMap.Entry>short2BooleanEntrySet()Returns a type-specific set view of the mappings contained in this map.intsize()Returns the number of key/value mappings in this map.BooleanCollectionvalues()Methods inherited from interface it.unimi.dsi.fastutil.Function
applyMethods inherited from interface java.util.function.IntPredicate
and, negate, orMethods inherited from interface java.util.Map
equals, hashCode, isEmpty, putAll, replaceAllMethods inherited from interface it.unimi.dsi.fastutil.shorts.Short2BooleanFunction
andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, get, put, remove, test
-
Method Details
-
size
int size()Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUEelements, returnsInteger.MAX_VALUE.- Specified by:
sizein interfaceit.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>- Specified by:
sizein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Returns:
- the number of key-value mappings in this map.
- See Also:
Size64
-
clear
default void clear()Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.- Specified by:
clearin interfaceit.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>- Specified by:
clearin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Throws:
java.lang.UnsupportedOperationException- if theclear()operation is not supported by this map
-
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/falseby default.- Specified by:
defaultReturnValuein interfaceShort2BooleanFunction- Parameters:
rv- the new default return value.- See Also:
defaultReturnValue()
-
defaultReturnValue
boolean defaultReturnValue()Gets the default return value.- Specified by:
defaultReturnValuein interfaceShort2BooleanFunction- Returns:
- the current default return value.
-
short2BooleanEntrySet
it.unimi.dsi.fastutil.objects.ObjectSet<Short2BooleanMap.Entry> short2BooleanEntrySet()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 anObjectSetof 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 it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<java.lang.Short,java.lang.Boolean>> entrySet()Deprecated.Please use the corresponding type-specific method instead.Returns a set view of the mappings contained in this map.- Specified by:
entrySetin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Returns:
- a set view of the mappings contained in this map.
- See Also:
Map.entrySet()- API Notes:
- Note that this specification strengthens the one given in
Map.entrySet().
-
put
@Deprecated default java.lang.Boolean put(java.lang.Short key, java.lang.Boolean value)Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
putin interfaceit.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>- Specified by:
putin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Specified by:
putin interfaceShort2BooleanFunction
-
get
@Deprecated default java.lang.Boolean get(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
getin interfaceit.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>- Specified by:
getin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Specified by:
getin interfaceShort2BooleanFunction
-
remove
@Deprecated default java.lang.Boolean remove(java.lang.Object key)Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
removein interfaceit.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>- Specified by:
removein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Specified by:
removein interfaceShort2BooleanFunction
-
keySet
ShortSet keySet()- Specified by:
keySetin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Returns:
- a set view of the keys contained in this map.
- See Also:
Map.keySet()- API Notes:
- Note that this specification strengthens the one given in
Map.keySet().
-
values
BooleanCollection values()- Specified by:
valuesin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Returns:
- a set view of the values contained in this map.
- See Also:
Map.values()- API Notes:
- Note that this specification strengthens the one given in
Map.values().
-
containsKey
boolean containsKey(short key)Returns true if this function contains a mapping for the specified key.- Specified by:
containsKeyin interfaceShort2BooleanFunction- 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:
containsKeyin interfaceit.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>- Specified by:
containsKeyin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Specified by:
containsKeyin interfaceShort2BooleanFunction
-
containsValue
boolean containsValue(boolean value)Returnstrueif 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:
containsValuein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
forEach
default void forEach(java.util.function.BiConsumer<? super java.lang.Short,? super java.lang.Boolean> consumer)- Specified by:
forEachin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
getOrDefault
default boolean getOrDefault(short key, boolean defaultValue)Returns the value to which the specified key is mapped, or thedefaultValueif this map contains no mapping for the key.- Specified by:
getOrDefaultin interfaceShort2BooleanFunction- Parameters:
key- the key.defaultValue- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or the
defaultValueif this map contains no mapping for the key. - Since:
- 8.0.0
- See Also:
Map.getOrDefault(Object, Object)
-
putIfAbsent
default boolean putIfAbsent(short 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(short 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:
trueif the value was removed.- Since:
- 8.0.0
- See Also:
Map.remove(Object, Object)
-
replace
default boolean replace(short 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:
trueif the value was replaced.- Since:
- 8.0.0
- See Also:
Map.replace(Object, Object, Object)
-
replace
default boolean replace(short 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(short 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
mappingFunctioncannot 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)- API Notes:
- all
computeIfAbsent()methods have a different logic based on the argument; no delegation is performed, contrarily to other superficially similar methods such asIterator.forEachRemaining(java.util.function.Consumer<? super E>)orList.replaceAll(java.util.function.UnaryOperator<E>).
-
computeIfAbsentNullable
default boolean computeIfAbsentNullable(short 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
nullin 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)
-
computeIfAbsent
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. SinceFunctionhas acontainsKey()method, it is possible to avoid adding a key by havingcontainsKey()returnfalsefor 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)- API Notes:
- all
computeIfAbsent()methods have a different logic based on the argument; no delegation is performed, contrarily to other superficially similar methods such asIterator.forEachRemaining(java.util.function.Consumer<? super E>)orList.replaceAll(java.util.function.UnaryOperator<E>).
-
computeIfAbsentPartial
@Deprecated default boolean computeIfAbsentPartial(short key, Short2BooleanFunction mappingFunction)Deprecated.Please usecomputeIfAbsent()instead. -
computeIfPresent
default boolean computeIfPresent(short key, java.util.function.BiFunction<? super java.lang.Short,? 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(short key, java.util.function.BiFunction<? super java.lang.Short,? super java.lang.Boolean,? extends java.lang.Boolean> remappingFunction)Attempts to compute a mapping for the specified key and its current mapped value (ornullif 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(short 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)- API Notes:
- The JDK specification for this method equates not being associated with a value with being associated with {code null}. This is not the case for this method.
-
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
Mapmethod.- Specified by:
getOrDefaultin interfaceit.unimi.dsi.fastutil.Function<java.lang.Short,java.lang.Boolean>- Specified by:
getOrDefaultin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>- Specified by:
getOrDefaultin interfaceShort2BooleanFunction
-
putIfAbsent
@Deprecated default java.lang.Boolean putIfAbsent(java.lang.Short key, java.lang.Boolean value)Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod.- Specified by:
putIfAbsentin interfacejava.util.Map<java.lang.Short,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
Mapmethod.- Specified by:
removein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
replace
@Deprecated default boolean replace(java.lang.Short 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
Mapmethod.- Specified by:
replacein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
replace
@Deprecated default java.lang.Boolean replace(java.lang.Short key, java.lang.Boolean value)Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod.- Specified by:
replacein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
computeIfAbsent
@Deprecated default java.lang.Boolean computeIfAbsent(java.lang.Short key, java.util.function.Function<? super java.lang.Short,? extends java.lang.Boolean> mappingFunction)Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod.- Specified by:
computeIfAbsentin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
computeIfPresent
@Deprecated default java.lang.Boolean computeIfPresent(java.lang.Short key, java.util.function.BiFunction<? super java.lang.Short,? 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
Mapmethod.- Specified by:
computeIfPresentin interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
compute
@Deprecated default java.lang.Boolean compute(java.lang.Short key, java.util.function.BiFunction<? super java.lang.Short,? 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
Mapmethod.- Specified by:
computein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-
merge
@Deprecated default java.lang.Boolean merge(java.lang.Short 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
Mapmethod.- Specified by:
mergein interfacejava.util.Map<java.lang.Short,java.lang.Boolean>
-