| 8 |
|
|
| 9 |
|
/** |
| 10 |
|
* A {@link SortedSet} extended with navigation methods reporting |
| 11 |
< |
* closest matches for given search targets. Methods {@code lower}, |
| 12 |
< |
* {@code floor}, {@code ceiling}, and {@code higher} return elements |
| 11 |
> |
* closest matches for given search targets. Methods {@link #lower}, |
| 12 |
> |
* {@link #floor}, {@link #ceiling}, and {@link #higher} return elements |
| 13 |
|
* respectively less than, less than or equal, greater than or equal, |
| 14 |
|
* and greater than a given element, returning {@code null} if there |
| 15 |
< |
* is no such element. A {@code NavigableSet} may be accessed and |
| 16 |
< |
* traversed in either ascending or descending order. The {@code |
| 17 |
< |
* descendingSet} method returns a view of the set with the senses of |
| 18 |
< |
* all relational and directional methods inverted. The performance of |
| 19 |
< |
* ascending operations and views is likely to be faster than that of |
| 20 |
< |
* descending ones. This interface additionally defines methods |
| 21 |
< |
* {@code pollFirst} and {@code pollLast} that return and remove the |
| 22 |
< |
* lowest and highest element, if one exists, else returning {@code |
| 23 |
< |
* null}. Methods {@code subSet}, {@code headSet}, |
| 24 |
< |
* and {@code tailSet} differ from the like-named {@code |
| 25 |
< |
* SortedSet} methods in accepting additional arguments describing |
| 26 |
< |
* whether lower and upper bounds are inclusive versus exclusive. |
| 27 |
< |
* Subsets of any {@code NavigableSet} must implement the {@code |
| 28 |
< |
* NavigableSet} interface. |
| 15 |
> |
* is no such element. |
| 16 |
> |
* |
| 17 |
> |
* <p>A {@code NavigableSet} may be accessed and traversed in either |
| 18 |
> |
* ascending or descending order. The {@link #descendingSet} method |
| 19 |
> |
* returns a view of the set with the senses of all relational and |
| 20 |
> |
* directional methods inverted. The performance of ascending |
| 21 |
> |
* operations and views is likely to be faster than that of descending |
| 22 |
> |
* ones. This interface additionally defines methods {@link |
| 23 |
> |
* #pollFirst} and {@link #pollLast} that return and remove the lowest |
| 24 |
> |
* and highest element, if one exists, else returning {@code null}. |
| 25 |
> |
* Methods |
| 26 |
> |
* {@link #subSet(Object, boolean, Object, boolean) subSet(E, boolean, E, boolean)}, |
| 27 |
> |
* {@link #headSet(Object, boolean) headSet(E, boolean)}, and |
| 28 |
> |
* {@link #tailSet(Object, boolean) tailSet(E, boolean)} |
| 29 |
> |
* differ from the like-named {@code SortedSet} methods in accepting |
| 30 |
> |
* additional arguments describing whether lower and upper bounds are |
| 31 |
> |
* inclusive versus exclusive. Subsets of any {@code NavigableSet} |
| 32 |
> |
* must implement the {@code NavigableSet} interface. |
| 33 |
|
* |
| 34 |
|
* <p>The return values of navigation methods may be ambiguous in |
| 35 |
|
* implementations that permit {@code null} elements. However, even |
| 147 |
|
* the iteration are undefined. |
| 148 |
|
* |
| 149 |
|
* <p>The returned set has an ordering equivalent to |
| 150 |
< |
* <tt>{@link Collections#reverseOrder(Comparator) Collections.reverseOrder}(comparator())</tt>. |
| 150 |
> |
* {@link Collections#reverseOrder(Comparator) Collections.reverseOrder}{@code (comparator())}. |
| 151 |
|
* The expression {@code s.descendingSet().descendingSet()} returns a |
| 152 |
|
* view of {@code s} essentially equivalent to {@code s}. |
| 153 |
|
* |
| 167 |
|
* Returns a view of the portion of this set whose elements range from |
| 168 |
|
* {@code fromElement} to {@code toElement}. If {@code fromElement} and |
| 169 |
|
* {@code toElement} are equal, the returned set is empty unless {@code |
| 170 |
< |
* fromExclusive} and {@code toExclusive} are both true. The returned set |
| 170 |
> |
* fromInclusive} and {@code toInclusive} are both true. The returned set |
| 171 |
|
* is backed by this set, so changes in the returned set are reflected in |
| 172 |
|
* this set, and vice-versa. The returned set supports all optional set |
| 173 |
|
* operations that this set supports. |
| 278 |
|
* @throws ClassCastException {@inheritDoc} |
| 279 |
|
* @throws NullPointerException {@inheritDoc} |
| 280 |
|
* @throws IllegalArgumentException {@inheritDoc} |
| 281 |
< |
na */ |
| 281 |
> |
*/ |
| 282 |
|
SortedSet<E> headSet(E toElement); |
| 283 |
|
|
| 284 |
|
/** |
