public class Char2BooleanLinkedOpenHashMap extends AbstractChar2BooleanSortedMap 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.
Iterators generated by this map will enumerate pairs in the same order in which they have been added to the map (addition of pairs whose key is already present in the map does not change the iteration order). Note that this order has nothing in common with the natural order of the keys. The order is kept by means of a doubly linked list, represented via an array of longs parallel to the table.
This class implements the interface of a sorted map, so to allow easy
access of the iteration order: for instance, you can get the first key
in iteration order with firstKey() without having to create an
iterator; however, this class partially violates the SortedMap
contract because all submap methods throw an exception and comparator() returns always null.
Additional methods, such as getAndMoveToFirst(), make it easy
to use instances of this class as a cache (e.g., with LRU policy).
The iterators provided by the views of this class using are type-specific
list iterators, and can be started at any
element which is a key of the map, or
a NoSuchElementException exception will be thrown.
If, however, the provided element is not the first or last key in the
map, the first access to the list index will require linear time, as in the worst case
the entire key set must be scanned in iteration order to retrieve the positional
index of the starting key. If you use just the methods of a type-specific BidirectionalIterator,
however, all operations will be performed in constant time.
Hash,
HashCommon,
Serialized FormAbstractChar2BooleanMap.BasicEntry, AbstractChar2BooleanMap.BasicEntrySetHash.Strategy<K>Char2BooleanSortedMap.FastSortedEntrySetChar2BooleanMap.Entry, Char2BooleanMap.FastEntrySetDEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR| Constructor and Description |
|---|
Char2BooleanLinkedOpenHashMap()
Creates a new hash map with initial expected
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
Char2BooleanLinkedOpenHashMap(char[] k,
boolean[] v)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
Char2BooleanLinkedOpenHashMap(char[] k,
boolean[] v,
float f)
Creates a new hash map using the elements of two parallel arrays.
|
Char2BooleanLinkedOpenHashMap(Char2BooleanMap m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
Char2BooleanLinkedOpenHashMap(Char2BooleanMap m,
float f)
Creates a new hash map copying a given type-specific one.
|
Char2BooleanLinkedOpenHashMap(int expected)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor. |
Char2BooleanLinkedOpenHashMap(int expected,
float f)
Creates a new hash map.
|
Char2BooleanLinkedOpenHashMap(Map<? extends Character,? extends Boolean> m)
Creates a new hash map with
Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
Char2BooleanLinkedOpenHashMap(Map<? extends Character,? extends Boolean> m,
float f)
Creates a new hash map copying a given one.
|
| Modifier and Type | Method and Description |
|---|---|
Char2BooleanSortedMap.FastSortedEntrySet |
char2BooleanEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
void |
clear()
Removes all of the mappings from this map (optional operation).
|
Char2BooleanLinkedOpenHashMap |
clone()
Returns a deep copy of this map.
|
CharComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
|
boolean |
compute(char k,
BiFunction<? super Character,? 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 |
computeIfAbsent(char k,
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.
|
boolean |
computeIfAbsentNullable(char k,
IntFunction<? extends 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 is
null. |
boolean |
computeIfPresent(char k,
BiFunction<? super Character,? 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(char 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. |
char |
firstCharKey()
Returns the first key of this map in iteration order.
|
boolean |
get(char k)
Returns the value to which the given key is mapped.
|
boolean |
getAndMoveToFirst(char k)
Returns the value to which the given key is mapped; if the key is present, it is moved to the first position of the iteration order.
|
boolean |
getAndMoveToLast(char k)
Returns the value to which the given key is mapped; if the key is present, it is moved to the last position of the iteration order.
|
boolean |
getOrDefault(char 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.
|
Char2BooleanSortedMap |
headMap(char to)
Returns a view of the portion of this sorted map whose keys are strictly less than
toKey. |
boolean |
isEmpty() |
CharSortedSet |
keySet()
Returns a type-specific-set view of the keys of this map.
|
char |
lastCharKey()
Returns the last key of this map in iteration order.
|
boolean |
merge(char 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. |
boolean |
put(char k,
boolean v)
Adds a pair to the map (optional operation).
|
void |
putAll(Map<? extends Character,? extends Boolean> m) |
boolean |
putAndMoveToFirst(char k,
boolean v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
|
boolean |
putAndMoveToLast(char k,
boolean v)
Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.
|
boolean |
putIfAbsent(char 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(char k)
Removes the mapping with the given key (optional operation).
|
boolean |
remove(char k,
boolean v)
Removes the entry for the specified key only if it is currently mapped to the specified value.
|
boolean |
removeFirstBoolean()
Removes the mapping associated with the first key in iteration order.
|
boolean |
removeLastBoolean()
Removes the mapping associated with the last key in iteration order.
|
boolean |
replace(char k,
boolean v)
Replaces the entry for the specified key only if it is currently mapped to some value.
|
boolean |
replace(char 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.
|
Char2BooleanSortedMap |
subMap(char from,
char to)
Returns a view of the portion of this sorted map whose keys range from
fromKey, inclusive, to toKey, exclusive. |
Char2BooleanSortedMap |
tailMap(char from)
Returns a view of the portion of this sorted map whose keys are greater than or equal to
fromKey. |
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, defaultReturnValueentrySet, firstKey, headMap, lastKey, subMap, tailMapcompute, computeIfAbsent, computeIfAbsentPartial, computeIfPresent, containsKey, containsValue, defaultReturnValue, defaultReturnValue, get, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replacetestand, negate, orequals, forEach, replaceAllpublic Char2BooleanLinkedOpenHashMap(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 Char2BooleanLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR as load factor.expected - the expected number of elements in the hash map.public Char2BooleanLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor.public Char2BooleanLinkedOpenHashMap(Map<? extends Character,? extends Boolean> m, float f)
m - a Map to be copied into the new hash map.f - the load factor.public Char2BooleanLinkedOpenHashMap(Map<? extends Character,? 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 Char2BooleanLinkedOpenHashMap(Char2BooleanMap m, float f)
m - a type-specific map to be copied into the new hash map.f - the load factor.public Char2BooleanLinkedOpenHashMap(Char2BooleanMap 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 Char2BooleanLinkedOpenHashMap(char[] 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 Char2BooleanLinkedOpenHashMap(char[] 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 Character,? extends Boolean> m)
AbstractChar2BooleanMappublic boolean put(char k,
boolean v)
Char2BooleanFunctionput in interface Char2BooleanFunctionk - the key.v - the value.Function.put(Object,Object)public boolean remove(char k)
Char2BooleanFunctionremove in interface Char2BooleanFunctionk - the key.Function.remove(Object)public boolean removeFirstBoolean()
NoSuchElementException - is this map is empty.public boolean removeLastBoolean()
NoSuchElementException - is this map is empty.public boolean getAndMoveToFirst(char k)
k - the key.public boolean getAndMoveToLast(char k)
k - the key.public boolean putAndMoveToFirst(char k,
boolean v)
k - the key.v - the value.public boolean putAndMoveToLast(char k,
boolean v)
k - the key.v - the value.public boolean get(char k)
Char2BooleanFunctionget in interface Char2BooleanFunctionk - the key.Function.get(Object)public boolean containsKey(char k)
Char2BooleanMapcontainsKey in interface Char2BooleanFunctioncontainsKey in interface Char2BooleanMapcontainsKey in class AbstractChar2BooleanMapk - the key.key.Map.containsKey(Object)public boolean containsValue(boolean v)
Char2BooleanMaptrue if this map maps one or more keys to the specified value.containsValue in interface Char2BooleanMapcontainsValue in class AbstractChar2BooleanMapMap.containsValue(Object)public boolean getOrDefault(char k,
boolean defaultValue)
defaultValue if this
map contains no mapping for the key.getOrDefault in interface Char2BooleanMapk - 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(char k,
boolean v)
putIfAbsent in interface Char2BooleanMapk - 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(char k,
boolean v)
remove in interface Char2BooleanMapk - 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(char k,
boolean oldValue,
boolean v)
replace in interface Char2BooleanMapk - 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(char k,
boolean v)
replace in interface Char2BooleanMapk - key with which the specified value is associated.v - value to be associated with the specified key.Map.replace(Object, Object)public boolean computeIfAbsent(char k,
IntPredicate 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.
computeIfAbsent in interface Char2BooleanMapk - 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 computeIfAbsentNullable(char k,
IntFunction<? extends Boolean> mappingFunction)
null.
Note that this version of computeIfAbsent()
should be used only if you plan to return null in the mapping function.
computeIfAbsentNullable in interface Char2BooleanMapk - key with which the specified value is to be associated.mappingFunction - the function to compute a value.null.Map.computeIfAbsent(Object, java.util.function.Function)public boolean computeIfPresent(char k,
BiFunction<? super Character,? super Boolean,? extends Boolean> remappingFunction)
computeIfPresent in interface Char2BooleanMapk - 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 compute(char k,
BiFunction<? super Character,? 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.
compute in interface Char2BooleanMapk - 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 merge(char 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.merge in interface Char2BooleanMapk - 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()
Char2BooleanMapclear in interface Char2BooleanMapclear in interface Map<Character,Boolean>Map.clear()public int size()
Char2BooleanMapInteger.MAX_VALUE elements, returns Integer.MAX_VALUE.public boolean isEmpty()
public char firstCharKey()
firstCharKey in interface Char2BooleanSortedMapSortedMap.firstKey()public char lastCharKey()
lastCharKey in interface Char2BooleanSortedMapSortedMap.lastKey()public Char2BooleanSortedMap tailMap(char from)
fromKey.
Note that this specification strengthens the one given in SortedMap.tailMap(Object).
This implementation just throws an UnsupportedOperationException.
tailMap in interface Char2BooleanSortedMapSortedMap.tailMap(Object)public Char2BooleanSortedMap headMap(char to)
toKey.
Note that this specification strengthens the one given in SortedMap.headMap(Object).
This implementation just throws an UnsupportedOperationException.
headMap in interface Char2BooleanSortedMapSortedMap.headMap(Object)public Char2BooleanSortedMap subMap(char from, char to)
fromKey, inclusive, to toKey, exclusive.
Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).
This implementation just throws an UnsupportedOperationException.
subMap in interface Char2BooleanSortedMapSortedMap.subMap(Object,Object)public CharComparator comparator()
Note that this specification strengthens the one given in SortedMap.comparator().
This implementation just returns null.
comparator in interface Char2BooleanSortedMapcomparator in interface SortedMap<Character,Boolean>SortedMap.comparator()public Char2BooleanSortedMap.FastSortedEntrySet char2BooleanEntrySet()
Char2BooleanSortedMapNote that this specification strengthens the one given in the corresponding type-specific unsorted map.
char2BooleanEntrySet in interface Char2BooleanMapchar2BooleanEntrySet in interface Char2BooleanSortedMapChar2BooleanSortedMap.entrySet()public CharSortedSet keySet()
AbstractChar2BooleanSortedMapThe 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.
The view is backed by the sorted 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 Char2BooleanMapkeySet in interface Char2BooleanSortedMapkeySet in interface Map<Character,Boolean>keySet in interface SortedMap<Character,Boolean>keySet in class AbstractChar2BooleanSortedMapMap.keySet()public BooleanCollection values()
AbstractChar2BooleanSortedMapThe 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.
The view is backed by the sorted 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 Char2BooleanMapvalues in interface Char2BooleanSortedMapvalues in interface Map<Character,Boolean>values in interface SortedMap<Character,Boolean>values in class AbstractChar2BooleanSortedMapMap.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 Char2BooleanLinkedOpenHashMap 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.