E - the type of elements maintained by this setpublic class IndexedTreeSet<E> extends AbstractSet<E> implements IndexedNavigableSet<E>, Cloneable, Serializable
NavigableSet implementation based on a IndexedTreeMap. The elements are ordered using
their natural ordering, or by a Comparator provided at set creation time,
depending on which constructor is used.
This implementation provides guaranteed log(n) time cost for the basic operations (add, remove and
contains).
Note that the ordering maintained by a set (whether or not an explicit comparator is provided) must be consistent
with equals if it is to correctly implement the Set interface. (See Comparable or
Comparator for a precise definition of consistent with equals.) This is so because the Set
interface is defined in terms of the equals operation, but a IndexedTreeSet 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 IndexedTreeSet(...));
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.
Collection,
Set,
HashSet,
Comparable,
Comparator,
IndexedTreeMap,
Serialized Form| Constructor and Description |
|---|
IndexedTreeSet()
Constructs a new, empty tree set, sorted according to the natural ordering of its elements.
|
IndexedTreeSet(Collection<? extends E> c)
Constructs a new tree set containing the elements in the specified collection, sorted according to the natural
ordering of its elements.
|
IndexedTreeSet(Comparator<? super E> comparator)
Constructs a new, empty tree set, sorted according to the specified comparator.
|
IndexedTreeSet(SortedSet<E> s)
Constructs a new tree set containing the same elements and using the same ordering as the specified sorted set.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(E e)
Adds the specified element to this set if it is not already present.
|
boolean |
addAll(Collection<? extends E> c)
Adds all of the elements in the specified collection to this set.
|
E |
ceiling(E e) |
void |
clear()
Removes all of the elements from this set.
|
Object |
clone()
Returns a shallow copy of this
IndexedTreeSet instance. |
Comparator<? super E> |
comparator() |
boolean |
contains(Object o)
Returns
true if this set contains the specified element. |
void |
debug() |
Iterator<E> |
descendingIterator()
Returns an iterator over the elements in this set in descending order.
|
NavigableSet<E> |
descendingSet() |
E |
first() |
E |
floor(E e) |
E |
get(int index)
Returns the entry located at the index offset from the beginning of the sorted set
|
int |
getIndex(E e)
Searches the specified tree map for the specified entry using the put algorithm.
|
SortedSet<E> |
headSet(E toElement) |
NavigableSet<E> |
headSet(E toElement,
boolean inclusive) |
E |
higher(E e) |
boolean |
isEmpty()
Returns
true if this set contains no elements. |
Iterator<E> |
iterator()
Returns an iterator over the elements in this set in ascending order.
|
E |
last() |
E |
lower(E e) |
E |
pollFirst() |
E |
pollLast() |
boolean |
remove(Object o)
Removes the specified element from this set if it is present.
|
int |
size()
Returns the number of elements in this set (its cardinality).
|
NavigableSet<E> |
subSet(E fromElement,
boolean fromInclusive,
E toElement,
boolean toInclusive) |
SortedSet<E> |
subSet(E fromElement,
E toElement) |
SortedSet<E> |
tailSet(E fromElement) |
NavigableSet<E> |
tailSet(E fromElement,
boolean inclusive) |
equals, hashCode, removeAllcontainsAll, retainAll, toArray, toArray, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitspliteratorcontainsAll, equals, hashCode, removeAll, retainAll, toArray, toArrayparallelStream, removeIf, streampublic IndexedTreeSet()
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.public IndexedTreeSet(Collection<? extends E> c)
Comparable interface.
Furthermore, all such elements must be mutually comparable: e1.compareTo(e2) must not throw a
ClassCastException for any elements e1 and e2 in the set.c - collection whose elements will comprise the new setClassCastException - if the elements in c are not Comparable, or are not mutually
comparableNullPointerException - if the specified collection is nullpublic IndexedTreeSet(Comparator<? super E> 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.comparator - the comparator that will be used to order this set. If null, the natural ordering of the elements will be used.public IndexedTreeSet(SortedSet<E> s)
s - sorted set whose elements will comprise the new setNullPointerException - if the specified sorted set is nullpublic boolean add(E e)
e to this set if the set contains no element e2 such that
(e==null ? e2==null : e.equals(e2)). If this set already contains the element,
the call leaves the set unchanged and returns false.add in interface Collection<E>add in interface Set<E>add in class AbstractCollection<E>e - element to be added to this settrue if this set did not already contain the specified elementClassCastException - if the specified object cannot be compared with the elements currently in this setNullPointerException - if the specified element is null and this set uses natural ordering, or its
comparator does not permit null elementspublic boolean addAll(Collection<? extends E> c)
addAll in interface Collection<E>addAll in interface Set<E>addAll in class AbstractCollection<E>c - collection containing elements to be added to this settrue if this set changed as a result of the callClassCastException - if the elements provided cannot be compared with the elements currently in the setNullPointerException - 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 elementspublic E ceiling(E e)
ceiling in interface NavigableSet<E>ClassCastExceptionNullPointerException - if the specified element is null and this set uses natural ordering, or its
comparator does not permit null elementspublic void clear()
clear in interface Collection<E>clear in interface Set<E>clear in class AbstractCollection<E>public Object clone()
IndexedTreeSet instance. (The elements themselves are not cloned.)public Comparator<? super E> comparator()
comparator in interface SortedSet<E>public boolean contains(Object o)
true if this set contains the specified element. More formally, returns true if and only
if this set contains an element e such that
(o==null ? e==null : o.equals(e)).contains in interface Collection<E>contains in interface Set<E>contains in class AbstractCollection<E>o - object to be checked for containment in this settrue if this set contains the specified elementClassCastException - if the specified object cannot be compared with the elements currently in the setNullPointerException - if the specified element is null and this set uses natural ordering, or its
comparator does not permit null elementspublic Iterator<E> descendingIterator()
descendingIterator in interface NavigableSet<E>public NavigableSet<E> descendingSet()
descendingSet in interface NavigableSet<E>public E first()
first in interface SortedSet<E>NoSuchElementExceptionpublic E floor(E e)
floor in interface NavigableSet<E>ClassCastExceptionNullPointerException - if the specified element is null and this set uses natural ordering, or its
comparator does not permit null elementspublic E get(int index)
IndexedNavigableSetget in interface IndexedNavigableSet<E>index - index of the entrypublic int getIndex(E e)
IndexedNavigableSetgetIndex in interface IndexedNavigableSet<E>e - the entrypublic SortedSet<E> headSet(E toElement)
headSet in interface NavigableSet<E>headSet in interface SortedSet<E>ClassCastExceptionNullPointerException - if toElement is null and this set uses natural ordering, or its comparator
does not permit null elementsIllegalArgumentExceptionpublic NavigableSet<E> headSet(E toElement, boolean inclusive)
headSet in interface NavigableSet<E>ClassCastExceptionNullPointerException - if toElement is null and this set uses natural ordering, or its comparator
does not permit null elementsIllegalArgumentExceptionpublic E higher(E e)
higher in interface NavigableSet<E>ClassCastExceptionNullPointerException - if the specified element is null and this set uses natural ordering, or its
comparator does not permit null elementspublic boolean isEmpty()
true if this set contains no elements.isEmpty in interface Collection<E>isEmpty in interface Set<E>isEmpty in class AbstractCollection<E>true if this set contains no elementspublic Iterator<E> iterator()
iterator in interface Iterable<E>iterator in interface Collection<E>iterator in interface NavigableSet<E>iterator in interface Set<E>iterator in class AbstractCollection<E>public E last()
last in interface SortedSet<E>NoSuchElementExceptionpublic E lower(E e)
lower in interface NavigableSet<E>ClassCastExceptionNullPointerException - if the specified element is null and this set uses natural ordering, or its
comparator does not permit null elementspublic E pollFirst()
pollFirst in interface NavigableSet<E>public E pollLast()
pollLast in interface NavigableSet<E>public boolean remove(Object o)
e such
that (o==null ? e==null : o.equals(e)), if this set contains such an element.
Returns true if this set contained the element (or equivalently, if this set changed as a result of the
call). (This set will not contain the element once the call returns.)remove in interface Collection<E>remove in interface Set<E>remove in class AbstractCollection<E>o - object to be removed from this set, if presenttrue if this set con tained the specified elementClassCastException - if the specified object cannot be compared with the elements currently in this setNullPointerException - if the specified element is null and this set uses natural ordering, or its
comparator does not permit null elementspublic int size()
size in interface Collection<E>size in interface Set<E>size in class AbstractCollection<E>public NavigableSet<E> subSet(E fromElement, boolean fromInclusive, E toElement, boolean toInclusive)
subSet in interface NavigableSet<E>ClassCastExceptionNullPointerException - if fromElement or toElement is null and this set uses natural
ordering, or its comparator does not permit null elementsIllegalArgumentExceptionpublic SortedSet<E> subSet(E fromElement, E toElement)
subSet in interface NavigableSet<E>subSet in interface SortedSet<E>ClassCastExceptionNullPointerException - if fromElement or toElement is null and this set uses natural
ordering, or its comparator does not permit null elementsIllegalArgumentExceptionpublic SortedSet<E> tailSet(E fromElement)
tailSet in interface NavigableSet<E>tailSet in interface SortedSet<E>ClassCastExceptionNullPointerException - if fromElement is null and this set uses natural ordering, or its comparator
does not permit null elementsIllegalArgumentExceptionpublic NavigableSet<E> tailSet(E fromElement, boolean inclusive)
tailSet in interface NavigableSet<E>ClassCastExceptionNullPointerException - if fromElement is null and this set uses natural ordering, or its comparator
does not permit null elementsIllegalArgumentExceptionCopyright © 2019 GSI Helmholtzzentrum für Schwerionenforschung GmbH. All rights reserved.