35 |
|
* {@code null} elements. (Note that sorted sets of {@link |
36 |
|
* Comparable} elements intrinsically do not permit {@code null}.) |
37 |
|
* |
38 |
+ |
* <p>Methods |
39 |
+ |
* {@link #subSet(Object, Object) subSet(E, E)}, |
40 |
+ |
* {@link #headSet(Object) headSet(E)}, and |
41 |
+ |
* {@link #tailSet(Object) tailSet(E)} |
42 |
+ |
* are specified to return {@code SortedSet} to allow existing |
43 |
+ |
* implementations of {@code SortedSet} to be compatibly retrofitted to |
44 |
+ |
* implement {@code NavigableSet}, but extensions and implementations |
45 |
+ |
* of this interface are encouraged to override these methods to return |
46 |
+ |
* {@code NavigableSet}. |
47 |
+ |
* |
48 |
|
* <p>This interface is a member of the |
49 |
< |
* <a href="{@docRoot}/../guide/collections/index.html"> |
49 |
> |
* <a href="{@docRoot}/../technotes/guides/collections/index.html"> |
50 |
|
* Java Collections Framework</a>. |
51 |
|
* |
52 |
|
* @author Doug Lea |
135 |
|
Iterator<E> iterator(); |
136 |
|
|
137 |
|
/** |
138 |
< |
* Returns a {@link NavigableSet} view of the elements contained in this |
139 |
< |
* set in descending order. The descending set is backed by this set, so |
140 |
< |
* changes to the set are reflected in the descending set, and vice-versa. |
141 |
< |
* If either set is modified while an iteration over the other set is in |
142 |
< |
* progress (except through the iterator's own {@code remove} operation), |
143 |
< |
* the results of the iteration are undefined. |
138 |
> |
* Returns a reverse order view of the elements contained in this set. |
139 |
> |
* The descending set is backed by this set, so changes to the set are |
140 |
> |
* reflected in the descending set, and vice-versa. If either set is |
141 |
> |
* modified while an iteration over either set is in progress (except |
142 |
> |
* through the iterator's own {@code remove} operation), the results of |
143 |
> |
* the iteration are undefined. |
144 |
> |
* |
145 |
> |
* <p>The returned set has an ordering equivalent to |
146 |
> |
* <tt>{@link Collections#reverseOrder(Comparator) Collections.reverseOrder}(comparator())</tt>. |
147 |
> |
* The expression {@code s.descendingSet().descendingSet()} returns a |
148 |
> |
* view of {@code s} essentially equivalent to {@code s}. |
149 |
|
* |
150 |
< |
* @return a navigable set view of the elements contained in this set, |
136 |
< |
* sorted in descending order |
150 |
> |
* @return a reverse order view of this set |
151 |
|
*/ |
152 |
|
NavigableSet<E> descendingSet(); |
153 |
|
|
256 |
|
NavigableSet<E> tailSet(E fromElement, boolean inclusive); |
257 |
|
|
258 |
|
/** |
259 |
< |
* Equivalent to {@code subSet(fromElement, true, toElement, false)} |
246 |
< |
* but with a return type conforming to the {@code SortedSet} interface. |
259 |
> |
* {@inheritDoc} |
260 |
|
* |
261 |
< |
* <p>{@inheritDoc} |
261 |
> |
* <p>Equivalent to {@code subSet(fromElement, true, toElement, false)}. |
262 |
|
* |
263 |
|
* @throws ClassCastException {@inheritDoc} |
264 |
|
* @throws NullPointerException {@inheritDoc} |
267 |
|
SortedSet<E> subSet(E fromElement, E toElement); |
268 |
|
|
269 |
|
/** |
270 |
< |
* Equivalent to {@code headSet(toElement, false)} |
258 |
< |
* but with a return type conforming to the {@code SortedSet} interface. |
270 |
> |
* {@inheritDoc} |
271 |
|
* |
272 |
< |
* <p>{@inheritDoc} |
272 |
> |
* <p>Equivalent to {@code headSet(toElement, false)}. |
273 |
|
* |
274 |
|
* @throws ClassCastException {@inheritDoc} |
275 |
|
* @throws NullPointerException {@inheritDoc} |
276 |
|
* @throws IllegalArgumentException {@inheritDoc} |
277 |
< |
*/ |
277 |
> |
na */ |
278 |
|
SortedSet<E> headSet(E toElement); |
279 |
|
|
280 |
|
/** |
281 |
< |
* Equivalent to {@code tailSet(fromElement, true)} |
270 |
< |
* but with a return type conforming to the {@code SortedSet} interface. |
281 |
> |
* {@inheritDoc} |
282 |
|
* |
283 |
< |
* <p>{@inheritDoc} |
283 |
> |
* <p>Equivalent to {@code tailSet(fromElement, true)}. |
284 |
|
* |
285 |
|
* @throws ClassCastException {@inheritDoc} |
286 |
|
* @throws NullPointerException {@inheritDoc} |