NavigableSet implementation based on a TreeMap.
The elements are ordered using their 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 .
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.
ConcurrentModificationException
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.
<E> the type of elements maintained by this setCollectionSetHashSetjava.lang.ComparableComparatorTreeMapjava.lang.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 call will throw a
ClassCastException.
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 call will throw a ClassCastException.
comparator the comparator that will be used to order this set.
If null, the natural
ordering of the elements will be used.java.lang.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.
c collection whose elements will comprise the new setjava.lang.ClassCastException if the elements in c are
not java.lang.Comparable, or are not mutually comparablejava.lang.NullPointerException if the specified collection is nulls sorted set whose elements will comprise the new setjava.lang.NullPointerException if the specified sorted set is nulltrue if this set contains the specified element.
More formally, returns true if and only if this set
contains an element e such that
(o==null ? e==null : o.equals(e)).
o object to be checked for containment in this settrue if this set contains the specified elementjava.lang.ClassCastException if the specified object cannot be compared
with the elements currently in the setjava.lang.NullPointerException if the specified element is null
and this set uses natural ordering, or its comparator
does not permit null elementse to this set if
the set contains no element e2 such that
(e==null ? e2==null : e.equals(e2)).
If this set already contains the element, the call leaves the set
unchanged and returns false.
e element to be added to this settrue if this set did not already contain the specified
elementjava.lang.ClassCastException if the specified object cannot be compared
with the elements currently in this setjava.lang.NullPointerException if the specified element is null
and this set uses natural ordering, or its comparator
does not permit null elementse such that
(o==null ? e==null : o.equals(e)),
if this set contains such an element. Returns true if
this set contained the element (or equivalently, if this set
changed as a result of the call). (This set will not contain the
element once the call returns.)
o object to be removed from this set, if presenttrue if this set contained the specified elementjava.lang.ClassCastException if the specified object cannot be compared
with the elements currently in this setjava.lang.NullPointerException if the specified element is null
and this set uses natural ordering, or its comparator
does not permit null elementsc collection containing elements to be added to this settrue if this set changed as a result of the calljava.lang.ClassCastException if the elements provided cannot be compared
with the elements currently in the setjava.lang.NullPointerException if the specified collection is null or
if any element is null and this set uses natural ordering, or
its comparator does not permit null elementsjava.lang.ClassCastExceptionjava.lang.NullPointerException if fromElement or toElement
is null and this set uses natural ordering, or its comparator
does not permit null elementsjava.lang.IllegalArgumentExceptionjava.lang.ClassCastExceptionjava.lang.NullPointerException if toElement is null and
this set uses natural ordering, or its comparator does
not permit null elementsjava.lang.IllegalArgumentExceptionjava.lang.ClassCastExceptionjava.lang.NullPointerException if fromElement is null and
this set uses natural ordering, or its comparator does
not permit null elementsjava.lang.IllegalArgumentExceptionjava.lang.ClassCastExceptionjava.lang.NullPointerException if fromElement or
toElement is null and this set uses natural ordering,
or its comparator does not permit null elementsjava.lang.IllegalArgumentExceptionjava.lang.ClassCastExceptionjava.lang.NullPointerException if toElement is null
and this set uses natural ordering, or its comparator does
not permit null elementsjava.lang.IllegalArgumentExceptionjava.lang.ClassCastExceptionjava.lang.NullPointerException if fromElement is null
and this set uses natural ordering, or its comparator does
not permit null elementsjava.lang.IllegalArgumentExceptionjava.lang.ClassCastExceptionjava.lang.NullPointerException if the specified element is null
and this set uses natural ordering, or its comparator
does not permit null elementsjava.lang.ClassCastExceptionjava.lang.NullPointerException if the specified element is null
and this set uses natural ordering, or its comparator
does not permit null elementsjava.lang.ClassCastExceptionjava.lang.NullPointerException if the specified element is null
and this set uses natural ordering, or its comparator
does not permit null elementsjava.lang.ClassCastExceptionjava.lang.NullPointerException if the specified element is null
and this set uses natural ordering, or its comparator
does not permit null elementsTreeSet instance to a stream (that is,
serialize it).
null if it obeys its elements' natural ordering
(Object), followed by the size of the set (the number of
elements it contains) (int), followed by all of its
elements (each an Object) in order (as determined by the
set's Comparator, or by the elements' natural ordering if
the set has no Comparator).