public class Object2ObjectRBTreeMap<K,V> extends AbstractObject2ObjectSortedMap<K,V> 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.
AbstractObject2ObjectMap.BasicEntry<K,V>
Object2ObjectSortedMap.FastSortedEntrySet<K,V>
Object2ObjectMap.FastEntrySet<K,V>
Constructor and Description |
---|
Object2ObjectRBTreeMap()
Creates a new empty tree map.
|
Object2ObjectRBTreeMap(java.util.Comparator<? super K> c)
Creates a new empty tree map with the given comparator.
|
Object2ObjectRBTreeMap(K[] k,
V[] v)
Creates a new tree map using the elements of two parallel arrays.
|
Object2ObjectRBTreeMap(K[] k,
V[] v,
java.util.Comparator<? super K> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.
|
Object2ObjectRBTreeMap(java.util.Map<? extends K,? extends V> m)
Creates a new tree map copying a given map.
|
Object2ObjectRBTreeMap(Object2ObjectMap<? extends K,? extends V> m)
Creates a new tree map copying a given map.
|
Object2ObjectRBTreeMap(Object2ObjectSortedMap<K,V> m)
Creates a new tree map copying a given sorted map (and its
Comparator ). |
Object2ObjectRBTreeMap(java.util.SortedMap<K,V> 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).
|
Object2ObjectRBTreeMap<K,V> |
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
AbstractObject2ObjectMap.keySet() . |
boolean |
containsValue(java.lang.Object v)
Checks whether the given value is contained in
AbstractObject2ObjectMap.values() . |
K |
firstKey() |
V |
get(java.lang.Object k)
Returns the value associated by this function to the specified key.
|
Object2ObjectSortedMap<K,V> |
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<Object2ObjectMap.Entry<K,V>> |
object2ObjectEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map.
|
V |
put(K k,
V v)
Associates the specified value with the specified key in this function (optional operation).
|
V |
remove(java.lang.Object k)
Removes this key and the associated value from this function if it is present (optional operation).
|
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists.
|
Object2ObjectSortedMap<K,V> |
subMap(K from,
K to)
Returns a view of the portion of this sorted map whose keys range from
fromKey , inclusive, to toKey , exclusive. |
Object2ObjectSortedMap<K,V> |
tailMap(K from)
Returns a view of the portion of this sorted map whose keys are greater than or equal to
fromKey . |
ObjectCollection<V> |
values()
Returns a type-specific collection view of the values contained in this map.
|
entrySet
equals, hashCode, putAll, toString
defaultReturnValue, defaultReturnValue
defaultReturnValue, defaultReturnValue
public Object2ObjectRBTreeMap()
public Object2ObjectRBTreeMap(java.util.Comparator<? super K> c)
c
- a (possibly type-specific) comparator.public Object2ObjectRBTreeMap(java.util.Map<? extends K,? extends V> m)
m
- a Map
to be copied into the new tree map.public Object2ObjectRBTreeMap(java.util.SortedMap<K,V> m)
Comparator
).m
- a SortedMap
to be copied into the new tree map.public Object2ObjectRBTreeMap(Object2ObjectMap<? extends K,? extends V> m)
m
- a type-specific map to be copied into the new tree map.public Object2ObjectRBTreeMap(Object2ObjectSortedMap<K,V> m)
Comparator
).m
- a type-specific sorted map to be copied into the new tree map.public Object2ObjectRBTreeMap(K[] k, V[] 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 Object2ObjectRBTreeMap(K[] k, V[] 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 V put(K k, V v)
Function
put
in interface Function<K,V>
put
in interface java.util.Map<K,V>
put
in class AbstractObject2ObjectFunction<K,V>
k
- the key.v
- the value.null
if no value was present for the given key.Map.put(Object,Object)
public V remove(java.lang.Object k)
Function
public boolean containsValue(java.lang.Object v)
AbstractObject2ObjectMap
AbstractObject2ObjectMap.values()
.containsValue
in interface java.util.Map<K,V>
containsValue
in class AbstractObject2ObjectMap<K,V>
public void clear()
Function
public boolean containsKey(java.lang.Object k)
AbstractObject2ObjectMap
AbstractObject2ObjectMap.keySet()
.containsKey
in interface Function<K,V>
containsKey
in interface java.util.Map<K,V>
containsKey
in class AbstractObject2ObjectMap<K,V>
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()
public V get(java.lang.Object k)
Function
public ObjectSortedSet<Object2ObjectMap.Entry<K,V>> object2ObjectEntrySet()
Object2ObjectSortedMap
object2ObjectEntrySet
in interface Object2ObjectMap<K,V>
object2ObjectEntrySet
in interface Object2ObjectSortedMap<K,V>
Object2ObjectSortedMap.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 Object2ObjectMap<K,V>
keySet
in interface Object2ObjectSortedMap<K,V>
keySet
in interface java.util.Map<K,V>
keySet
in interface java.util.SortedMap<K,V>
keySet
in class AbstractObject2ObjectSortedMap<K,V>
Map.keySet()
public ObjectCollection<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 Object2ObjectMap<K,V>
values
in interface Object2ObjectSortedMap<K,V>
values
in interface java.util.Map<K,V>
values
in interface java.util.SortedMap<K,V>
values
in class AbstractObject2ObjectSortedMap<K,V>
Map.values()
public java.util.Comparator<? super K> comparator()
Object2ObjectSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Object2ObjectSortedMap<K,V>
comparator
in interface java.util.SortedMap<K,V>
SortedMap.comparator()
public Object2ObjectSortedMap<K,V> headMap(K to)
Object2ObjectSortedMap
toKey
.
Note that this specification strengthens the one given in SortedMap.headMap(Object)
.
public Object2ObjectSortedMap<K,V> tailMap(K from)
Object2ObjectSortedMap
fromKey
.
Note that this specification strengthens the one given in SortedMap.tailMap(Object)
.
public Object2ObjectSortedMap<K,V> subMap(K from, K to)
Object2ObjectSortedMap
fromKey
, inclusive, to toKey
, exclusive.
Note that this specification strengthens the one given in SortedMap.subMap(Object,Object)
.
public Object2ObjectRBTreeMap<K,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.
clone
in class java.lang.Object