8 |
|
|
9 |
|
/** |
10 |
|
* A {@link SortedSet} extended with navigation methods reporting |
11 |
< |
* closest matches for given search targets. Methods <tt>lower}, |
11 |
> |
* closest matches for given search targets. Methods {@code lower}, |
12 |
|
* {@code floor}, {@code ceiling}, and {@code 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 |
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 navigableSubSet}, {@code navigableHeadSet}, |
24 |
< |
* and {@code navigableTailSet} differ from the similarly named {@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 |
129 |
|
* set in descending order. The descending set is backed by this set, so |
130 |
|
* changes to the set are reflected in the descending set, and vice-versa. |
131 |
|
* If either set is modified while an iteration over the other set is in |
132 |
< |
* in progress (except through the iterator's own {@code remove} operation), |
132 |
> |
* progress (except through the iterator's own {@code remove} operation), |
133 |
|
* the results of the iteration are undefined. |
134 |
|
* |
135 |
< |
* @return a navigable set view of the mappings contained in this set, |
136 |
< |
* sorted in descending order |
135 |
> |
* @return a navigable set view of the elements contained in this set, |
136 |
> |
* sorted in descending order |
137 |
|
*/ |
138 |
|
NavigableSet<E> descendingSet(); |
139 |
|
|
159 |
|
* |
160 |
|
* @param fromElement low endpoint of the returned set |
161 |
|
* @param fromInclusive true if the low endpoint ({@code fromElement}) is |
162 |
< |
* to be included in the the returned view |
162 |
> |
* to be included in the returned view |
163 |
|
* @param toElement high endpoint of the returned set |
164 |
|
* @param toInclusive true if the high endpoint ({@code toElement}) is |
165 |
< |
* to be included in the the returned view |
165 |
> |
* to be included in the returned view |
166 |
|
* @return a view of the portion of this set whose elements range from |
167 |
|
* {@code fromElement}, inclusive, to {@code toElement}, exclusive |
168 |
|
* @throws ClassCastException if {@code fromElement} and |
180 |
|
* has a restricted range, and {@code fromElement} or |
181 |
|
* {@code toElement} lies outside the bounds of the range. |
182 |
|
*/ |
183 |
< |
NavigableSet<E> navigableSubSet(E fromElement, boolean fromInclusive, |
184 |
< |
E toElement, boolean toInclusive); |
183 |
> |
NavigableSet<E> subSet(E fromElement, boolean fromInclusive, |
184 |
> |
E toElement, boolean toInclusive); |
185 |
|
|
186 |
|
/** |
187 |
|
* Returns a view of the portion of this set whose elements are less than |
195 |
|
* |
196 |
|
* @param toElement high endpoint of the returned set |
197 |
|
* @param inclusive true if the high endpoint ({@code toElement}) is |
198 |
< |
* to be included in the the returned view |
198 |
> |
* to be included in the returned view |
199 |
|
* @return a view of the portion of this set whose elements are less than |
200 |
|
* (or equal to, if {@code inclusive} is true) {@code toElement} |
201 |
|
* @throws ClassCastException if {@code toElement} is not compatible |
210 |
|
* restricted range, and {@code toElement} lies outside the |
211 |
|
* bounds of the range |
212 |
|
*/ |
213 |
< |
NavigableSet<E> navigableHeadSet(E toElement, boolean inclusive); |
213 |
> |
NavigableSet<E> headSet(E toElement, boolean inclusive); |
214 |
|
|
215 |
|
/** |
216 |
|
* Returns a view of the portion of this set whose elements are greater |
224 |
|
* |
225 |
|
* @param fromElement low endpoint of the returned set |
226 |
|
* @param inclusive true if the low endpoint ({@code fromElement}) is |
227 |
< |
* to be included in the the returned view |
227 |
> |
* to be included in the returned view |
228 |
|
* @return a view of the portion of this set whose elements are greater |
229 |
|
* than or equal to {@code fromElement} |
230 |
|
* @throws ClassCastException if {@code fromElement} is not compatible |
239 |
|
* restricted range, and {@code fromElement} lies outside the |
240 |
|
* bounds of the range |
241 |
|
*/ |
242 |
< |
NavigableSet<E> navigableTailSet(E fromElement, boolean inclusive); |
242 |
> |
NavigableSet<E> tailSet(E fromElement, boolean inclusive); |
243 |
|
} |