public class Object2CharAVLTreeMap<K> extends AbstractObject2CharSortedMap<K> implements java.io.Serializable, java.lang.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.
AbstractObject2CharMap.BasicEntry<K>
Object2CharSortedMap.FastSortedEntrySet<K>
Object2CharMap.FastEntrySet<K>
Constructor and Description |
---|
Object2CharAVLTreeMap()
Creates a new empty tree map.
|
Object2CharAVLTreeMap(java.util.Comparator<? super K> c)
Creates a new empty tree map with the given comparator.
|
Object2CharAVLTreeMap(K[] k,
char[] v)
Creates a new tree map using the elements of two parallel arrays.
|
Object2CharAVLTreeMap(K[] k,
char[] v,
java.util.Comparator<? super K> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.
|
Object2CharAVLTreeMap(java.util.Map<? extends K,? extends java.lang.Character> m)
Creates a new tree map copying a given map.
|
Object2CharAVLTreeMap(Object2CharMap<? extends K> m)
Creates a new tree map copying a given map.
|
Object2CharAVLTreeMap(Object2CharSortedMap<K> m)
Creates a new tree map copying a given sorted map (and its
Comparator ). |
Object2CharAVLTreeMap(java.util.SortedMap<K,java.lang.Character> m)
Creates a new tree map copying a given sorted map (and its
Comparator ). |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Removes all associations from this function (optional operation).
|
Object2CharAVLTreeMap<K> |
clone()
Returns a deep copy of this tree map.
|
java.util.Comparator<? super K> |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
|
boolean |
containsKey(java.lang.Object k)
Checks whether the given value is contained in
AbstractObject2CharMap.keySet() . |
boolean |
containsValue(char v)
Checks whether the given value is contained in
AbstractObject2CharMap.values() . |
K |
firstKey() |
java.lang.Character |
get(java.lang.Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
char |
getChar(java.lang.Object k)
Returns the value to which the given key is mapped.
|
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 sorted set view of the keys contained in this map.
|
K |
lastKey() |
ObjectSortedSet<Object2CharMap.Entry<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.
|
java.lang.Character |
put(K ok,
java.lang.Character ov)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
java.lang.Character |
remove(java.lang.Object ok)
Delegates to the corresponding type-specific method, taking care of returning
null on a missing key. |
char |
removeChar(java.lang.Object k)
Removes the mapping with the given key.
|
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists.
|
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 . |
CharCollection |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet
containsValue, equals, hashCode, putAll, toString
defaultReturnValue, defaultReturnValue
defaultReturnValue, defaultReturnValue
public Object2CharAVLTreeMap()
public Object2CharAVLTreeMap(java.util.Comparator<? super K> c)
c
- a (possibly type-specific) comparator.public Object2CharAVLTreeMap(java.util.Map<? extends K,? extends java.lang.Character> m)
m
- a Map
to be copied into the new tree map.public Object2CharAVLTreeMap(java.util.SortedMap<K,java.lang.Character> m)
Comparator
).m
- a SortedMap
to be copied into the new tree map.public Object2CharAVLTreeMap(Object2CharMap<? extends K> m)
m
- a type-specific map to be copied into the new tree map.public Object2CharAVLTreeMap(Object2CharSortedMap<K> m)
Comparator
).m
- a type-specific sorted map to be copied into the new tree map.public Object2CharAVLTreeMap(K[] k, char[] v, java.util.Comparator<? super K> 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.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public Object2CharAVLTreeMap(K[] k, char[] v)
k
- the array of keys of the new tree map.v
- the array of corresponding values in the new tree map.java.lang.IllegalArgumentException
- if k
and v
have different lengths.public char put(K k, char v)
Object2CharFunction
put
in interface Object2CharFunction<K>
put
in class AbstractObject2CharFunction<K>
k
- the key.v
- the value.Function.put(Object,Object)
public char removeChar(java.lang.Object k)
Object2CharFunction
removeChar
in interface Object2CharFunction<K>
removeChar
in class AbstractObject2CharFunction<K>
k
- the key.Function.remove(Object)
public java.lang.Character put(K ok, java.lang.Character ov)
AbstractObject2CharFunction
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<K,java.lang.Character>
put
in interface java.util.Map<K,java.lang.Character>
put
in class AbstractObject2CharFunction<K>
ok
- the key.ov
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public java.lang.Character remove(java.lang.Object ok)
AbstractObject2CharFunction
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.
remove
in interface Function<K,java.lang.Character>
remove
in interface java.util.Map<K,java.lang.Character>
remove
in class AbstractObject2CharFunction<K>
ok
- the key.null
if no value was present for the given key.Map.remove(Object)
public boolean containsValue(char v)
AbstractObject2CharMap
AbstractObject2CharMap.values()
.containsValue
in interface Object2CharMap<K>
containsValue
in class AbstractObject2CharMap<K>
Map.containsValue(Object)
public void clear()
Function
public boolean containsKey(java.lang.Object k)
AbstractObject2CharMap
AbstractObject2CharMap.keySet()
.containsKey
in interface Function<K,java.lang.Character>
containsKey
in interface java.util.Map<K,java.lang.Character>
containsKey
in class AbstractObject2CharMap<K>
k
- the key.key
.Map.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()
isEmpty
in interface java.util.Map<K,java.lang.Character>
isEmpty
in class AbstractObject2CharMap<K>
public char getChar(java.lang.Object k)
Object2CharFunction
getChar
in interface Object2CharFunction<K>
k
- the key.Function.get(Object)
public java.lang.Character get(java.lang.Object ok)
AbstractObject2CharFunction
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.
get
in interface Function<K,java.lang.Character>
get
in interface java.util.Map<K,java.lang.Character>
get
in class AbstractObject2CharFunction<K>
ok
- the key.null
if no value was present for the given key.Map.get(Object)
public K firstKey()
firstKey
in interface java.util.SortedMap<K,java.lang.Character>
public K lastKey()
lastKey
in interface java.util.SortedMap<K,java.lang.Character>
public ObjectSortedSet<Object2CharMap.Entry<K>> object2CharEntrySet()
Object2CharSortedMap
object2CharEntrySet
in interface Object2CharMap<K>
object2CharEntrySet
in interface Object2CharSortedMap<K>
Object2CharSortedMap.entrySet()
public ObjectSortedSet<K> 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 Object2CharMap<K>
keySet
in interface Object2CharSortedMap<K>
keySet
in interface java.util.Map<K,java.lang.Character>
keySet
in interface java.util.SortedMap<K,java.lang.Character>
keySet
in class AbstractObject2CharSortedMap<K>
Map.keySet()
public CharCollection 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 Object2CharMap<K>
values
in interface Object2CharSortedMap<K>
values
in interface java.util.Map<K,java.lang.Character>
values
in interface java.util.SortedMap<K,java.lang.Character>
values
in class AbstractObject2CharSortedMap<K>
Map.values()
public java.util.Comparator<? super K> comparator()
Object2CharSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Object2CharSortedMap<K>
comparator
in interface java.util.SortedMap<K,java.lang.Character>
SortedMap.comparator()
public Object2CharSortedMap<K> headMap(K to)
Object2CharSortedMap
toKey
.
Note that this specification strengthens the one given in SortedMap.headMap(Object)
.
headMap
in interface Object2CharSortedMap<K>
headMap
in interface java.util.SortedMap<K,java.lang.Character>
SortedMap.headMap(Object)
public Object2CharSortedMap<K> tailMap(K from)
Object2CharSortedMap
fromKey
.
Note that this specification strengthens the one given in SortedMap.tailMap(Object)
.
tailMap
in interface Object2CharSortedMap<K>
tailMap
in interface java.util.SortedMap<K,java.lang.Character>
SortedMap.tailMap(Object)
public Object2CharSortedMap<K> subMap(K from, K to)
Object2CharSortedMap
fromKey
, inclusive, to toKey
, exclusive.
Note that this specification strengthens the one given in SortedMap.subMap(Object,Object)
.
subMap
in interface Object2CharSortedMap<K>
subMap
in interface java.util.SortedMap<K,java.lang.Character>
SortedMap.subMap(Object,Object)
public Object2CharAVLTreeMap<K> 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.
clone
in class java.lang.Object