Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/java/util/TreeSet#pubctors) \| [Methods](https://developer.android.com/reference/java/util/TreeSet#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/util/TreeSet#inhmethods) # TreeSet ` public class TreeSet ` ` ` ` ` ` extends https://developer.android.com/reference/java/util/AbstractSet ` ` implements https://developer.android.com/reference/java/lang/Cloneable, https://developer.android.com/reference/java/util/NavigableSet, https://developer.android.com/reference/java/io/Serializable ` |---|---|---|---| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||| | ↳ | [java.util.AbstractCollection](https://developer.android.com/reference/java/util/AbstractCollection)\ ||| | | ↳ | [java.util.AbstractSet](https://developer.android.com/reference/java/util/AbstractSet)\ || | | | ↳ | java.util.TreeSet\ |
*** ** * ** *** A `https://developer.android.com/reference/java/util/NavigableSet` implementation based on a `https://developer.android.com/reference/java/util/TreeMap`. The elements are ordered using their [natural ordering](https://developer.android.com/reference/java/lang/Comparable), or by a `https://developer.android.com/reference/java/util/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 `https://developer.android.com/reference/java/util/Collections#synchronizedSortedSet(java.util.SortedSet)` 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 `https://developer.android.com/reference/java/util/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 `https://developer.android.com/reference/java/util/TreeSet#addFirst(E)` and `https://developer.android.com/reference/java/util/TreeSet#addLast(E)` 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](https://reference/java/util/package-summary.html#CollectionsFramework). **See also:** - `https://developer.android.com/reference/java/util/Collection` - `https://developer.android.com/reference/java/util/Set` - `https://developer.android.com/reference/java/util/HashSet` - `https://developer.android.com/reference/java/lang/Comparable` - `https://developer.android.com/reference/java/util/Comparator` - `https://developer.android.com/reference/java/util/TreeMap` ## Summary | ### Public constructors || |---|---| | ` https://developer.android.com/reference/java/util/TreeSet#TreeSet()() ` Constructs a new, empty tree set, sorted according to the natural ordering of its elements. | | ` https://developer.android.com/reference/java/util/TreeSet#TreeSet(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Constructs a new tree set containing the elements in the specified collection, sorted according to the *natural ordering* of its elements. | | ` https://developer.android.com/reference/java/util/TreeSet#TreeSet(java.util.Comparator)(https://developer.android.com/reference/java/util/Comparator comparator) ` Constructs a new, empty tree set, sorted according to the specified comparator. | | ` https://developer.android.com/reference/java/util/TreeSet#TreeSet(java.util.SortedSet)(https://developer.android.com/reference/java/util/SortedSet s) ` Constructs a new tree set containing the same elements and using the same ordering as the specified sorted set. | | ### Public methods || |---|---| | ` boolean` | ` https://developer.android.com/reference/java/util/TreeSet#add(E)(E e) ` Adds the specified element to this set if it is not already present. | | ` boolean` | ` https://developer.android.com/reference/java/util/TreeSet#addAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Adds all of the elements in the specified collection to this set. | | ` void` | ` https://developer.android.com/reference/java/util/TreeSet#addFirst(E)(E e) ` Throws `UnsupportedOperationException`. | | ` void` | ` https://developer.android.com/reference/java/util/TreeSet#addLast(E)(E e) ` Throws `UnsupportedOperationException`. | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#ceiling(E)(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` | ` https://developer.android.com/reference/java/util/TreeSet#clear()() ` Removes all of the elements from this set. | | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/util/TreeSet#clone()() ` Returns a shallow copy of this `TreeSet` instance. | | ` https://developer.android.com/reference/java/util/Comparator` | ` https://developer.android.com/reference/java/util/TreeSet#comparator()() ` Returns the comparator used to order the elements in this set, or `null` if this set uses the [natural ordering](https://developer.android.com/reference/java/lang/Comparable) of its elements. | | ` boolean` | ` https://developer.android.com/reference/java/util/TreeSet#contains(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Returns `true` if this set contains the specified element. | | ` https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/util/TreeSet#descendingIterator()() ` Returns an iterator over the elements in this set in descending order. | | ` https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/TreeSet#descendingSet()() ` Returns a reverse order view of the elements contained in this set. | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#first()() ` Returns the first (lowest) element currently in this set. | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#floor(E)(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. | | ` https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/TreeSet#headSet(E,%20boolean)(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`. | | ` https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/TreeSet#headSet(E)(E toElement) ` Returns a view of the portion of this set whose elements are strictly less than `toElement`. Equivalent to `headSet(toElement, false)`. | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#higher(E)(E e) ` Returns the least element in this set strictly greater than the given element, or `null` if there is no such element. | | ` boolean` | ` https://developer.android.com/reference/java/util/TreeSet#isEmpty()() ` Returns `true` if this set contains no elements. | | ` https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/util/TreeSet#iterator()() ` Returns an iterator over the elements in this set in ascending order. | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#last()() ` Returns the last (highest) element currently in this set. | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#lower(E)(E e) ` Returns the greatest element in this set strictly less than the given element, or `null` if there is no such element. | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#pollFirst()() ` Retrieves and removes the first (lowest) element, or returns `null` if this set is empty (optional operation). | | ` E` | ` https://developer.android.com/reference/java/util/TreeSet#pollLast()() ` Retrieves and removes the last (highest) element, or returns `null` if this set is empty (optional operation). | | ` boolean` | ` https://developer.android.com/reference/java/util/TreeSet#remove(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Removes the specified element from this set if it is present. | | ` int` | ` https://developer.android.com/reference/java/util/TreeSet#size()() ` Returns the number of elements in this set (its cardinality). | | ` https://developer.android.com/reference/java/util/Spliterator` | ` https://developer.android.com/reference/java/util/TreeSet#spliterator()() ` Creates a *[late-binding](https://developer.android.com/reference/java/util/Spliterator#binding)* and *fail-fast* `https://developer.android.com/reference/java/util/Spliterator` over the elements in this set. | | ` https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/TreeSet#subSet(E,%20boolean,%20E,%20boolean)(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) ` Returns a view of the portion of this set whose elements range from `fromElement` to `toElement`. | | ` https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/TreeSet#subSet(E,%20E)(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)`. | | ` https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/TreeSet#tailSet(E,%20boolean)(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`. | | ` https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/TreeSet#tailSet(E)(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 methods | |---|---| | From class ` https://developer.android.com/reference/java/util/AbstractSet ` |---|---| | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractSet#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Compares the specified object with this set for equality. | | ` int` | ` https://developer.android.com/reference/java/util/AbstractSet#hashCode()() ` Returns the hash code value for this set. | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractSet#removeAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Removes from this set all of its elements that are contained in the specified collection (optional operation). | || | From class ` https://developer.android.com/reference/java/util/AbstractCollection ` |---|---| | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#add(E)(E e) ` Ensures that this collection contains the specified element (optional operation). | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#addAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Adds all of the elements in the specified collection to this collection (optional operation). | | ` void` | ` https://developer.android.com/reference/java/util/AbstractCollection#clear()() ` Removes all of the elements from this collection (optional operation). | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#contains(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Returns `true` if this collection contains the specified element. | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#containsAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Returns `true` if this collection contains all of the elements in the specified collection. | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#isEmpty()() ` Returns `true` if this collection contains no elements. | | ` abstract https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/util/AbstractCollection#iterator()() ` Returns an iterator over the elements contained in this collection. | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#remove(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Removes a single instance of the specified element from this collection, if it is present (optional operation). | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#removeAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Removes all of this collection's elements that are also contained in the specified collection (optional operation). | | ` boolean` | ` https://developer.android.com/reference/java/util/AbstractCollection#retainAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Retains only the elements in this collection that are contained in the specified collection (optional operation). | | ` abstract int` | ` https://developer.android.com/reference/java/util/AbstractCollection#size()() ` Returns the number of elements in this collection. | | ` T[]` | ` https://developer.android.com/reference/java/util/AbstractCollection#toArray(T[])(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. | | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/util/AbstractCollection#toArray()() ` Returns an array containing all of the elements in this collection. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/util/AbstractCollection#toString()() ` Returns a string representation of this collection. | || | From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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 void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | || | From interface ` https://developer.android.com/reference/java/util/Set ` |---|---| | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#add(E)(E e) ` Adds the specified element to this set if it is not already present (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#addAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Adds all of the elements in the specified collection to this set if they're not already present (optional operation). | | ` abstract void` | ` https://developer.android.com/reference/java/util/Set#clear()() ` Removes all of the elements from this set (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#contains(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Returns `true` if this set contains the specified element. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#containsAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Returns `true` if this set contains all of the elements of the specified collection. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#copyOf(java.util.Collection)(https://developer.android.com/reference/java/util/Collection coll) ` Returns an [unmodifiable Set](https://developer.android.com/reference/java/util/TreeSet#unmodifiable) containing the elements of the given Collection. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Compares the specified object with this set for equality. | | ` abstract int` | ` https://developer.android.com/reference/java/util/Set#hashCode()() ` Returns the hash code value for this set. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#isEmpty()() ` Returns `true` if this set contains no elements. | | ` abstract https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/util/Set#iterator()() ` Returns an iterator over the elements in this set. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E)(E e1, E e2, E e3) ` Returns an unmodifiable set containing three elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E,%20E,%20E,%20E,%20E,%20E,%20E)(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9) ` Returns an unmodifiable set containing nine elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E,%20E,%20E)(E e1, E e2, E e3, E e4, E e5) ` Returns an unmodifiable set containing five elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E,%20E,%20E,%20E)(E e1, E e2, E e3, E e4, E e5, E e6) ` Returns an unmodifiable set containing six elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E,%20E,%20E,%20E,%20E,%20E)(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8) ` Returns an unmodifiable set containing eight elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E[])(E... elements) ` Returns an unmodifiable set containing an arbitrary number of elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of()() ` Returns an unmodifiable set containing zero elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E,%20E,%20E,%20E,%20E,%20E,%20E,%20E)(E e1, E e2, E e3, E e4, E e5, E e6, E e7, E e8, E e9, E e10) ` Returns an unmodifiable set containing ten elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E)(E e1, E e2) ` Returns an unmodifiable set containing two elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E,%20E,%20E,%20E,%20E)(E e1, E e2, E e3, E e4, E e5, E e6, E e7) ` Returns an unmodifiable set containing seven elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E,%20E,%20E,%20E)(E e1, E e2, E e3, E e4) ` Returns an unmodifiable set containing four elements. | | ` static https://developer.android.com/reference/java/util/Set` | ` https://developer.android.com/reference/java/util/Set#of(E)(E e1) ` Returns an unmodifiable set containing one element. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#remove(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Removes the specified element from this set if it is present (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#removeAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Removes from this set all of its elements that are contained in the specified collection (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Set#retainAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Retains only the elements in this set that are contained in the specified collection (optional operation). | | ` abstract int` | ` https://developer.android.com/reference/java/util/Set#size()() ` Returns the number of elements in this set (its cardinality). | | ` default https://developer.android.com/reference/java/util/Spliterator` | ` https://developer.android.com/reference/java/util/Set#spliterator()() ` Creates a `Spliterator` over the elements in this set. | | ` abstract https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/util/Set#toArray()() ` Returns an array containing all of the elements in this set. | | ` abstract T[]` | ` https://developer.android.com/reference/java/util/Set#toArray(T[])(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. | || | From interface ` https://developer.android.com/reference/java/util/Collection ` |---|---| | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#add(E)(E e) ` Ensures that this collection contains the specified element (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#addAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Adds all of the elements in the specified collection to this collection (optional operation). | | ` abstract void` | ` https://developer.android.com/reference/java/util/Collection#clear()() ` Removes all of the elements from this collection (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#contains(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Returns `true` if this collection contains the specified element. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#containsAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Returns `true` if this collection contains all of the elements in the specified collection. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Compares the specified object with this collection for equality. | | ` abstract int` | ` https://developer.android.com/reference/java/util/Collection#hashCode()() ` Returns the hash code value for this collection. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#isEmpty()() ` Returns `true` if this collection contains no elements. | | ` abstract https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/util/Collection#iterator()() ` Returns an iterator over the elements in this collection. | | ` default https://developer.android.com/reference/java/util/stream/Stream` | ` https://developer.android.com/reference/java/util/Collection#parallelStream()() ` Returns a possibly parallel `Stream` with this collection as its source. | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#remove(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Removes a single instance of the specified element from this collection, if it is present (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#removeAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Removes all of this collection's elements that are also contained in the specified collection (optional operation). | | ` default boolean` | ` https://developer.android.com/reference/java/util/Collection#removeIf(java.util.function.Predicate)(https://developer.android.com/reference/java/util/function/Predicate filter) ` Removes all of the elements of this collection that satisfy the given predicate (optional operation). | | ` abstract boolean` | ` https://developer.android.com/reference/java/util/Collection#retainAll(java.util.Collection)(https://developer.android.com/reference/java/util/Collection c) ` Retains only the elements in this collection that are contained in the specified collection (optional operation). | | ` abstract int` | ` https://developer.android.com/reference/java/util/Collection#size()() ` Returns the number of elements in this collection. | | ` default https://developer.android.com/reference/java/util/Spliterator` | ` https://developer.android.com/reference/java/util/Collection#spliterator()() ` Creates a `https://developer.android.com/reference/java/util/Spliterator` over the elements in this collection. | | ` default https://developer.android.com/reference/java/util/stream/Stream` | ` https://developer.android.com/reference/java/util/Collection#stream()() ` Returns a sequential `Stream` with this collection as its source. | | ` abstract T[]` | ` https://developer.android.com/reference/java/util/Collection#toArray(T[])(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. | | ` abstract https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/util/Collection#toArray()() ` Returns an array containing all of the elements in this collection. | | ` default T[]` | ` https://developer.android.com/reference/java/util/Collection#toArray(java.util.function.IntFunction)(https://developer.android.com/reference/java/util/function/IntFunction generator) ` Returns an array containing all of the elements in this collection, using the provided `generator` function to allocate the returned array. | || | From interface ` https://developer.android.com/reference/java/util/NavigableSet ` |---|---| | ` abstract E` | ` https://developer.android.com/reference/java/util/NavigableSet#ceiling(E)(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. | | ` abstract https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/util/NavigableSet#descendingIterator()() ` Returns an iterator over the elements in this set, in descending order. | | ` abstract https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/NavigableSet#descendingSet()() ` Returns a reverse order view of the elements contained in this set. | | ` abstract E` | ` https://developer.android.com/reference/java/util/NavigableSet#floor(E)(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. | | ` abstract https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/NavigableSet#headSet(E,%20boolean)(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`. | | ` abstract https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/NavigableSet#headSet(E)(E toElement) ` Returns a view of the portion of this set whose elements are strictly less than `toElement`. Equivalent to `headSet(toElement, false)`. | | ` abstract E` | ` https://developer.android.com/reference/java/util/NavigableSet#higher(E)(E e) ` Returns the least element in this set strictly greater than the given element, or `null` if there is no such element. | | ` abstract https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/util/NavigableSet#iterator()() ` Returns an iterator over the elements in this set, in ascending order. | | ` abstract E` | ` https://developer.android.com/reference/java/util/NavigableSet#lower(E)(E e) ` Returns the greatest element in this set strictly less than the given element, or `null` if there is no such element. | | ` abstract E` | ` https://developer.android.com/reference/java/util/NavigableSet#pollFirst()() ` Retrieves and removes the first (lowest) element, or returns `null` if this set is empty (optional operation). | | ` abstract E` | ` https://developer.android.com/reference/java/util/NavigableSet#pollLast()() ` Retrieves and removes the last (highest) element, or returns `null` if this set is empty (optional operation). | | ` default E` | ` https://developer.android.com/reference/java/util/NavigableSet#removeFirst()() ` Removes and returns the first element of this collection (optional operation). | | ` default E` | ` https://developer.android.com/reference/java/util/NavigableSet#removeLast()() ` Removes and returns the last element of this collection (optional operation). | | ` default https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/NavigableSet#reversed()() ` Returns a reverse-ordered [view](https://developer.android.com/reference/java/util/Collection#view) of this collection. This method is equivalent to `https://developer.android.com/reference/java/util/NavigableSet#descendingSet()`. | | ` abstract https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/NavigableSet#subSet(E,%20boolean,%20E,%20boolean)(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive) ` Returns a view of the portion of this set whose elements range from `fromElement` to `toElement`. | | ` abstract https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/NavigableSet#subSet(E,%20E)(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)`. | | ` abstract https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/NavigableSet#tailSet(E)(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)`. | | ` abstract https://developer.android.com/reference/java/util/NavigableSet` | ` https://developer.android.com/reference/java/util/NavigableSet#tailSet(E,%20boolean)(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`. | || | From interface ` https://developer.android.com/reference/java/lang/Iterable ` |---|---| | ` default void` | ` https://developer.android.com/reference/java/lang/Iterable#forEach(java.util.function.Consumer)(https://developer.android.com/reference/java/util/function/Consumer action) ` Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception. | | ` abstract https://developer.android.com/reference/java/util/Iterator` | ` https://developer.android.com/reference/java/lang/Iterable#iterator()() ` Returns an iterator over elements of type `T`. | | ` default https://developer.android.com/reference/java/util/Spliterator` | ` https://developer.android.com/reference/java/lang/Iterable#spliterator()() ` Creates a `https://developer.android.com/reference/java/util/Spliterator` over the elements described by this `Iterable`. | || | From interface ` https://developer.android.com/reference/java/util/SortedSet ` |---|---| | ` default void` | ` https://developer.android.com/reference/java/util/SortedSet#addFirst(E)(E e) ` Throws `UnsupportedOperationException`. | | ` default void` | ` https://developer.android.com/reference/java/util/SortedSet#addLast(E)(E e) ` Throws `UnsupportedOperationException`. | | ` abstract https://developer.android.com/reference/java/util/Comparator` | ` https://developer.android.com/reference/java/util/SortedSet#comparator()() ` Returns the comparator used to order the elements in this set, or `null` if this set uses the [natural ordering](https://developer.android.com/reference/java/lang/Comparable) of its elements. | | ` abstract E` | ` https://developer.android.com/reference/java/util/SortedSet#first()() ` Returns the first (lowest) element currently in this set. | | ` default E` | ` https://developer.android.com/reference/java/util/SortedSet#getFirst()() ` Gets the first element of this collection. | | ` default E` | ` https://developer.android.com/reference/java/util/SortedSet#getLast()() ` Gets the last element of this collection. | | ` abstract https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/SortedSet#headSet(E)(E toElement) ` Returns a view of the portion of this set whose elements are strictly less than `toElement`. | | ` abstract E` | ` https://developer.android.com/reference/java/util/SortedSet#last()() ` Returns the last (highest) element currently in this set. | | ` default E` | ` https://developer.android.com/reference/java/util/SortedSet#removeFirst()() ` Removes and returns the first element of this collection (optional operation). | | ` default E` | ` https://developer.android.com/reference/java/util/SortedSet#removeLast()() ` Removes and returns the last element of this collection (optional operation). | | ` default https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/SortedSet#reversed()() ` Returns a reverse-ordered [view](https://developer.android.com/reference/java/util/Collection#view) of this collection. | | ` default https://developer.android.com/reference/java/util/Spliterator` | ` https://developer.android.com/reference/java/util/SortedSet#spliterator()() ` Creates a `Spliterator` over the elements in this sorted set. | | ` abstract https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/SortedSet#subSet(E,%20E)(E fromElement, E toElement) ` Returns a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive. | | ` abstract https://developer.android.com/reference/java/util/SortedSet` | ` https://developer.android.com/reference/java/util/SortedSet#tailSet(E)(E fromElement) ` Returns a view of the portion of this set whose elements are greater than or equal to `fromElement`. | || | From interface ` https://developer.android.com/reference/java/util/SequencedSet ` |---|---| | ` abstract https://developer.android.com/reference/java/util/SequencedSet` | ` https://developer.android.com/reference/java/util/SequencedSet#reversed()() ` Returns a reverse-ordered [view](https://developer.android.com/reference/java/util/Collection#view) of this collection. | || | From interface ` https://developer.android.com/reference/java/util/SequencedCollection ` |---|---| | ` default void` | ` https://developer.android.com/reference/java/util/SequencedCollection#addFirst(E)(E e) ` Adds an element as the first element of this collection (optional operation). | | ` default void` | ` https://developer.android.com/reference/java/util/SequencedCollection#addLast(E)(E e) ` Adds an element as the last element of this collection (optional operation). | | ` default E` | ` https://developer.android.com/reference/java/util/SequencedCollection#getFirst()() ` Gets the first element of this collection. | | ` default E` | ` https://developer.android.com/reference/java/util/SequencedCollection#getLast()() ` Gets the last element of this collection. | | ` default E` | ` https://developer.android.com/reference/java/util/SequencedCollection#removeFirst()() ` Removes and returns the first element of this collection (optional operation). | | ` default E` | ` https://developer.android.com/reference/java/util/SequencedCollection#removeLast()() ` Removes and returns the last element of this collection (optional operation). | | ` abstract https://developer.android.com/reference/java/util/SequencedCollection` | ` https://developer.android.com/reference/java/util/SequencedCollection#reversed()() ` Returns a reverse-ordered [view](https://developer.android.com/reference/java/util/Collection#view) of this collection. | || ## Public constructors ### TreeSet Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` 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 `https://developer.android.com/reference/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. 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 Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public TreeSet (Collection c) ``` 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 `https://developer.android.com/reference/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.
| Parameters || |---|---| | `c` | `Collection`: collection whose elements will comprise the new set
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | if the elements in `c` are not `https://developer.android.com/reference/java/lang/Comparable`, or are not mutually comparable | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified collection is null | ### TreeSet Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public TreeSet (Comparator comparator) ``` 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` | `Comparator`: the comparator that will be used to order this set. If `null`, the [natural ordering](https://developer.android.com/reference/java/lang/Comparable) of the elements will be used.
| ### TreeSet Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public TreeSet (SortedSet s) ``` Constructs a new tree set containing the same elements and using the same ordering as the specified sorted set.
| Parameters || |---|---| | `s` | `SortedSet`: sorted set whose elements will comprise the new set
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified sorted set is null | ## Public methods ### add Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean add (E e) ``` 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`.
| Parameters || |---|---| | `e` | `E`: element to be added to this set
| | Returns || |---|---| | `boolean` | `true` if this set did not already contain the specified element
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | if the specified object cannot be compared with the elements currently in this set | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements | ### addAll Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean addAll (Collection c) ``` Adds all of the elements in the specified collection to this set.
| Parameters || |---|---| | `c` | `Collection`: collection containing elements to be added to this set
| | Returns || |---|---| | `boolean` | `true` if this set changed as a result of the call
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | if the elements provided cannot be compared with the elements currently in the set | | `https://developer.android.com/reference/java/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 elements | ### addFirst Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void addFirst (E e) ``` Throws `UnsupportedOperationException`. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.
| Parameters || |---|---| | `e` | `E`: the element to be added
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | always | ### addLast Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void addLast (E e) ``` Throws `UnsupportedOperationException`. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.
| Parameters || |---|---| | `e` | `E`: the element to be added.
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | always | ### ceiling Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public 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.
| Parameters || |---|---| | `e` | `E`: the value to match
| | Returns || |---|---| | `E` | the least element greater than or equal to `e`, or `null` if there is no such element
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements | ### clear Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void clear () ``` Removes all of the elements from this set. The set will be empty after this call returns.
### clone Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Object clone () ``` Returns a shallow copy of this `TreeSet` instance. (The elements themselves are not cloned.)
| Returns || |---|---| | `https://developer.android.com/reference/java/lang/Object` | a shallow copy of this set
| ### comparator Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Comparator comparator () ``` Returns the comparator used to order the elements in this set, or `null` if this set uses the [natural ordering](https://developer.android.com/reference/java/lang/Comparable) of its elements.
| Returns || |---|---| | `https://developer.android.com/reference/java/util/Comparator` | the comparator used to order the elements in this set, or `null` if this set uses the natural ordering of its elements
| ### contains Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean contains (Object o) ``` 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)`.
| Parameters || |---|---| | `o` | `Object`: object to be checked for containment in this set
| | Returns || |---|---| | `boolean` | `true` if this set contains the specified element
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | if the specified object cannot be compared with the elements currently in the set | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements | ### descendingIterator Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Iterator descendingIterator () ``` Returns an iterator over the elements in this set in descending order.
| Returns || |---|---| | `https://developer.android.com/reference/java/util/Iterator` | an iterator over the elements in this set in descending order
| ### descendingSet Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public NavigableSet descendingSet () ``` Returns 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. The returned set has an ordering equivalent to `https://developer.android.com/reference/java/util/Collections#reverseOrder(java.util.Comparator)``(comparator())`. The expression `s.descendingSet().descendingSet()` returns a view of `s` essentially equivalent to `s`.
| Returns || |---|---| | `https://developer.android.com/reference/java/util/NavigableSet` | a reverse order view of this set
| ### first Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public E first () ``` Returns the first (lowest) element currently in this set.
| Returns || |---|---| | `E` | the first (lowest) element currently in this set
| | Throws || |---|---| | `https://developer.android.com/reference/java/util/NoSuchElementException` | | ### floor Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public 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.
| Parameters || |---|---| | `e` | `E`: the value to match
| | Returns || |---|---| | `E` | the greatest element less than or equal to `e`, or `null` if there is no such element
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements | ### headSet Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public NavigableSet 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`. 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. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range.
| Parameters || |---|---| | `toElement` | `E`: high endpoint of the returned set
| | `inclusive` | `boolean`: `true` if the high endpoint is to be included in the returned view
| | Returns || |---|---| | `https://developer.android.com/reference/java/util/NavigableSet` | a view of the portion of this set whose elements are less than (or equal to, if `inclusive` is true) `toElement`
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/IllegalArgumentException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if `toElement` is null and this set uses natural ordering, or its comparator does not permit null elements | ### headSet Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SortedSet headSet (E toElement) ``` Returns 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. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `headSet(toElement, false)`.
| Parameters || |---|---| | `toElement` | `E`: high endpoint (exclusive) of the returned set
| | Returns || |---|---| | `https://developer.android.com/reference/java/util/SortedSet` | a view of the portion of this set whose elements are strictly less than `toElement`
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/IllegalArgumentException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if `toElement` is null and this set uses natural ordering, or its comparator does not permit null elements | ### higher Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public 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.
| Parameters || |---|---| | `e` | `E`: the value to match
| | Returns || |---|---| | `E` | the least element greater than `e`, or `null` if there is no such element
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements | ### isEmpty Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isEmpty () ``` Returns `true` if this set contains no elements.
| Returns || |---|---| | `boolean` | `true` if this set contains no elements
| ### iterator Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Iterator iterator () ``` Returns an iterator over the elements in this set in ascending order.
| Returns || |---|---| | `https://developer.android.com/reference/java/util/Iterator` | an iterator over the elements in this set in ascending order
| ### last Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public E last () ``` Returns the last (highest) element currently in this set.
| Returns || |---|---| | `E` | the last (highest) element currently in this set
| | Throws || |---|---| | `https://developer.android.com/reference/java/util/NoSuchElementException` | | ### lower Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public 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.
| Parameters || |---|---| | `e` | `E`: the value to match
| | Returns || |---|---| | `E` | the greatest element less than `e`, or `null` if there is no such element
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements | ### pollFirst Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public E pollFirst () ``` Retrieves and removes the first (lowest) element, or returns `null` if this set is empty (optional operation).
| Returns || |---|---| | `E` | the first element, or `null` if this set is empty
| ### pollLast Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public E pollLast () ``` Retrieves and removes the last (highest) element, or returns `null` if this set is empty (optional operation).
| Returns || |---|---| | `E` | the last element, or `null` if this set is empty
| ### remove Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean remove (Object o) ``` 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.)
| Parameters || |---|---| | `o` | `Object`: object to be removed from this set, if present
| | Returns || |---|---| | `boolean` | `true` if this set contained the specified element
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | if the specified object cannot be compared with the elements currently in this set | | `https://developer.android.com/reference/java/lang/NullPointerException` | if the specified element is null and this set uses natural ordering, or its comparator does not permit null elements | ### size Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int size () ``` Returns the number of elements in this set (its cardinality).
| Returns || |---|---| | `int` | the number of elements in this set (its cardinality)
| ### spliterator Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Spliterator spliterator () ``` Creates a *[late-binding](https://developer.android.com/reference/java/util/Spliterator#binding)* and *fail-fast* `https://developer.android.com/reference/java/util/Spliterator` over the elements in this set. The `Spliterator` reports `https://developer.android.com/reference/java/util/Spliterator#SIZED`, `https://developer.android.com/reference/java/util/Spliterator#DISTINCT`, `https://developer.android.com/reference/java/util/Spliterator#SORTED`, and `https://developer.android.com/reference/java/util/Spliterator#ORDERED`. Overriding implementations should document the reporting of additional characteristic values. The spliterator's comparator (see `https://developer.android.com/reference/java/util/Spliterator#getComparator()`) is `null` if the tree set's comparator (see `https://developer.android.com/reference/java/util/TreeSet#comparator()`) is `null`. Otherwise, the spliterator's comparator is the same as or imposes the same total ordering as the tree set's comparator.
| Returns || |---|---| | `https://developer.android.com/reference/java/util/Spliterator` | a `Spliterator` over the elements in this set
| ### subSet Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public NavigableSet 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`. 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. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range.
| Parameters || |---|---| | `fromElement` | `E`: low endpoint of the returned set
| | `fromInclusive` | `boolean`: `true` if the low endpoint is to be included in the returned view
| | `toElement` | `E`: high endpoint of the returned set
| | `toInclusive` | `boolean`: `true` if the high endpoint is to be included in the returned view
| | Returns || |---|---| | `https://developer.android.com/reference/java/util/NavigableSet` | a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/IllegalArgumentException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if `fromElement` or `toElement` is null and this set uses natural ordering, or its comparator does not permit null elements | ### subSet Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SortedSet subSet (E fromElement, E toElement) ``` 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 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. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `subSet(fromElement, true, toElement, false)`.
| Parameters || |---|---| | `fromElement` | `E`: low endpoint (inclusive) of the returned set
| | `toElement` | `E`: high endpoint (exclusive) of the returned set
| | Returns || |---|---| | `https://developer.android.com/reference/java/util/SortedSet` | a view of the portion of this set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/IllegalArgumentException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if `fromElement` or `toElement` is null and this set uses natural ordering, or its comparator does not permit null elements | ### tailSet Added in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public NavigableSet 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`. 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. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range.
| Parameters || |---|---| | `fromElement` | `E`: low endpoint of the returned set
| | `inclusive` | `boolean`: `true` if the low endpoint is to be included in the returned view
| | Returns || |---|---| | `https://developer.android.com/reference/java/util/NavigableSet` | a view of the portion of this set whose elements are greater than or equal to `fromElement`
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/IllegalArgumentException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if `fromElement` is null and this set uses natural ordering, or its comparator does not permit null elements | ### tailSet Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public SortedSet tailSet (E fromElement) ``` Returns 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. The returned set will throw an `IllegalArgumentException` on an attempt to insert an element outside its range. Equivalent to `tailSet(fromElement, true)`.
| Parameters || |---|---| | `fromElement` | `E`: low endpoint (inclusive) of the returned set
| | Returns || |---|---| | `https://developer.android.com/reference/java/util/SortedSet` | a view of the portion of this set whose elements are greater than or equal to `fromElement`
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ClassCastException` | | | `https://developer.android.com/reference/java/lang/IllegalArgumentException` | | | `https://developer.android.com/reference/java/lang/NullPointerException` | if `fromElement` is null and this set uses natural ordering, or its comparator does not permit null elements |