Package it.unimi.dsi.fastutil.objects

Class Object2CharLinkedOpenCustomHashMap<K>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

Function<K,Character>, Hash, Object2CharFunction<K>, Object2CharMap<K>, Object2CharSortedMap<K>, Serializable, Cloneable, Function<K,Character>, ToIntFunction<K>, Map<K,Character>, SequencedMap<K,Character>, SortedMap<K,Character>

public class Object2CharLinkedOpenCustomHashMap<K>
extends AbstractObject2CharSortedMap<K>
implements Serializable, Cloneable, Hash

A type-specific linked hash map with with a fast, small-footprint implementation.

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.

Entries returned by the type-specific Object2CharMap.entrySet() method implement the suitable type-specific Pair interface; only values are mutable.

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.

See Also:

• Hash
• HashCommon
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2CharMap

AbstractObject2CharMap.BasicEntry<K>, AbstractObject2CharMap.BasicEntrySet<K>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash

Hash.Strategy<K>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2CharMap

Object2CharMap.Entry<K>, Object2CharMap.FastEntrySet<K>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2CharSortedMap

Object2CharSortedMap.FastSortedEntrySet<K>

Field Summary

Fields inherited from interface it.unimi.dsi.fastutil.Hash

DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR

Constructor Summary

Constructors

Constructor	Description
Object2CharLinkedOpenCustomHashMap(int expected, float f, Hash.Strategy<? super K> strategy)	Creates a new hash map.
Object2CharLinkedOpenCustomHashMap(int expected, Hash.Strategy<? super K> strategy)	Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.
Object2CharLinkedOpenCustomHashMap(Hash.Strategy<? super K> strategy)	Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.
Object2CharLinkedOpenCustomHashMap(Object2CharMap<K> m, float f, Hash.Strategy<? super K> strategy)	Creates a new hash map copying a given type-specific one.
Object2CharLinkedOpenCustomHashMap(Object2CharMap<K> m, Hash.Strategy<? super K> strategy)	Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.
Object2CharLinkedOpenCustomHashMap(Map<? extends K,? extends Character> m, float f, Hash.Strategy<? super K> strategy)	Creates a new hash map copying a given one.
Object2CharLinkedOpenCustomHashMap(Map<? extends K,? extends Character> m, Hash.Strategy<? super K> strategy)	Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.
Object2CharLinkedOpenCustomHashMap(K[] k, char[] v, float f, Hash.Strategy<? super K> strategy)	Creates a new hash map using the elements of two parallel arrays.
Object2CharLinkedOpenCustomHashMap(K[] k, char[] v, Hash.Strategy<? super K> strategy)	Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.

Method Summary

Modifier and Type	Method	Description
char	addTo(K k, char incr)	Adds an increment to value currently associated with a key.
void	clear()	Removes all of the mappings from this map (optional operation).
Object2CharLinkedOpenCustomHashMap<K>	clone()	Returns a deep copy of this map.
Comparator<? super K>	comparator()	Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
char	computeChar(K k, BiFunction<? super K,? super Character,? extends Character> remappingFunction)	Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
char	computeCharIfPresent(K k, BiFunction<? super K,? super Character,? extends Character> remappingFunction)	If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
char	computeIfAbsent(K key, Object2CharFunction<? 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.
char	computeIfAbsent(K k, ToIntFunction<? 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	containsKey(Object k)	Returns true if this function contains a mapping for the specified key.
boolean	containsValue(char v)	Returns true if this map maps one or more keys to the specified value.
void	ensureCapacity(int capacity)	Ensures that this map can hold a certain number of keys without rehashing.
K	firstKey()	Returns the first key of this map in iteration order.
char	getAndMoveToFirst(K 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.
char	getAndMoveToLast(K 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.
char	getChar(Object k)	Returns the value to which the given key is mapped.
char	getOrDefault(Object k, char 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.
Object2CharSortedMap<K>	headMap(K to)	Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
ObjectSortedSet<K>	keySet()	Returns a type-specific-set view of the keys of this map.
K	lastKey()	Returns the last key of this map in iteration order.
char	merge(K k, char v, BiFunction<? super Character,? super Character,? extends Character> remappingFunction)	If the specified key is not already associated with a value, associates it with the given value.
Object2CharSortedMap.FastSortedEntrySet<K>	object2CharEntrySet()	Returns a type-specific sorted-set view of the mappings contained in this map.
char	put(K k, char v)	Adds a pair to the map (optional operation).
void	putAll(Map<? extends K,? extends Character> m)
char	putAndMoveToFirst(K k, char v)	Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.
char	putAndMoveToLast(K k, char v)	Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.
char	putIfAbsent(K k, char 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, char v)	Removes the entry for the specified key only if it is currently mapped to the specified value.
char	removeChar(Object k)	Removes the mapping with the given key (optional operation).
char	removeFirstChar()	Removes the mapping associated with the first key in iteration order.
char	removeLastChar()	Removes the mapping associated with the last key in iteration order.
char	replace(K k, char v)	Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(K k, char oldValue, char 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.
Hash.Strategy<? super K>	strategy()	Returns the hashing strategy.
Object2CharSortedMap<K>	subMap(K from, K to)	Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Object2CharSortedMap<K>	tailMap(K 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.
CharCollection	values()	Returns a type-specific-set view of the values of this map.

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2CharMap

equals, toString

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2CharFunction

defaultReturnValue, defaultReturnValue

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 java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, get, getOrDefault, put, remove, replaceAll

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

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

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

computeCharIfAbsent, computeCharIfAbsentPartial, containsValue, defaultReturnValue, defaultReturnValue, forEach, get, getOrDefault, merge, mergeChar, mergeChar, mergeChar, put, putIfAbsent, remove, remove, replace, replace

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

entrySet

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

putFirst, putLast, reversed

Constructor Details

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(int expected,
 float f,
 Hash.Strategy<? super K> strategy)

Creates a new hash map.

The actual table size will be the least power of two greater than expected/f.

Parameters:

expected - the expected number of elements in the hash map.

f - the load factor.

strategy - the strategy.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(int expected,
 Hash.Strategy<? super K> strategy)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor.

Parameters:

expected - the expected number of elements in the hash map.

strategy - the strategy.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(Hash.Strategy<? super K> strategy)

Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries and Hash.DEFAULT_LOAD_FACTOR as load factor.

Parameters:

strategy - the strategy.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(Map<? extends K,? extends Character> m,
 float f,
 Hash.Strategy<? super K> strategy)

Creates a new hash map copying a given one.

Parameters:

m - a Map to be copied into the new hash map.

f - the load factor.

strategy - the strategy.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(Map<? extends K,? extends Character> m,
 Hash.Strategy<? super K> strategy)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one.

Parameters:

m - a Map to be copied into the new hash map.

strategy - the strategy.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(Object2CharMap<K> m,
 float f,
 Hash.Strategy<? super K> strategy)

Creates a new hash map copying a given type-specific one.

Parameters:

m - a type-specific map to be copied into the new hash map.

f - the load factor.

strategy - the strategy.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(Object2CharMap<K> m,
 Hash.Strategy<? super K> strategy)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one.

Parameters:

m - a type-specific map to be copied into the new hash map.

strategy - the strategy.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(K[] k,
 char[] v,
 float f,
 Hash.Strategy<? super K> strategy)

Creates a new hash map using the elements of two parallel arrays.

Parameters:

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.

strategy - the strategy.

Throws:

IllegalArgumentException - if k and v have different lengths.

Object2CharLinkedOpenCustomHashMap

public Object2CharLinkedOpenCustomHashMap(K[] k,
 char[] v,
 Hash.Strategy<? super K> strategy)

Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays.

Parameters:

k - the array of keys of the new hash map.

v - the array of corresponding values in the new hash map.

strategy - the strategy.

Throws:

IllegalArgumentException - if k and v have different lengths.

Method Details

strategy

public Hash.Strategy<? super K> strategy()

Returns the hashing strategy.

Returns:

the hashing strategy of this custom hash map.

ensureCapacity

public void ensureCapacity(int capacity)

Ensures that this map can hold a certain number of keys without rehashing.

Parameters:

capacity - a number of keys; there will be no rehashing unless the map size exceeds this number.

putAll

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

Description copied from class: AbstractObject2CharMap

Specified by:

putAll in interface Map<K,Character>

Overrides:

putAll in class AbstractObject2CharMap<K>

put

public char put(K k,
 char v)

Description copied from interface: Object2CharFunction

Adds a pair to the map (optional operation).

Specified by:

put in interface Object2CharFunction<K>

Parameters:

k - the key.

v - the value.

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

• Function.put(Object,Object)

addTo

public char addTo(K k,
 char incr)

Adds an increment to value currently associated with a key.

Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.

Parameters:

k - the key.

incr - the increment.

Returns:

the old value, or the default return value if no value was present for the given key.

removeChar

public char removeChar(Object k)

Description copied from interface: Object2CharFunction

Removes the mapping with the given key (optional operation).

Specified by:

removeChar in interface Object2CharFunction<K>

Parameters:

k - the key.

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

• Function.remove(Object)

removeFirstChar

public char removeFirstChar()

Removes the mapping associated with the first key in iteration order.

Returns:

the value previously associated with the first key in iteration order.

Throws:

NoSuchElementException - is this map is empty.

removeLastChar

public char removeLastChar()

Removes the mapping associated with the last key in iteration order.

Returns:

the value previously associated with the last key in iteration order.

Throws:

NoSuchElementException - is this map is empty.

getAndMoveToFirst

public char getAndMoveToFirst(K 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.

Parameters:

k - the key.

Returns:

the corresponding value, or the default return value if no value was present for the given key.

getAndMoveToLast

public char getAndMoveToLast(K 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.

Parameters:

k - the key.

Returns:

the corresponding value, or the default return value if no value was present for the given key.

putAndMoveToFirst

public char putAndMoveToFirst(K k,
 char v)

Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.

Parameters:

k - the key.

v - the value.

Returns:

the old value, or the default return value if no value was present for the given key.

putAndMoveToLast

public char putAndMoveToLast(K k,
 char v)

Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.

Parameters:

k - the key.

v - the value.

Returns:

the old value, or the default return value if no value was present for the given key.

getChar

public char getChar(Object k)

Description copied from interface: Object2CharFunction

Returns the value to which the given key is mapped.

Specified by:

getChar in interface Object2CharFunction<K>

Parameters:

k - the key.

Returns:

the corresponding value, or the default return value if no value was present for the given key.

See Also:

• Function.get(Object)

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractObject2CharMap

Returns true if this function contains a mapping for the specified key.

Specified by:

containsKey in interface Function<K,Character>

Specified by:

containsKey in interface Map<K,Character>

Specified by:

containsKey in interface Object2CharMap<K>

Overrides:

containsKey in class AbstractObject2CharMap<K>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

• Map.containsKey(Object)

containsValue

public boolean containsValue(char v)

Description copied from class: AbstractObject2CharMap

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

Specified by:

containsValue in interface Object2CharMap<K>

Overrides:

containsValue in class AbstractObject2CharMap<K>

See Also:

• Map.containsValue(Object)

getOrDefault

public char getOrDefault(Object k,
 char defaultValue)

Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.

Specified by:

getOrDefault in interface Object2CharFunction<K>

Specified by:

getOrDefault in interface Object2CharMap<K>

Parameters:

k - 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.

See Also:

• Map.getOrDefault(Object, Object)

putIfAbsent

public char putIfAbsent(K k,
 char 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.

Specified by:

putIfAbsent in interface Object2CharMap<K>

Parameters:

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

v - 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 k,
 char v)

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

Specified by:

remove in interface Object2CharMap<K>

Parameters:

k - key with which the specified value is associated.

v - 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 k,
 char oldValue,
 char v)

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

Specified by:

replace in interface Object2CharMap<K>

Parameters:

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.

Returns:

true if the value was replaced.

See Also:

• Map.replace(Object, Object, Object)

replace

public char replace(K k,
 char v)

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

Specified by:

replace in interface Object2CharMap<K>

Parameters:

k - key with which the specified value is associated.

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

computeIfAbsent

public char computeIfAbsent(K k,
 ToIntFunction<? 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.

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 Object2CharMap<K>

Parameters:

k - 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 char computeIfAbsent(K key,
 Object2CharFunction<? 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.

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

computeCharIfPresent

public char computeCharIfPresent(K k,
 BiFunction<? super K,? super Character,? extends Character> remappingFunction)

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:

computeCharIfPresent in interface Object2CharMap<K>

Parameters:

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

computeChar

public char computeChar(K k,
 BiFunction<? super K,? super Character,? extends Character> remappingFunction)

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:

computeChar in interface Object2CharMap<K>

Parameters:

k - 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 char merge(K k,
 char v,
 BiFunction<? super Character,? super Character,? extends Character> remappingFunction)

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 Object2CharMap<K>

Parameters:

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.

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)

clear

public void clear()

Description copied from interface: Object2CharMap

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Function<K,Character>

Specified by:

clear in interface Map<K,Character>

Specified by:

clear in interface Object2CharMap<K>

See Also:

• Map.clear()

size

public int size()

Description copied from interface: Object2CharMap

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Function<K,Character>

Specified by:

size in interface Map<K,Character>

Specified by:

size in interface Object2CharMap<K>

Returns:

the number of key-value mappings in this map.

See Also:

• Size64

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,Character>

Overrides:

isEmpty in class AbstractObject2CharMap<K>

firstKey

public K firstKey()

Returns the first key of this map in iteration order.

Specified by:

firstKey in interface SortedMap<K,Character>

Returns:

the first key in iteration order.

lastKey

public K lastKey()

Returns the last key of this map in iteration order.

Specified by:

lastKey in interface SortedMap<K,Character>

Returns:

the last key in iteration order.

tailMap

public Object2CharSortedMap<K> tailMap(K from)

Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:

tailMap in interface Object2CharSortedMap<K>

Specified by:

tailMap in interface SortedMap<K,Character>

See Also:

• SortedMap.tailMap(Object)

Implementation Specification:

This implementation just throws an UnsupportedOperationException.

headMap

public Object2CharSortedMap<K> headMap(K to)

Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:

headMap in interface Object2CharSortedMap<K>

Specified by:

headMap in interface SortedMap<K,Character>

See Also:

• SortedMap.headMap(Object)

Implementation Specification:

This implementation just throws an UnsupportedOperationException.

subMap

public Object2CharSortedMap<K> subMap(K from,
 K to)

Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:

subMap in interface Object2CharSortedMap<K>

Specified by:

subMap in interface SortedMap<K,Character>

See Also:

• SortedMap.subMap(Object,Object)

Implementation Specification:

This implementation just throws an UnsupportedOperationException.

comparator

public Comparator<? super K> comparator()

Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Specified by:

comparator in interface Object2CharSortedMap<K>

Specified by:

comparator in interface SortedMap<K,Character>

See Also:

• SortedMap.comparator()

Implementation Specification:

This implementation just returns null.

object2CharEntrySet

public Object2CharSortedMap.FastSortedEntrySet<K> object2CharEntrySet()

Description copied from interface: Object2CharSortedMap

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

Specified by:

object2CharEntrySet in interface Object2CharMap<K>

Specified by:

object2CharEntrySet in interface Object2CharSortedMap<K>

Returns:

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

See Also:

• Object2CharSortedMap.entrySet()

keySet

public ObjectSortedSet<K> keySet()

Description copied from class: AbstractObject2CharSortedMap

Returns a type-specific-set view of the keys of this map.

The 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.

Specified by:

keySet in interface Map<K,Character>

Specified by:

keySet in interface Object2CharMap<K>

Specified by:

keySet in interface Object2CharSortedMap<K>

Specified by:

keySet in interface SortedMap<K,Character>

Overrides:

keySet in class AbstractObject2CharSortedMap<K>

Returns:

a sorted set view of the keys of this map; it may be safely cast to a type-specific interface.

See Also:

• Map.keySet()

values

public CharCollection values()

Description copied from class: AbstractObject2CharSortedMap

Returns a type-specific-set view of the values of this map.

The 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.

Specified by:

values in interface Map<K,Character>

Specified by:

values in interface Object2CharMap<K>

Specified by:

values in interface Object2CharSortedMap<K>

Specified by:

values in interface SortedMap<K,Character>

Overrides:

values in class AbstractObject2CharSortedMap<K>

Returns:

a type-specific collection view of the values contained in this map.

See Also:

• Map.values()

trim

public boolean trim()

Rehashes the map, making the table as small as possible.

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.

Returns:

true if there was enough memory to trim the map.

See Also:

• trim(int)

trim

public boolean trim(int n)

Rehashes this map if the table is too large.

Let N be the smallest table size that can hold max(n,size()) 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.

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.

Parameters:

n - the threshold for the trimming.

Returns:

true if there was enough memory to trim the map.

See Also:

• trim()

clone

public Object2CharLinkedOpenCustomHashMap<K> clone()

Returns a deep copy of this map.

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.

Returns:

a deep copy of this map.

hashCode

public int hashCode()

Returns a hash code for this map. This method overrides the generic method provided by the superclass. Since 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.

Specified by:

hashCode in interface Map<K,Character>

Overrides:

hashCode in class AbstractObject2CharMap<K>

Returns:

a hash code for this map.