public class Object2BooleanOpenHashMap<K> extends AbstractObject2BooleanMap<K> implements Serializable, Cloneable, Hash
Instances of this class use a hash table to represent a map. The table is filled up to a specified load factor, and then doubled in size to accommodate new entries. If the table is emptied below one fourth of the load factor, it is halved in size; however, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create maps with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would interfere with the iteration process.
Note that clear() does not modify the hash table size.
Rather, a family of trimming
methods lets you control the size of the table; this is particularly useful
if you reuse instances of this class.
Hash,
HashCommon,
Serialized FormAbstractObject2BooleanMap.BasicEntry<K>, AbstractObject2BooleanMap.BasicEntrySet<K>Hash.Strategy<K>Object2BooleanMap.Entry<K>, Object2BooleanMap.FastEntrySet<K>DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR| Constructor and Description |
|---|
Object2BooleanOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2BooleanOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Object2BooleanOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Object2BooleanOpenHashMap(K[] k,
boolean[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Object2BooleanOpenHashMap(K[] k,
boolean[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Object2BooleanOpenHashMap(Map<? extends K,? extends Boolean> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Object2BooleanOpenHashMap(Map<? extends K,? extends Boolean> m,
float f)
Creates a new hash map copying a given one.
|
Object2BooleanOpenHashMap(Object2BooleanMap<K> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Object2BooleanOpenHashMap(Object2BooleanMap<K> m,
float f)
Creates a new hash map copying a given type-specific one.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Removes all of the mappings from this map (optional operation).
|
Object2BooleanOpenHashMap<K> |
clone()
Returns a deep copy of this map.
|
boolean |
computeBoolean(K k,
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 |
computeBooleanIfAbsent(K k,
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 |
computeBooleanIfPresent(K k,
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 |
containsKey(Object k)
Returns true if this function contains a mapping for the specified key.
|
boolean |
containsValue(boolean v)
Returns
true if this map maps one or more keys to the specified value. |
boolean |
getBoolean(Object k)
Returns the value to which the given key is mapped.
|
boolean |
getOrDefault(Object k,
boolean defaultValue)
Returns the value to which the specified key is mapped, or the
defaultValue if this
map contains no mapping for the key. |
int |
hashCode()
Returns a hash code for this map.
|
boolean |
isEmpty() |
ObjectSet<K> |
keySet()
Returns a type-specific-set view of the keys of this map.
|
boolean |
mergeBoolean(K k,
boolean v,
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. |
Object2BooleanMap.FastEntrySet<K> |
object2BooleanEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
boolean |
put(K k,
boolean v)
Adds a pair to the map (optional operation).
|
void |
putAll(Map<? extends K,? extends Boolean> m) |
boolean |
putIfAbsent(K k,
boolean v)
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 |
remove(Object k,
boolean v)
Removes the entry for the specified key only if it is currently mapped to the specified value.
|
boolean |
removeBoolean(Object k)
Removes the mapping with the given key (optional operation).
|
boolean |
replace(K k,
boolean v)
Replaces the entry for the specified key only if it is currently mapped to some value.
|
boolean |
replace(K k,
boolean oldValue,
boolean v)
Replaces the entry for the specified key only if currently mapped to the specified value.
|
int |
size()
Returns the number of key/value mappings in this map.
|
boolean |
trim()
Rehashes the map, making the table as small as possible.
|
boolean |
trim(int n)
Rehashes this map if the table is too large.
|
BooleanCollection |
values()
Returns a type-specific-set view of the values of this map.
|
equals, toStringdefaultReturnValue, defaultReturnValuecomputeBooleanIfAbsentPartial, containsValue, defaultReturnValue, defaultReturnValue, entrySet, get, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replacetestcompute, computeIfAbsent, computeIfPresent, forEach, replaceAllpublic Object2BooleanOpenHashMap(int expected,
float f)
The actual table size will be the least power of two greater than expected/f.
expected - the expected number of elements in the hash map.f - the load factor.public Object2BooleanOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR as load factor.expected - the expected number of elements in the hash map.public Object2BooleanOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor.public Object2BooleanOpenHashMap(Map<? extends K,? extends Boolean> m, float f)
m - a Map to be copied into the new hash map.f - the load factor.public Object2BooleanOpenHashMap(Map<? extends K,? extends Boolean> m)
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.m - a Map to be copied into the new hash map.public Object2BooleanOpenHashMap(Object2BooleanMap<K> m, float f)
m - a type-specific map to be copied into the new hash map.f - the load factor.public Object2BooleanOpenHashMap(Object2BooleanMap<K> m)
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.m - a type-specific map to be copied into the new hash map.public Object2BooleanOpenHashMap(K[] k, boolean[] v, float f)
k - the array of keys of the new hash map.v - the array of corresponding values in the new hash map.f - the load factor.IllegalArgumentException - if k and v have different lengths.public Object2BooleanOpenHashMap(K[] k, boolean[] v)
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.k - the array of keys of the new hash map.v - the array of corresponding values in the new hash map.IllegalArgumentException - if k and v have different lengths.public void putAll(Map<? extends K,? extends Boolean> m)
AbstractObject2BooleanMappublic boolean put(K k, boolean v)
Object2BooleanFunctionput in interface Object2BooleanFunction<K>k - the key.v - the value.Function.put(Object,Object)public boolean removeBoolean(Object k)
Object2BooleanFunctionremoveBoolean in interface Object2BooleanFunction<K>k - the key.Function.remove(Object)public boolean getBoolean(Object k)
Object2BooleanFunctiongetBoolean in interface Object2BooleanFunction<K>k - the key.Function.get(Object)public boolean containsKey(Object k)
Object2BooleanMapcontainsKey in interface Object2BooleanMap<K>containsKey in interface Map<K,Boolean>containsKey in class AbstractObject2BooleanMap<K>k - the key.key.Map.containsKey(Object)public boolean containsValue(boolean v)
Object2BooleanMaptrue if this map maps one or more keys to the specified value.containsValue in interface Object2BooleanMap<K>containsValue in class AbstractObject2BooleanMap<K>Map.containsValue(Object)public boolean getOrDefault(Object k, boolean defaultValue)
defaultValue if this
map contains no mapping for the key.getOrDefault in interface Object2BooleanMap<K>k - the key.defaultValue - the default mapping of the key.defaultValue if this map contains no mapping for the key.Map.getOrDefault(Object, Object)public boolean putIfAbsent(K k, boolean v)
putIfAbsent in interface Object2BooleanMap<K>k - key with which the specified value is to be associated.v - value to be associated with the specified key.Map.putIfAbsent(Object, Object)public boolean remove(Object k, boolean v)
remove in interface Object2BooleanMap<K>k - key with which the specified value is associated.v - value expected to be associated with the specified key.true if the value was removed.Map.remove(Object, Object)public boolean replace(K k, boolean oldValue, boolean v)
replace in interface Object2BooleanMap<K>k - key with which the specified value is associated.oldValue - value expected to be associated with the specified key.v - value to be associated with the specified key.true if the value was replaced.Map.replace(Object, Object, Object)public boolean replace(K k, boolean v)
replace in interface Object2BooleanMap<K>k - key with which the specified value is associated.v - value to be associated with the specified key.Map.replace(Object, Object)public boolean computeBooleanIfAbsent(K k, Predicate<? super K> mappingFunction)
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.
computeBooleanIfAbsent in interface Object2BooleanMap<K>k - key with which the specified value is to be associated.mappingFunction - the function to compute a value.Map.computeIfAbsent(Object, java.util.function.Function)public boolean computeBooleanIfPresent(K k, BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)
computeBooleanIfPresent in interface Object2BooleanMap<K>k - key with which the specified value is to be associated.remappingFunction - the function to compute a value.Map.computeIfPresent(Object, java.util.function.BiFunction)public boolean computeBoolean(K k, BiFunction<? super K,? super Boolean,? extends Boolean> remappingFunction)
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.
computeBoolean in interface Object2BooleanMap<K>k - key with which the specified value is to be associated.remappingFunction - the function to compute a value.Map.compute(Object, java.util.function.BiFunction)public boolean mergeBoolean(K k, boolean v, BiFunction<? super Boolean,? super Boolean,? extends Boolean> remappingFunction)
value.
Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null.mergeBoolean in interface Object2BooleanMap<K>k - key with which the resulting value is to be associated.v - 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.Map.merge(Object, Object, java.util.function.BiFunction)public void clear()
Object2BooleanMapclear in interface Object2BooleanMap<K>clear in interface Map<K,Boolean>Map.clear()public int size()
Object2BooleanMapInteger.MAX_VALUE elements, returns Integer.MAX_VALUE.public boolean isEmpty()
public Object2BooleanMap.FastEntrySet<K> object2BooleanEntrySet()
Object2BooleanMapThis 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).
object2BooleanEntrySet in interface Object2BooleanMap<K>Map.entrySet()public ObjectSet<K> keySet()
AbstractObject2BooleanMapThe view is backed by the set returned by Map.entrySet(). Note that
no attempt is made at caching the result of this method, as this would
require adding some attributes that lightweight implementations would
not need. Subclasses may easily override this policy by calling
this method and caching the result, but implementors are encouraged to
write more efficient ad-hoc implementations.
keySet in interface Object2BooleanMap<K>keySet in interface Map<K,Boolean>keySet in class AbstractObject2BooleanMap<K>Map.keySet()public BooleanCollection values()
AbstractObject2BooleanMapThe view is backed by the set returned by Map.entrySet(). Note that
no attempt is made at caching the result of this method, as this would
require adding some attributes that lightweight implementations would
not need. Subclasses may easily override this policy by calling
this method and caching the result, but implementors are encouraged to
write more efficient ad-hoc implementations.
values in interface Object2BooleanMap<K>values in interface Map<K,Boolean>values in class AbstractObject2BooleanMap<K>Map.values()public boolean trim()
This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.
If the table size is already the minimum possible, this method does nothing.
trim(int)public boolean trim(int n)
Let N be the smallest table size that can hold
max(n, entries, still satisfying the load factor. If the current
table size is smaller than or equal to N, this method does
nothing. Otherwise, it rehashes this map in a table of size
N.
size())
This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.
n - the threshold for the trimming.trim()public Object2BooleanOpenHashMap<K> clone()
This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.
public int hashCode()
equals() is not overriden, it is important
that the value returned by this method is the same value as
the one returned by the overriden method.