Java Doc for TreeSet.java in  » 6.0-JDK-Modules » j2me » java » util » 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 » 6.0 JDK Modules » j2me » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.AbstractCollection
      java.util.AbstractSet
         java.util.TreeSet

TreeSet
public class TreeSet extends AbstractSet implements SortedSet,Cloneable,java.io.Serializable(Code)
This class implements the Set interface, backed by a TreeMap instance. This class guarantees that the sorted set will be in ascending element order, sorted according to the natural order of the elements (see Comparable), or by the comparator provided at set creation time, depending on which constructor is used.

This implementation provides guaranteed log(n) time cost for the basic operations (add, remove and contains).

Note that the ordering maintained by a set (whether or not an explicit comparator is provided) must be consistent with equals if it is to correctly implement the Set interface. (See Comparable or Comparator for a precise definition of consistent with equals.) This is so because the Set interface is defined in terms of the equals operation, but a TreeSet instance performs all key comparisons using its compareTo (or compare) method, so two keys that are deemed equal by this method are, from the standpoint of the set, equal. The behavior of a set is well-defined even if its ordering is inconsistent with equals; it just fails to obey the general contract of the Set interface.

Note that this implementation is not synchronized. If multiple threads access a set concurrently, and at least one of the threads modifies the set, it must be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the set. If no such object exists, the set should be "wrapped" using the Collections.synchronizedSet method. This is best done at creation time, to prevent accidental unsynchronized access to the set:

 SortedSet s = Collections.synchronizedSortedSet(new TreeSet(...));
 

The Iterators returned by this class's iterator method are fail-fast: if the set is modified at any time after the iterator is created, in any way except through the iterator's own remove method, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

This class is a member of the Java Collections Framework.
author:
   Josh Bloch
version:
   1.20, 02/02/00
See Also:   Collection
See Also:   Set
See Also:   HashSet
See Also:   Comparable
See Also:   Comparator
See Also:   Collections.synchronizedSortedSet(SortedSet)
See Also:   TreeMap
since:
   1.2




Constructor Summary
public  TreeSet()
     Constructs a new, empty set, sorted according to the elements' natural order.
public  TreeSet(Comparator c)
     Constructs a new, empty set, sorted according to the specified comparator.
public  TreeSet(Collection c)
     Constructs a new set containing the elements in the specified collection, sorted according to the elements' natural order. All keys inserted into the set must implement the Comparable interface.
public  TreeSet(SortedSet s)
     Constructs a new set containing the same elements as the specified sorted set, sorted according to the same ordering.

Method Summary
public  booleanadd(Object o)
     Adds the specified element to this set if it is not already present.
Parameters:
  o - element to be added to this set.
public  booleanaddAll(Collection c)
     Adds all of the elements in the specified collection to this set.
public  voidclear()
     Removes all of the elements from this set.
public  Objectclone()
     Returns a shallow copy of this TreeSet instance.
public  Comparatorcomparator()
     Returns the comparator used to order this sorted set, or null if this tree set uses its elements natural ordering.
public  booleancontains(Object o)
     Returns true if this set contains the specified element.
Parameters:
  o - the object to be checked for containment in this set.
public  Objectfirst()
     Returns the first (lowest) element currently in this sorted set.
public  SortedSetheadSet(Object toElement)
     Returns a view of the portion of this set whose elements are strictly less than toElement.
public  booleanisEmpty()
     Returns true if this set contains no elements.
public  Iteratoriterator()
     Returns an iterator over the elements in this set.
public  Objectlast()
     Returns the last (highest) element currently in this sorted set.
public  booleanremove(Object o)
     Removes the specified element from this set if it is present.
Parameters:
  o - object to be removed from this set, if present.
public  intsize()
     Returns the number of elements in this set (its cardinality).
public  SortedSetsubSet(Object fromElement, Object toElement)
     Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.
public  SortedSettailSet(Object fromElement)
     Returns a view of the portion of this set whose elements are greater than or equal to fromElement.


Constructor Detail
TreeSet
public TreeSet()(Code)
Constructs a new, empty set, sorted according to the elements' natural order. All elements inserted into the set must implement the Comparable interface. Furthermore, all such elements must be mutually comparable: e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the set. If the user attempts to add an element to the set that violates this constraint (for example, the user attempts to add a string element to a set whose elements are integers), the add(Object) call will throw a ClassCastException.
See Also:   Comparable



TreeSet
public TreeSet(Comparator c)(Code)
Constructs a new, empty set, sorted according to the specified comparator. All elements inserted into the set must be mutually comparable by the specified comparator: comparator.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the set. If the user attempts to add an element to the set that violates this constraint, the add(Object) call will throw a ClassCastException.
Parameters:
  c - the comparator that will be used to sort this set. Anull value indicates that the elements' naturalordering should be used.



TreeSet
public TreeSet(Collection c)(Code)
Constructs a new set containing the elements in the specified collection, sorted according to the elements' natural order. All keys inserted into the set must implement the Comparable interface. Furthermore, all such keys must be mutually comparable: k1.compareTo(k2) must not throw a ClassCastException for any elements k1 and k2 in the set.
Parameters:
  c - The elements that will comprise the new set.
throws:
  ClassCastException - if the keys in the specified collection arenot comparable, or are not mutually comparable.
throws:
  NullPointerException - if the specified collection is null.



TreeSet
public TreeSet(SortedSet s)(Code)
Constructs a new set containing the same elements as the specified sorted set, sorted according to the same ordering.
Parameters:
  s - sorted set whose elements will comprise the new set.
throws:
  NullPointerException - if the specified sorted set is null.




Method Detail
add
public boolean add(Object o)(Code)
Adds the specified element to this set if it is not already present.
Parameters:
  o - element to be added to this set. true if the set did not already contain the specifiedelement.
throws:
  ClassCastException - if the specified object cannot be comparedwith the elements currently in the set.



addAll
public boolean addAll(Collection c)(Code)
Adds all of the elements in the specified collection to this set.
Parameters:
  c - elements to be added true if this set changed as a result of the call.
throws:
  ClassCastException - if the elements provided cannot be comparedwith the elements currently in the set.
throws:
  NullPointerException - of the specified collection is null.



clear
public void clear()(Code)
Removes all of the elements from this set.



clone
public Object clone()(Code)
Returns a shallow copy of this TreeSet instance. (The elements themselves are not cloned.) a shallow copy of this set.



comparator
public Comparator comparator()(Code)
Returns the comparator used to order this sorted set, or null if this tree set uses its elements natural ordering. the comparator used to order this sorted set, or nullif this tree set uses its elements natural ordering.



contains
public boolean contains(Object o)(Code)
Returns true if this set contains the specified element.
Parameters:
  o - the object to be checked for containment in this set. true if this set contains the specified element.
throws:
  ClassCastException - if the specified object cannot be comparedwith the elements currently in the set.



first
public Object first()(Code)
Returns the first (lowest) element currently in this sorted set. the first (lowest) element currently in this sorted set.
throws:
  NoSuchElementException - sorted set is empty.



headSet
public SortedSet headSet(Object toElement)(Code)
Returns a view of the portion of this set whose elements are strictly less than toElement. The returned sorted set is backed by this set, so changes in the returned sorted set are reflected in this set, and vice-versa. The returned sorted set supports all optional set operations.

The sorted set returned by this method will throw an IllegalArgumentException if the user attempts to insert an element greater than or equal to toElement.

Note: this method always returns a view that does not contain its (high) endpoint. If you need a view that does contain this endpoint, and the element type allows for calculation of the successor of a specified value, merely request a headSet bounded by successor(highEndpoint). For example, suppose that s is a sorted set of strings. The following idiom obtains a view containing all of the strings in s that are less than or equal to high:

 SortedSet head = s.headSet(high+"\0");

Parameters:
  toElement - high endpoint (exclusive) of the headSet. a view of the portion of this set whose elements are strictlyless than toElement.
throws:
  ClassCastException - if toElement is not compatiblewith this set's comparator (or, if the set has no comparator,if toElement does not implement Comparable).
throws:
  IllegalArgumentException - if this set is itself a subSet,headSet, or tailSet, and toElement is not within thespecified range of the subSet, headSet, or tailSet.
throws:
  NullPointerException - if toElement is null andthis set uses natural ordering, or its comparator doesnot tolerate null elements.



isEmpty
public boolean isEmpty()(Code)
Returns true if this set contains no elements. true if this set contains no elements.



iterator
public Iterator iterator()(Code)
Returns an iterator over the elements in this set. The elements are returned in ascending order. an iterator over the elements in this set.



last
public Object last()(Code)
Returns the last (highest) element currently in this sorted set. the last (highest) element currently in this sorted set.
throws:
  NoSuchElementException - sorted set is empty.



remove
public boolean remove(Object o)(Code)
Removes the specified element from this set if it is present.
Parameters:
  o - object to be removed from this set, if present. true if the set contained the specified element.
throws:
  ClassCastException - if the specified object cannot be comparedwith the elements currently in the set.



size
public int size()(Code)
Returns the number of elements in this set (its cardinality). the number of elements in this set (its cardinality).



subSet
public SortedSet subSet(Object fromElement, Object toElement)(Code)
Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (If fromElement and toElement are equal, the returned sorted set is empty.) The returned sorted set is backed by this set, so changes in the returned sorted set are reflected in this set, and vice-versa. The returned sorted set supports all optional Set operations.

The sorted set returned by this method will throw an IllegalArgumentException if the user attempts to insert an element outside the specified range.

Note: this method always returns a half-open range (which includes its low endpoint but not its high endpoint). If you need a closed range (which includes both endpoints), and the element type allows for calculation of the successor of a specified value, merely request the subrange from lowEndpoint to successor(highEndpoint). For example, suppose that s is a sorted set of strings. The following idiom obtains a view containing all of the strings in s from low to high, inclusive:

 SortedSet sub = s.subSet(low, high+"\0");
 
A similar technique can be used to generate an open range (which contains neither endpoint). The following idiom obtains a view containing all of the strings in s from low to high, exclusive:
 SortedSet sub = s.subSet(low+"\0", high);
 

Parameters:
  fromElement - low endpoint (inclusive) of the subSet.
Parameters:
  toElement - high endpoint (exclusive) of the subSet. a view of the portion of this set whose elements range fromfromElement, inclusive, to toElement,exclusive.
throws:
  ClassCastException - if fromElement andtoElement cannot be compared to one another usingthis set's comparator (or, if the set has no comparator,using natural ordering).
throws:
  IllegalArgumentException - if fromElement is greater thantoElement.
throws:
  NullPointerException - if fromElement ortoElement is null and this set uses naturalorder, or its comparator does not tolerate nullelements.



tailSet
public SortedSet tailSet(Object fromElement)(Code)
Returns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned sorted set is backed by this set, so changes in the returned sorted set are reflected in this set, and vice-versa. The returned sorted set supports all optional set operations.

The sorted set returned by this method will throw an IllegalArgumentException if the user attempts to insert an element less than fromElement. Note: this method always returns a view that contains its (low) endpoint. If you need a view that does not contain this endpoint, and the element type allows for calculation of the successor of a specified value, merely request a tailSet bounded by successor(lowEndpoint). For example, suppose that s is a sorted set of strings. The following idiom obtains a view containing all of the strings in s that are strictly greater than low:

 SortedSet tail = s.tailSet(low+"\0");
 

Parameters:
  fromElement - low endpoint (inclusive) of the tailSet. a view of the portion of this set whose elements aregreater than or equal to fromElement.
throws:
  ClassCastException - if fromElement is not compatiblewith this set's comparator (or, if the set has no comparator,if fromElement does not implement Comparable).
throws:
  IllegalArgumentException - if this set is itself a subSet,headSet, or tailSet, and fromElement is not within thespecified range of the subSet, headSet, or tailSet.
throws:
  NullPointerException - if fromElement is nulland this set uses natural ordering, or its comparator doesnot tolerate null elements.



Methods inherited from java.util.AbstractSet
public boolean equals(Object o)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean removeAll(Collection c)(Code)(Java Doc)

Methods inherited from java.util.AbstractCollection
public boolean add(Object o)(Code)(Java Doc)
public boolean addAll(Collection c)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public boolean contains(Object o)(Code)(Java Doc)
public boolean containsAll(Collection c)(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
abstract public Iterator iterator()(Code)(Java Doc)
public boolean remove(Object o)(Code)(Java Doc)
public boolean removeAll(Collection c)(Code)(Java Doc)
public boolean retainAll(Collection c)(Code)(Java Doc)
abstract public int size()(Code)(Java Doc)
public Object[] toArray()(Code)(Java Doc)
public Object[] toArray(Object a)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.