|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.util.AbstractMap<K,V>
java.util.TreeMap<K,V>
org.apache.commons.collections15.map.FastTreeMap<K,V>
public class FastTreeMap<K,V>
A customized implementation of java.util.TreeMap designed
to operate in a multithreaded environment where the large majority of
method calls are read-only, instead of structural changes. When operating
in "fast" mode, read calls are non-synchronized and write calls perform the
following steps:
When first created, objects of this class default to "slow" mode, where
all accesses of any type are synchronized but no cloning takes place. This
is appropriate for initially populating the collection, followed by a switch
to "fast" mode (by calling setFast(true)) after initialization
is complete.
NOTE: If you are creating and accessing a
TreeMap only within a single thread, you should use
java.util.TreeMap directly (with no synchronization), for
maximum performance.
NOTE: This class is not cross-platform. Using it may cause unexpected failures on some architectures. It suffers from the same problems as the double-checked locking idiom. In particular, the instruction that clones the internal collection and the instruction that sets the internal reference to the clone can be executed or perceived out-of-order. This means that any read operation might fail unexpectedly, as it may be reading the state of the internal collection before the internal collection is fully formed. For more information on the double-checked locking idiom, see the Double-Checked Locking Idiom Is Broken Declaration.
| Field Summary | |
|---|---|
protected boolean |
fast
Are we operating in "fast" mode? |
protected TreeMap<K,V> |
map
The underlying map we are managing. |
| Constructor Summary | |
|---|---|
FastTreeMap()
Construct a an empty map. |
|
FastTreeMap(Comparator<K> comparator)
Construct an empty map with the specified comparator. |
|
FastTreeMap(Map<K,V> map)
Construct a new map with the same mappings as the specified map, sorted according to the keys's natural order |
|
FastTreeMap(SortedMap<K,V> map)
Construct a new map with the same mappings as the specified map, sorted according to the same ordering |
|
| Method Summary | |
|---|---|
void |
clear()
Remove all mappings from this map. |
FastTreeMap<K,V> |
clone()
Return a shallow copy of this FastTreeMap instance. |
Comparator<? super K> |
comparator()
Return the comparator used to order this map, or null
if this map uses its keys' natural order. |
boolean |
containsKey(Object key)
Return true if this map contains a mapping for the
specified key. |
boolean |
containsValue(Object value)
Return true if this map contains one or more keys mapping
to the specified value. |
Set<Map.Entry<K,V>> |
entrySet()
Return a collection view of the mappings contained in this map. |
boolean |
equals(Object o)
Compare the specified object with this list for equality. |
K |
firstKey()
Return the first (lowest) key currently in this sorted map. |
V |
get(Object key)
Return the value to which this map maps the specified key. |
boolean |
getFast()
Returns true if this map is operating in fast mode. |
int |
hashCode()
Return the hash code value for this map. |
SortedMap<K,V> |
headMap(K key)
Return a view of the portion of this map whose keys are strictly less than the specified key. |
boolean |
isEmpty()
Return true if this map contains no mappings. |
Set<K> |
keySet()
Return a set view of the keys contained in this map. |
K |
lastKey()
Return the last (highest) key currently in this sorted map. |
V |
put(K key,
V value)
Associate the specified value with the specified key in this map. |
void |
putAll(Map<? extends K,? extends V> in)
Copy all of the mappings from the specified map to this one, replacing any mappings with the same keys. |
V |
remove(Object key)
Remove any mapping for this key, and return any previously mapped value. |
void |
setFast(boolean fast)
Sets whether this map is operating in fast mode. |
int |
size()
Return the number of key-value mappings in this map. |
SortedMap<K,V> |
subMap(K fromKey,
K toKey)
Return a view of the portion of this map whose keys are in the range fromKey (inclusive) to toKey (exclusive). |
SortedMap<K,V> |
tailMap(K key)
Return a view of the portion of this map whose keys are greater than or equal to the specified key. |
Collection<V> |
values()
Return a collection view of the values contained in this map. |
| Methods inherited from class java.util.AbstractMap |
|---|
toString |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected TreeMap<K,V> map
protected boolean fast
| Constructor Detail |
|---|
public FastTreeMap()
public FastTreeMap(Comparator<K> comparator)
comparator - the comparator to use for ordering tree elementspublic FastTreeMap(Map<K,V> map)
map - the map whose mappings are to be copiedpublic FastTreeMap(SortedMap<K,V> map)
map - the map whose mappings are to be copied| Method Detail |
|---|
public boolean getFast()
public void setFast(boolean fast)
fast - true if this map should operate in fast modepublic V get(Object key)
null if the map contains no mapping for this key, or if
there is a mapping with a value of null. Use the
containsKey() method to disambiguate these cases.
get in interface Map<K,V>get in class TreeMap<K,V>key - the key whose value is to be returned
public int size()
size in interface Map<K,V>size in class TreeMap<K,V>public boolean isEmpty()
true if this map contains no mappings.
isEmpty in interface Map<K,V>isEmpty in class AbstractMap<K,V>public boolean containsKey(Object key)
true if this map contains a mapping for the
specified key.
containsKey in interface Map<K,V>containsKey in class TreeMap<K,V>key - the key to be searched for
public boolean containsValue(Object value)
true if this map contains one or more keys mapping
to the specified value.
containsValue in interface Map<K,V>containsValue in class TreeMap<K,V>value - the value to be searched for
public Comparator<? super K> comparator()
null
if this map uses its keys' natural order.
comparator in interface SortedMap<K,V>comparator in class TreeMap<K,V>public K firstKey()
firstKey in interface SortedMap<K,V>firstKey in class TreeMap<K,V>public K lastKey()
lastKey in interface SortedMap<K,V>lastKey in class TreeMap<K,V>
public V put(K key,
V value)
put in interface Map<K,V>put in class TreeMap<K,V>key - the key with which the value is to be associatedvalue - the value to be associated with this key
public void putAll(Map<? extends K,? extends V> in)
putAll in interface Map<K,V>putAll in class TreeMap<K,V>in - the map whose mappings are to be copiedpublic V remove(Object key)
remove in interface Map<K,V>remove in class TreeMap<K,V>key - the key whose mapping is to be removed
public void clear()
clear in interface Map<K,V>clear in class TreeMap<K,V>public boolean equals(Object o)
Map.equals method.
equals in interface Map<K,V>equals in class AbstractMap<K,V>o - the object to be compared to this list
public int hashCode()
Map.hashCode method.
hashCode in interface Map<K,V>hashCode in class AbstractMap<K,V>public FastTreeMap<K,V> clone()
FastTreeMap instance.
The keys and values themselves are not copied.
clone in class TreeMap<K,V>public SortedMap<K,V> headMap(K key)
headMap in interface SortedMap<K,V>headMap in class TreeMap<K,V>key - Key higher than any in the returned map
public SortedMap<K,V> subMap(K fromKey,
K toKey)
subMap in interface SortedMap<K,V>subMap in class TreeMap<K,V>fromKey - Lower limit of keys for the returned maptoKey - Upper limit of keys for the returned map
public SortedMap<K,V> tailMap(K key)
tailMap in interface SortedMap<K,V>tailMap in class TreeMap<K,V>key - Key less than or equal to any in the returned map
public Set<Map.Entry<K,V>> entrySet()
Map.Entry.
entrySet in interface Map<K,V>entrySet in class TreeMap<K,V>public Set<K> keySet()
keySet in interface Map<K,V>keySet in class TreeMap<K,V>public Collection<V> values()
values in interface Map<K,V>values in class TreeMap<K,V>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||