Method Summary

• Methods declared in interface java.util.Collection

  parallelStream, removeIf, stream, toArray

• Methods declared in interface java.lang.Iterable

  forEach

• Methods declared in interface java.util.Set

  add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

• Methods declared in interface java.util.SortedSet

  comparator, first, last, spliterator

Method Detail

• lower

  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 - 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 does not permit null elements

• floor

  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 - 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 does not permit null elements

• ceiling

  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 - 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 does not permit null elements

• higher

  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 - 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 does not permit null elements

• pollFirst

  E pollFirst()

  Retrieves and removes the first (lowest) element, or returns null if this set is empty.

  Returns:

  the first element, or null if this set is empty

• pollLast

  E pollLast()

  Retrieves and removes the last (highest) element, or returns null if this set is empty.

  Returns:

  the last element, or null if this set is empty

• iterator

  Iterator<E> 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 Set<E>

  Returns:

  an iterator over the elements in this set, in ascending order

• descendingSet

  NavigableSet<E> 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 Collections.reverseOrder(comparator()). The expression s.descendingSet().descendingSet() returns a view of s essentially equivalent to s.

  Returns:

  a reverse order view of this set

• descendingIterator

  Iterator<E> descendingIterator()

  Returns an iterator over the elements in this set, in descending order. Equivalent in effect to descendingSet().iterator().

  Returns:

  an iterator over the elements in this set, in descending order

• subSet

  NavigableSet<E> subSet​(E fromElement,
                         boolean fromInclusive,
                         E toElement,
                         boolean toInclusive)

  Returns a view of the portion of this set whose elements range from fromElement to toElement. 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 - 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 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.

• headSet

  NavigableSet<E> headSet​(E toElement,
                          boolean inclusive)

  Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement. 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 - 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 does not permit null elements

  IllegalArgumentException - if this set itself has a restricted range, and toElement lies outside the bounds of the range

• tailSet

  NavigableSet<E> tailSet​(E fromElement,
                          boolean inclusive)

  Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement. 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 - 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 does not permit null elements

  IllegalArgumentException - if this set itself has a restricted range, and fromElement lies outside the bounds of the range

• subSet

  SortedSet<E> subSet​(E fromElement,
                      E toElement)

  Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (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).

  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 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

• headSet

  SortedSet<E> 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).

  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 does not permit null elements

  IllegalArgumentException - if this set itself has a restricted range, and toElement lies outside the bounds of the range

• tailSet

  SortedSet<E> 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).

  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 does not permit null elements

  IllegalArgumentException - if this set itself has a restricted range, and fromElement lies outside the bounds of the range