- Description
- Constructor Summary
- Method Summary
- Methods declared in class AbstractSet
- Methods declared in class AbstractCollection
- Methods declared in class Object
- Methods declared in interface Collection
- Methods declared in interface Iterable
- Methods declared in interface NavigableSet
- Methods declared in interface Set
- Methods declared in interface SortedSet
- Constructor Details
- Method Details
- iterator()
- descendingIterator()
- descendingSet()
- size()
- isEmpty()
- contains(Object)
- add(E)
- remove(Object)
- clear()
- addAll(Collection)
- subSet(E, boolean, E, boolean)
- headSet(E, boolean)
- tailSet(E, boolean)
- subSet(E, E)
- headSet(E)
- tailSet(E)
- comparator()
- first()
- last()
- lower(E)
- floor(E)
- ceiling(E)
- higher(E)
- pollFirst()
- pollLast()
- addFirst(E)
- addLast(E)
- clone()
- spliterator()
Class TreeSet<E>
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.
The addFirst and addLast methods of this class throw UnsupportedOperationException. The encounter order of elements is determined by the comparison method; therefore, explicit positioning is not supported.
This class is a member of the Java Collections Framework.
-
Constructor Summary
ConstructorsConstructorDescriptionTreeSet()Constructs a new, empty tree set, sorted according to the natural ordering of its elements.Constructs a new tree set containing the elements in the specified collection, sorted according to the natural ordering of its elements.Constructs a new, empty tree set, sorted according to the specified comparator.Constructs a new tree set containing the same elements and using the same ordering as the specified sorted set. -
Method Summary
All MethodsInstance MethodsConcrete MethodsModifier and TypeMethodDescriptionbooleanAdds the specified element to this set if it is not already present.booleanAdds all of the elements in the specified collection to this set.voidThrows UnsupportedOperationException.voidThrows UnsupportedOperationException.Returns the least element in this set greater than or equal to the given element, or null if there is no such element.voidclear()Removes all of the elements from this set.clone()Returns a shallow copy of this TreeSet instance.Comparator<? super E>Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.booleanReturns true if this set contains the specified element.Returns an iterator over the elements in this set in descending order.Returns a reverse order view of the elements contained in this set.first()Returns the first (lowest) element currently in this set.Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.Returns a view of the portion of this set whose elements are strictly less than toElement.Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement.Returns the least element in this set strictly greater than the given element, or null if there is no such element.booleanisEmpty()Returns true if this set contains no elements.iterator()Returns an iterator over the elements in this set in ascending order.last()Returns the last (highest) element currently in this set.Returns the greatest element in this set strictly less than the given element, or null if there is no such element.Retrieves and removes the first (lowest) element, or returns null if this set is empty (optional operation).pollLast()Retrieves and removes the last (highest) element, or returns null if this set is empty (optional operation).booleanRemoves the specified element from this set if it is present.intsize()Returns the number of elements in this set (its cardinality).Creates a late-binding and fail-fast Spliterator over the elements in this set.Returns a view of the portion of this set whose elements range from fromElement to toElement.Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive.Returns a view of the portion of this set whose elements are greater than or equal to fromElement.Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement.Methods declared in class AbstractSet
equals, hashCode, removeAllModifier and TypeMethodDescriptionbooleanCompares the specified object with this set for equality.inthashCode()Returns the hash code value for this set.booleanremoveAll(Collection<?> c)Removes from this set all of its elements that are contained in the specified collection (optional operation).Methods declared in class AbstractCollection
containsAll, retainAll, toArray, toArray, toStringModifier and TypeMethodDescriptionbooleancontainsAll(Collection<?> c)Returns true if this collection contains all of the elements in the specified collection.booleanretainAll(Collection<?> c)Retains only the elements in this collection that are contained in the specified collection (optional operation).Object[]toArray()Returns an array containing all of the elements in this collection.<T> T[]toArray(T[] a)Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.toString()Returns a string representation of this collection.Methods declared in class Object
finalize, getClass, notify, notifyAll, wait, wait, waitModifier and TypeMethodDescriptionprotected voidfinalize()Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class<?>getClass()Returns the runtime class of this Object.final voidnotify()Wakes up a single thread that is waiting on this object's monitor.final voidWakes up all threads that are waiting on this object's monitor.final voidwait()Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final voidwait(long timeoutMillis)Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final voidwait(long timeoutMillis, int nanos)Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.Methods declared in interface Collection
parallelStream, removeIf, stream, toArrayModifier and TypeMethodDescriptionReturns a possibly parallel Stream with this collection as its source.default booleanRemoves all of the elements of this collection that satisfy the given predicate (optional operation).stream()Returns a sequential Stream with this collection as its source.default <T> T[]toArray(IntFunction<T[]> generator)Returns an array containing all of the elements in this collection, using the provided generator function to allocate the returned array.Methods declared in interface NavigableSet
removeFirst, removeLast, reversedMethods declared in interface Set
containsAll, retainAll, toArray, toArrayModifier and TypeMethodDescriptionbooleancontainsAll(Collection<?> c)Returns true if this set contains all of the elements of the specified collection.booleanretainAll(Collection<?> c)Retains only the elements in this set that are contained in the specified collection (optional operation).Object[]toArray()Returns an array containing all of the elements in this set.<T> T[]toArray(T[] a)Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
-
Constructor Details
-
TreeSet
public TreeSet()Constructs a new, empty tree set, sorted according to the natural ordering of its elements. 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 call will throw a ClassCastException. -
TreeSet
Constructs a new, empty tree 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 call will throw a ClassCastException.Parameters: comparator - the comparator that will be used to order this set. If null, the natural ordering of the elements will be used. -
TreeSet
Constructs a new tree set containing the elements in the specified collection, sorted according to the natural ordering of its elements. 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.Parameters: c - collection whose elements will comprise the new set Throws: ClassCastException - if the elements in c are not Comparable, or are not mutually comparable NullPointerException - if the specified collection is null -
TreeSet
Constructs a new tree set containing the same elements and using the same ordering as the specified sorted set.Parameters: s - sorted set whose elements will comprise the new set Throws: NullPointerException - if the specified sorted set is null
-
-
Method Details
-
iterator
Returns an iterator over the elements in this set in ascending order.Specified by: iterator in interface Collection<E> Specified by: iterator in interface Iterable<E> Specified by: iterator in interface NavigableSet<E> Specified by: iterator in interface Set<E> Specified by: iterator in class AbstractCollection<E> Returns: an iterator over the elements in this set in ascending order -
descendingIterator
Returns an iterator over the elements in this set in descending order.Specified by: descendingIterator in interface NavigableSet<E> Returns: an iterator over the elements in this set in descending order Since: 1.6 -
descendingSet
Description copied from interface: NavigableSetReturns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa. If either set is modified while an iteration over either set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.Specified by: descendingSet in interface NavigableSet<E> Returns: a reverse order view of this set Since: 1.6The returned set has an ordering equivalent to Collections.reverseOrder(comparator()). The expression s.descendingSet().descendingSet() returns a view of s essentially equivalent to s.
-
size
-
isEmpty
public boolean isEmpty()Returns true if this set contains no elements.Specified by: isEmpty in interface Collection<E> Specified by: isEmpty in interface Set<E> Overrides: isEmpty in class AbstractCollection<E> Returns: true if this set contains no elements -
contains
Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).Specified by: contains in interface Collection<E> Specified by: contains in interface Set<E> Overrides: contains in class AbstractCollection<E> Parameters: o - object to be checked for containment in this set Returns: true if this set contains the specified element Throws: ClassCastException - if the specified object cannot be compared with the elements currently in the set NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements -
add
Adds the specified element to this set if it is not already present. More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false.Specified by: add in interface Collection<E> Specified by: add in interface Set<E> Overrides: add in class AbstractCollection<E> Parameters: e - element to be added to this set Returns: true if this set did not already contain the specified element Throws: ClassCastException - if the specified object cannot be compared with the elements currently in this set NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements -
remove
Removes the specified element from this set if it is present. More formally, removes an element e such that Objects.equals(o, 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.)Specified by: remove in interface Collection<E> Specified by: remove in interface Set<E> Overrides: remove in class AbstractCollection<E> Parameters: o - object to be removed from this set, if present Returns: true if this set contained the specified element Throws: ClassCastException - if the specified object cannot be compared with the elements currently in this set NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements -
clear
public void clear()Removes all of the elements from this set. The set will be empty after this call returns.Specified by: clear in interface Collection<E> Specified by: clear in interface Set<E> Overrides: clear in class AbstractCollection<E> -
addAll
Adds all of the elements in the specified collection to this set.Specified by: addAll in interface Collection<E> Specified by: addAll in interface Set<E> Overrides: addAll in class AbstractCollection<E> Parameters: c - collection containing elements to be added to this set Returns: true if this set changed as a result of the call Throws: ClassCastException - if the elements provided cannot be compared with the elements currently in the set 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 elements See Also: -
subSet
public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)Description copied from interface: NavigableSetReturns a view of the portion of this set whose elements range from fromElement to toElement. If fromElement and toElement are equal, the returned set is empty unless fromInclusive and toInclusive are both true. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.Specified by: subSet in interface NavigableSet<E> Parameters: fromElement - low endpoint of the returned set fromInclusive - true if the low endpoint is to be included in the returned view toElement - high endpoint of the returned set toInclusive - true if the high endpoint is to be included in the returned view Returns: a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive Throws: ClassCastException - if fromElement and toElement cannot be compared to one another using this set's comparator (or, if the set has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromElement or toElement cannot be compared to elements currently in the set. NullPointerException - if fromElement or toElement is null and this set uses natural ordering, or its comparator does not permit null elements IllegalArgumentException - if fromElement is greater than toElement; or if this set itself has a restricted range, and fromElement or toElement lies outside the bounds of the range. Since: 1.6The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
-
headSet
Description copied from interface: NavigableSetReturns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.Specified by: headSet in interface NavigableSet<E> Parameters: toElement - high endpoint of the returned set inclusive - true if the high endpoint is to be included in the returned view Returns: a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement Throws: ClassCastException - if toElement is not compatible with this set's comparator (or, if the set has no comparator, if toElement does not implement Comparable). Implementations may, but are not required to, throw this exception if toElement cannot be compared to elements currently in the set. NullPointerException - if toElement is null and this set uses natural ordering, or its comparator does not permit null elements IllegalArgumentException - if this set itself has a restricted range, and toElement lies outside the bounds of the range Since: 1.6The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
-
tailSet
Description copied from interface: NavigableSetReturns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.Specified by: tailSet in interface NavigableSet<E> Parameters: fromElement - low endpoint of the returned set inclusive - true if the low endpoint is to be included in the returned view Returns: a view of the portion of this set whose elements are greater than or equal to fromElement Throws: ClassCastException - if fromElement is not compatible with this set's comparator (or, if the set has no comparator, if fromElement does not implement Comparable). Implementations may, but are not required to, throw this exception if fromElement cannot be compared to elements currently in the set. NullPointerException - if fromElement is null and this set uses natural ordering, or its comparator does not permit null elements IllegalArgumentException - if this set itself has a restricted range, and fromElement lies outside the bounds of the range Since: 1.6The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
-
subSet
Description copied from interface: NavigableSetReturns 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 set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.Specified by: subSet in interface NavigableSet<E> Specified by: subSet in interface SortedSet<E> Parameters: fromElement - low endpoint (inclusive) of the returned set toElement - high endpoint (exclusive) of the returned set Returns: a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive Throws: ClassCastException - if fromElement and toElement cannot be compared to one another using this set's comparator (or, if the set has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromElement or toElement cannot be compared to elements currently in the set. NullPointerException - if fromElement or toElement is null and this set uses natural ordering, or its comparator does not permit null elements IllegalArgumentException - if fromElement is greater than toElement; or if this set itself has a restricted range, and fromElement or toElement lies outside the bounds of the rangeThe returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
Equivalent to subSet(fromElement, true, toElement, false).
-
headSet
Description copied from interface: NavigableSetReturns a view of the portion of this set whose elements are strictly less than toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.Specified by: headSet in interface NavigableSet<E> Specified by: headSet in interface SortedSet<E> Parameters: toElement - high endpoint (exclusive) of the returned set Returns: a view of the portion of this set whose elements are strictly less than toElement Throws: ClassCastException - if toElement is not compatible with this set's comparator (or, if the set has no comparator, if toElement does not implement Comparable). Implementations may, but are not required to, throw this exception if toElement cannot be compared to elements currently in the set. NullPointerException - if toElement is null and this set uses natural ordering, or its comparator does not permit null elements IllegalArgumentException - if this set itself has a restricted range, and toElement lies outside the bounds of the rangeThe returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
Equivalent to headSet(toElement, false).
-
tailSet
Description copied from interface: NavigableSetReturns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.Specified by: tailSet in interface NavigableSet<E> Specified by: tailSet in interface SortedSet<E> Parameters: fromElement - low endpoint (inclusive) of the returned set Returns: a view of the portion of this set whose elements are greater than or equal to fromElement Throws: ClassCastException - if fromElement is not compatible with this set's comparator (or, if the set has no comparator, if fromElement does not implement Comparable). Implementations may, but are not required to, throw this exception if fromElement cannot be compared to elements currently in the set. NullPointerException - if fromElement is null and this set uses natural ordering, or its comparator does not permit null elements IllegalArgumentException - if this set itself has a restricted range, and fromElement lies outside the bounds of the rangeThe returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.
Equivalent to tailSet(fromElement, true).
-
comparator
Description copied from interface: SortedSetReturns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.Specified by: comparator in interface SortedSet<E> Returns: the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements -
first
-
last
-
lower
Description copied from interface: NavigableSetReturns the greatest element in this set strictly less than the given element, or null if there is no such element.Specified by: lower in interface NavigableSet<E> Parameters: e - the value to match Returns: the greatest element less than e, or null if there is no such element Throws: ClassCastException - if the specified element cannot be compared with the elements currently in the set NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements Since: 1.6 -
floor
Description copied from interface: NavigableSetReturns the greatest element in this set less than or equal to the given element, or null if there is no such element.Specified by: floor in interface NavigableSet<E> Parameters: e - the value to match Returns: the greatest element less than or equal to e, or null if there is no such element Throws: ClassCastException - if the specified element cannot be compared with the elements currently in the set NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements Since: 1.6 -
ceiling
Description copied from interface: NavigableSetReturns the least element in this set greater than or equal to the given element, or null if there is no such element.Specified by: ceiling in interface NavigableSet<E> Parameters: e - the value to match Returns: the least element greater than or equal to e, or null if there is no such element Throws: ClassCastException - if the specified element cannot be compared with the elements currently in the set NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements Since: 1.6 -
higher
Description copied from interface: NavigableSetReturns the least element in this set strictly greater than the given element, or null if there is no such element.Specified by: higher in interface NavigableSet<E> Parameters: e - the value to match Returns: the least element greater than e, or null if there is no such element Throws: ClassCastException - if the specified element cannot be compared with the elements currently in the set NullPointerException - if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements Since: 1.6 -
pollFirst
Description copied from interface: NavigableSetRetrieves and removes the first (lowest) element, or returns null if this set is empty (optional operation).Specified by: pollFirst in interface NavigableSet<E> Returns: the first element, or null if this set is empty Since: 1.6 -
pollLast
Description copied from interface: NavigableSetRetrieves and removes the last (highest) element, or returns null if this set is empty (optional operation).Specified by: pollLast in interface NavigableSet<E> Returns: the last element, or null if this set is empty Since: 1.6 -
addFirst
Throws UnsupportedOperationException. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.Specified by: addFirst in interface SequencedCollection<E> Specified by: addFirst in interface SortedSet<E> Parameters: e - the element to be added Throws: UnsupportedOperationException - always Since: 21 -
addLast
Throws UnsupportedOperationException. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.Specified by: addLast in interface SequencedCollection<E> Specified by: addLast in interface SortedSet<E> Parameters: e - the element to be added. Throws: UnsupportedOperationException - always Since: 21 -
clone
-
spliterator
Creates a late-binding and fail-fast Spliterator over the elements in this set.Specified by: spliterator in interface Collection<E> Specified by: spliterator in interface Iterable<E> Specified by: spliterator in interface Set<E> Specified by: spliterator in interface SortedSet<E> Returns: a Spliterator over the elements in this set Since: 1.8The Spliterator reports Spliterator.SIZED, Spliterator.DISTINCT, Spliterator.SORTED, and Spliterator.ORDERED. Overriding implementations should document the reporting of additional characteristic values.
The spliterator's comparator (see Spliterator.getComparator()) is null if the tree set's comparator (see comparator()) is null. Otherwise, the spliterator's comparator is the same as or imposes the same total ordering as the tree set's comparator.
-
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.