TreeSet

public class TreeSet extends AbstractSet<E>
implements NavigableSet<E> Cloneable Serializable

A NavigableSet implementation based on a TreeMap. The elements are ordered using their {@linkplain Comparable natural ordering}, or by a 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 element comparisons using its compareTo (or compare) method, so two elements 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 tree 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.synchronizedSortedSet 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.

Public Constructor Summary

TreeSet()
Constructs a new, empty tree set, sorted according to the natural ordering of its elements.
TreeSet(Comparator<? super E> comparator)
Constructs a new, empty tree set, sorted according to the specified comparator.
TreeSet(Collection<? extends E> c)
Constructs a new tree set containing the elements in the specified collection, sorted according to the natural ordering of its elements.
TreeSet(SortedSet<E> s)
Constructs a new tree set containing the same elements and using the same ordering as the specified sorted set.

Public Method Summary

boolean
add(E e)
Adds the specified element to this set if it is not already present.
boolean
addAll(Collection<? extends E> c)
Adds all of the elements in the specified collection to this set.
E
ceiling(E e)
Returns the least element in this set greater than or equal to the given element, or null if there is no such element.
void
clear()
Removes all of the elements from this set.
Object
clone()
Returns a shallow copy of this TreeSet instance.
Comparator<? super E>
comparator()
Returns the comparator used to order the elements in this set, or null if this set uses the {@linkplain Comparable natural ordering} of its elements.
boolean
contains(Object o)
Returns true if this set contains the specified element.
Iterator<E>
descendingIterator()
Returns an iterator over the elements in this set in descending order.
NavigableSet<E>
descendingSet()
Returns a reverse order view of the elements contained in this set.
E
first()
Returns the first (lowest) element currently in this set.
E
floor(E e)
Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.
NavigableSet<E>
headSet(E toElement, boolean inclusive)
Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement.
SortedSet<E>
headSet(E toElement)
Returns a view of the portion of this set whose elements are strictly less than toElement.

Equivalent to headSet(toElement, false).

E
higher(E e)
Returns the least element in this set strictly greater than the given element, or null if there is no such element.
boolean
isEmpty()
Returns true if this set contains no elements.
Iterator<E>
iterator()
Returns an iterator over the elements in this set in ascending order.
E
last()
Returns the last (highest) element currently in this set.
E
lower(E e)
Returns the greatest element in this set strictly less than the given element, or null if there is no such element.
E
pollFirst()
Retrieves and removes the first (lowest) element, or returns null if this set is empty.
E
pollLast()
Retrieves and removes the last (highest) element, or returns null if this set is empty.
boolean
remove(Object o)
Removes the specified element from this set if it is present.
int
size()
Returns the number of elements in this set (its cardinality).
Spliterator<E>
spliterator()
Creates a late-binding and fail-fast Spliterator over the elements in this set.
NavigableSet<E>
subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
Returns a view of the portion of this set whose elements range from fromElement to toElement.
SortedSet<E>
subSet(E fromElement, E toElement)
Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.

Equivalent to subSet(fromElement, true, toElement, false).

NavigableSet<E>
tailSet(E fromElement, boolean inclusive)
Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement.
SortedSet<E>
tailSet(E fromElement)
Returns a view of the portion of this set whose elements are greater than or equal to fromElement.

Equivalent to tailSet(fromElement, true).

Inherited Method Summary