Save This Page
Home » commons-collections-3.2.1-src » org.apache.commons » collections » [javadoc | source]
org.apache.commons.collections
public class: FastTreeMap [javadoc | source]
java.lang.Object
   java.util.AbstractMap
      java.util.TreeMap
         org.apache.commons.collections.FastTreeMap

All Implemented Interfaces:
    NavigableMap, Serializable, Cloneable, Map

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  TreeMap map    The underlying map we are managing. 
protected  boolean fast    Are we operating in "fast" mode? 
Constructor:
 public FastTreeMap() 
 public FastTreeMap(Comparator comparator) 
    Construct an empty map with the specified comparator.
    Parameters:
    comparator - the comparator to use for ordering tree elements
 public FastTreeMap(Map map) 
    Construct a new map with the same mappings as the specified map, sorted according to the keys's natural order
    Parameters:
    map - the map whose mappings are to be copied
 public FastTreeMap(SortedMap map) 
    Construct a new map with the same mappings as the specified map, sorted according to the same ordering
    Parameters:
    map - the map whose mappings are to be copied
Method from org.apache.commons.collections.FastTreeMap Summary:
clear,   clone,   comparator,   containsKey,   containsValue,   entrySet,   equals,   firstKey,   get,   getFast,   hashCode,   headMap,   isEmpty,   keySet,   lastKey,   put,   putAll,   remove,   setFast,   size,   subMap,   tailMap,   values
Methods from java.util.TreeMap:
ceilingEntry,   ceilingKey,   clear,   clone,   comparator,   containsKey,   containsValue,   descendingKeySet,   descendingMap,   entrySet,   firstEntry,   firstKey,   floorEntry,   floorKey,   get,   headMap,   headMap,   higherEntry,   higherKey,   keySet,   lastEntry,   lastKey,   lowerEntry,   lowerKey,   navigableKeySet,   pollFirstEntry,   pollLastEntry,   put,   putAll,   remove,   size,   subMap,   subMap,   tailMap,   tailMap,   values
Methods from java.util.AbstractMap:
clear,   containsKey,   containsValue,   entrySet,   equals,   get,   hashCode,   isEmpty,   keySet,   put,   putAll,   remove,   size,   toString,   values
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.collections.FastTreeMap Detail:
 public  void clear() 
    Remove all mappings from this map.
 public Object clone() 
    Return a shallow copy of this FastTreeMap instance. The keys and values themselves are not copied.
 public Comparator comparator() 
    Return the comparator used to order this map, or null if this map uses its keys' natural order.
 public boolean containsKey(Object key) 
    Return true if this map contains a mapping for the specified key.
 public boolean containsValue(Object value) 
    Return true if this map contains one or more keys mapping to the specified value.
 public Set entrySet() 
    Return a collection view of the mappings contained in this map. Each element in the returned collection is a Map.Entry.
 public boolean equals(Object o) 
    Compare the specified object with this list for equality. This implementation uses exactly the code that is used to define the list equals function in the documentation for the Map.equals method.
 public Object firstKey() 
    Return the first (lowest) key currently in this sorted map.
 public Object get(Object key) 
    Return the value to which this map maps the specified key. Returns 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.
 public boolean getFast() 
    Returns true if this map is operating in fast mode.
 public int hashCode() 
    Return the hash code value for this map. This implementation uses exactly the code that is used to define the list hash function in the documentation for the Map.hashCode method.
 public SortedMap headMap(Object key) 
    Return a view of the portion of this map whose keys are strictly less than the specified key.
 public boolean isEmpty() 
    Return true if this map contains no mappings.
 public Set keySet() 
    Return a set view of the keys contained in this map.
 public Object lastKey() 
    Return the last (highest) key currently in this sorted map.
 public Object put(Object key,
    Object value) 
    Associate the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced and returned.
 public  void putAll(Map in) 
    Copy all of the mappings from the specified map to this one, replacing any mappings with the same keys.
 public Object remove(Object key) 
    Remove any mapping for this key, and return any previously mapped value.
 public  void setFast(boolean fast) 
    Sets whether this map is operating in fast mode.
 public int size() 
    Return the number of key-value mappings in this map.
 public SortedMap subMap(Object fromKey,
    Object toKey) 
    Return a view of the portion of this map whose keys are in the range fromKey (inclusive) to toKey (exclusive).
 public SortedMap tailMap(Object key) 
    Return a view of the portion of this map whose keys are greater than or equal to the specified key.
 public Collection values() 
    Return a collection view of the values contained in this map.