public class Char2ReferenceRBTreeMap<V> extends AbstractChar2ReferenceSortedMap<V> implements Serializable, Cloneable
The iterators provided by the views of this class are type-specific bidirectional iterators.
Moreover, the iterator returned by iterator()
can be safely cast
to a type-specific list iterator.
AbstractChar2ReferenceMap.BasicEntry<V>
Char2ReferenceSortedMap.FastSortedEntrySet<V>
Char2ReferenceMap.FastEntrySet<V>
Constructor and Description |
---|
Char2ReferenceRBTreeMap()
Creates a new empty tree map.
|
Char2ReferenceRBTreeMap(char[] k,
V[] v)
Creates a new tree map using the elements of two parallel arrays.
|
Char2ReferenceRBTreeMap(char[] k,
V[] v,
Comparator<? super Character> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.
|
Char2ReferenceRBTreeMap(Char2ReferenceMap<? extends V> m)
Creates a new tree map copying a given map.
|
Char2ReferenceRBTreeMap(Char2ReferenceSortedMap<V> m)
Creates a new tree map copying a given sorted map (and its
Comparator ). |
Char2ReferenceRBTreeMap(Comparator<? super Character> c)
Creates a new empty tree map with the given comparator.
|
Char2ReferenceRBTreeMap(Map<? extends Character,? extends V> m)
Creates a new tree map copying a given map.
|
Char2ReferenceRBTreeMap(SortedMap<Character,V> m)
Creates a new tree map copying a given sorted map (and its
Comparator ). |
Modifier and Type | Method and Description |
---|---|
ObjectSortedSet<Char2ReferenceMap.Entry<V>> |
char2ReferenceEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
void |
clear()
Removes all associations from this function (optional operation).
|
Char2ReferenceRBTreeMap<V> |
clone()
Returns a deep copy of this tree map.
|
CharComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
|
boolean |
containsKey(char k)
Checks whether the given value is contained in
AbstractChar2ReferenceMap.keySet() . |
boolean |
containsValue(Object v)
Checks whether the given value is contained in
AbstractChar2ReferenceMap.values() . |
char |
firstCharKey() |
V |
get(char k)
Returns the value to which the given key is mapped.
|
Char2ReferenceSortedMap<V> |
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 sorted set view of the keys contained in this map.
|
char |
lastCharKey() |
V |
put(Character ok,
V ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
V |
put(char k,
V v)
Adds a pair to the map.
|
V |
remove(char k)
Removes the mapping with the given key.
|
V |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists.
|
Char2ReferenceSortedMap<V> |
subMap(char from,
char to)
Returns a view of the portion of this sorted map whose keys range from
fromKey , inclusive, to toKey , exclusive. |
Char2ReferenceSortedMap<V> |
tailMap(char from)
Returns a view of the portion of this sorted map whose keys are greater than or equal to
fromKey . |
ReferenceCollection<V> |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet, firstKey, headMap, lastKey, subMap, tailMap
equals, hashCode, putAll, toString
containsKey, defaultReturnValue, defaultReturnValue, get
defaultReturnValue, defaultReturnValue
containsKey, get
public Char2ReferenceRBTreeMap()
public Char2ReferenceRBTreeMap(Comparator<? super Character> c)
c
- a (possibly type-specific) comparator.public Char2ReferenceRBTreeMap(Map<? extends Character,? extends V> m)
m
- a Map
to be copied into the new tree map.public Char2ReferenceRBTreeMap(SortedMap<Character,V> m)
Comparator
).m
- a SortedMap
to be copied into the new tree map.public Char2ReferenceRBTreeMap(Char2ReferenceMap<? extends V> m)
m
- a type-specific map to be copied into the new tree map.public Char2ReferenceRBTreeMap(Char2ReferenceSortedMap<V> m)
Comparator
).m
- a type-specific sorted map to be copied into the new tree map.public Char2ReferenceRBTreeMap(char[] k, V[] v, Comparator<? super Character> c)
k
- the array of keys of the new tree map.v
- the array of corresponding values in the new tree map.c
- a (possibly type-specific) comparator.IllegalArgumentException
- if k
and v
have different lengths.public Char2ReferenceRBTreeMap(char[] k, V[] v)
k
- the array of keys of the new tree map.v
- the array of corresponding values in the new tree map.IllegalArgumentException
- if k
and v
have different lengths.public V put(char k, V v)
Char2ReferenceFunction
put
in interface Char2ReferenceFunction<V>
put
in class AbstractChar2ReferenceFunction<V>
k
- the key.v
- the value.Function.put(Object,Object)
public V remove(char k)
Char2ReferenceFunction
remove
in interface Char2ReferenceFunction<V>
remove
in class AbstractChar2ReferenceFunction<V>
k
- the key.Function.remove(Object)
public V put(Character ok, V ov)
AbstractChar2ReferenceFunction
null
on a missing key.
This method must check whether the provided key is in the map using containsKey()
. Thus,
it probes the map twice. Implementors of subclasses should override it with a more efficient method.
put
in interface Function<Character,V>
put
in interface Map<Character,V>
put
in class AbstractChar2ReferenceFunction<V>
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public V remove(Object ok)
AbstractChar2ReferenceFunction
null
on a missing key.
This method must check whether the provided key is in the map using containsKey()
. Thus,
it probes the map twice. Implementors of subclasses should override it with a more efficient method.
public boolean containsValue(Object v)
AbstractChar2ReferenceMap
AbstractChar2ReferenceMap.values()
.containsValue
in interface Map<Character,V>
containsValue
in class AbstractChar2ReferenceMap<V>
public void clear()
Function
public boolean containsKey(char k)
AbstractChar2ReferenceMap
AbstractChar2ReferenceMap.keySet()
.containsKey
in interface Char2ReferenceFunction<V>
containsKey
in class AbstractChar2ReferenceMap<V>
Function.containsKey(Object)
public int size()
Function
Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.
public boolean isEmpty()
public V get(char k)
Char2ReferenceFunction
get
in interface Char2ReferenceFunction<V>
k
- the key.Function.get(Object)
public char firstCharKey()
firstCharKey
in interface Char2ReferenceSortedMap<V>
SortedMap.firstKey()
public char lastCharKey()
lastCharKey
in interface Char2ReferenceSortedMap<V>
SortedMap.lastKey()
public ObjectSortedSet<Char2ReferenceMap.Entry<V>> char2ReferenceEntrySet()
Char2ReferenceSortedMap
char2ReferenceEntrySet
in interface Char2ReferenceMap<V>
char2ReferenceEntrySet
in interface Char2ReferenceSortedMap<V>
Char2ReferenceSortedMap.entrySet()
public CharSortedSet keySet()
In addition to the semantics of Map.keySet()
, you can
safely cast the set returned by this call to a type-specific sorted
set interface.
keySet
in interface Char2ReferenceMap<V>
keySet
in interface Char2ReferenceSortedMap<V>
keySet
in interface Map<Character,V>
keySet
in interface SortedMap<Character,V>
keySet
in class AbstractChar2ReferenceSortedMap<V>
Map.keySet()
public ReferenceCollection<V> values()
In addition to the semantics of Map.values()
, you can
safely cast the collection returned by this call to a type-specific collection
interface.
values
in interface Char2ReferenceMap<V>
values
in interface Char2ReferenceSortedMap<V>
values
in interface Map<Character,V>
values
in interface SortedMap<Character,V>
values
in class AbstractChar2ReferenceSortedMap<V>
Map.values()
public CharComparator comparator()
Char2ReferenceSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Char2ReferenceSortedMap<V>
comparator
in interface SortedMap<Character,V>
SortedMap.comparator()
public Char2ReferenceSortedMap<V> headMap(char to)
Char2ReferenceSortedMap
toKey
.headMap
in interface Char2ReferenceSortedMap<V>
SortedMap.headMap(Object)
public Char2ReferenceSortedMap<V> tailMap(char from)
Char2ReferenceSortedMap
fromKey
.tailMap
in interface Char2ReferenceSortedMap<V>
SortedMap.tailMap(Object)
public Char2ReferenceSortedMap<V> subMap(char from, char to)
Char2ReferenceSortedMap
fromKey
, inclusive, to toKey
, exclusive.subMap
in interface Char2ReferenceSortedMap<V>
SortedMap.subMap(Object,Object)
public Char2ReferenceRBTreeMap<V> clone()
This method performs a deep copy of this tree map; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.