Java Doc for FastTreeMap.java in  » Library » Apache-common-Collections » org » apache » commons » collections » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » Apache common Collections » org.apache.commons.collections 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.util.TreeMap
   org.apache.commons.collections.FastTreeMap

FastTreeMap
public class FastTreeMap extends TreeMap (Code)

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:

  • Clone the existing collection
  • Perform the modification on the clone
  • Replace the existing collection with the (modified) clone

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.


since:
   Commons Collections 1.0
version:
   $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
   Craig R. McClanahan
author:
   Stephen Colebourne


Field Summary
protected  booleanfast
    
protected  TreeMapmap
     The underlying map we are managing.

Constructor Summary
public  FastTreeMap()
     Construct a an empty map.
public  FastTreeMap(Comparator comparator)
     Construct an empty map with the specified comparator.
public  FastTreeMap(Map map)
    
public  FastTreeMap(SortedMap map)
    

Method Summary
public  voidclear()
     Remove all mappings from this map.
public  Objectclone()
     Return a shallow copy of this FastTreeMap instance.
public  Comparatorcomparator()
     Return the comparator used to order this map, or null if this map uses its keys' natural order.
public  booleancontainsKey(Object key)
     Return true if this map contains a mapping for the specified key.
public  booleancontainsValue(Object value)
     Return true if this map contains one or more keys mapping to the specified value.
public  SetentrySet()
     Return a collection view of the mappings contained in this map.
public  booleanequals(Object o)
     Compare the specified object with this list for equality.
public  ObjectfirstKey()
     Return the first (lowest) key currently in this sorted map.
public  Objectget(Object key)
     Return the value to which this map maps the specified key.
public  booleangetFast()
     Returns true if this map is operating in fast mode.
public  inthashCode()
     Return the hash code value for this map.
public  SortedMapheadMap(Object key)
     Return a view of the portion of this map whose keys are strictly less than the specified key.
public  booleanisEmpty()
     Return true if this map contains no mappings.
public  SetkeySet()
     Return a set view of the keys contained in this map.
public  ObjectlastKey()
     Return the last (highest) key currently in this sorted map.
public  Objectput(Object key, Object value)
     Associate the specified value with the specified key in this map.
public  voidputAll(Map in)
     Copy all of the mappings from the specified map to this one, replacing any mappings with the same keys.
public  Objectremove(Object key)
     Remove any mapping for this key, and return any previously mapped value.
public  voidsetFast(boolean fast)
     Sets whether this map is operating in fast mode.
public  intsize()
     Return the number of key-value mappings in this map.
public  SortedMapsubMap(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  SortedMaptailMap(Object key)
     Return a view of the portion of this map whose keys are greater than or equal to the specified key.
public  Collectionvalues()
     Return a collection view of the values contained in this map.

Field Detail
fast
protected boolean fast(Code)
Are we operating in "fast" mode?



map
protected TreeMap map(Code)
The underlying map we are managing.




Constructor Detail
FastTreeMap
public FastTreeMap()(Code)
Construct a an empty map.



FastTreeMap
public FastTreeMap(Comparator comparator)(Code)
Construct an empty map with the specified comparator.
Parameters:
  comparator - the comparator to use for ordering tree elements



FastTreeMap
public FastTreeMap(Map map)(Code)
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



FastTreeMap
public FastTreeMap(SortedMap map)(Code)
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 Detail
clear
public void clear()(Code)
Remove all mappings from this map.



clone
public Object clone()(Code)
Return a shallow copy of this FastTreeMap instance. The keys and values themselves are not copied. a clone of this map



comparator
public Comparator comparator()(Code)
Return the comparator used to order this map, or null if this map uses its keys' natural order. the comparator used to order the map, or null if natural order



containsKey
public boolean containsKey(Object key)(Code)
Return true if this map contains a mapping for the specified key.
Parameters:
  key - the key to be searched for true if the map contains the key



containsValue
public boolean containsValue(Object value)(Code)
Return true if this map contains one or more keys mapping to the specified value.
Parameters:
  value - the value to be searched for true if the map contains the value



entrySet
public Set entrySet()(Code)
Return a collection view of the mappings contained in this map. Each element in the returned collection is a Map.Entry.



equals
public boolean equals(Object o)(Code)
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.
Parameters:
  o - the object to be compared to this list true if the two maps are equal



firstKey
public Object firstKey()(Code)
Return the first (lowest) key currently in this sorted map. the first key in the map



get
public Object get(Object key)(Code)
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.
Parameters:
  key - the key whose value is to be returned the value mapped to that key, or null



getFast
public boolean getFast()(Code)
Returns true if this map is operating in fast mode. true if this map is operating in fast mode



hashCode
public int hashCode()(Code)
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. a suitable integer hash code



headMap
public SortedMap headMap(Object key)(Code)
Return a view of the portion of this map whose keys are strictly less than the specified key.
Parameters:
  key - Key higher than any in the returned map a head map



isEmpty
public boolean isEmpty()(Code)
Return true if this map contains no mappings. is the map currently empty



keySet
public Set keySet()(Code)
Return a set view of the keys contained in this map.



lastKey
public Object lastKey()(Code)
Return the last (highest) key currently in this sorted map. the last key in the map



put
public Object put(Object key, Object value)(Code)
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.
Parameters:
  key - the key with which the value is to be associated
Parameters:
  value - the value to be associated with this key the value previously mapped to the key, or null



putAll
public void putAll(Map in)(Code)
Copy all of the mappings from the specified map to this one, replacing any mappings with the same keys.
Parameters:
  in - the map whose mappings are to be copied



remove
public Object remove(Object key)(Code)
Remove any mapping for this key, and return any previously mapped value.
Parameters:
  key - the key whose mapping is to be removed the value removed, or null



setFast
public void setFast(boolean fast)(Code)
Sets whether this map is operating in fast mode.
Parameters:
  fast - true if this map should operate in fast mode



size
public int size()(Code)
Return the number of key-value mappings in this map. the current size of the map



subMap
public SortedMap subMap(Object fromKey, Object toKey)(Code)
Return a view of the portion of this map whose keys are in the range fromKey (inclusive) to toKey (exclusive).
Parameters:
  fromKey - Lower limit of keys for the returned map
Parameters:
  toKey - Upper limit of keys for the returned map a sub map



tailMap
public SortedMap tailMap(Object key)(Code)
Return a view of the portion of this map whose keys are greater than or equal to the specified key.
Parameters:
  key - Key less than or equal to any in the returned map a tail map



values
public Collection values()(Code)
Return a collection view of the values contained in this map.



Methods inherited from java.util.TreeMap
public Map.Entry<K, V> ceilingEntry(K key)(Code)(Java Doc)
public K ceilingKey(K key)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
public Comparator<? super K> comparator()(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsValue(Object value)(Code)(Java Doc)
public NavigableSet<K> descendingKeySet()(Code)(Java Doc)
public NavigableMap<K, V> descendingMap()(Code)(Java Doc)
public Set<Map.Entry<K, V>> entrySet()(Code)(Java Doc)
public Map.Entry<K, V> firstEntry()(Code)(Java Doc)
public K firstKey()(Code)(Java Doc)
public Map.Entry<K, V> floorEntry(K key)(Code)(Java Doc)
public K floorKey(K key)(Code)(Java Doc)
public V get(Object key)(Code)(Java Doc)
public NavigableMap<K, V> headMap(K toKey, boolean inclusive)(Code)(Java Doc)
public SortedMap<K, V> headMap(K toKey)(Code)(Java Doc)
public Map.Entry<K, V> higherEntry(K key)(Code)(Java Doc)
public K higherKey(K key)(Code)(Java Doc)
public Set<K> keySet()(Code)(Java Doc)
public Map.Entry<K, V> lastEntry()(Code)(Java Doc)
public K lastKey()(Code)(Java Doc)
public Map.Entry<K, V> lowerEntry(K key)(Code)(Java Doc)
public K lowerKey(K key)(Code)(Java Doc)
public NavigableSet<K> navigableKeySet()(Code)(Java Doc)
public Map.Entry<K, V> pollFirstEntry()(Code)(Java Doc)
public Map.Entry<K, V> pollLastEntry()(Code)(Java Doc)
public V put(K key, V value)(Code)(Java Doc)
public void putAll(Map<? extends K, ? extends V> map)(Code)(Java Doc)
public V remove(Object key)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public NavigableMap<K, V> subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)(Code)(Java Doc)
public SortedMap<K, V> subMap(K fromKey, K toKey)(Code)(Java Doc)
public NavigableMap<K, V> tailMap(K fromKey, boolean inclusive)(Code)(Java Doc)
public SortedMap<K, V> tailMap(K fromKey)(Code)(Java Doc)
public Collection<V> values()(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.