1 |
|
/* |
2 |
|
* %W% %E% |
3 |
|
* |
4 |
< |
* Copyright 2004 Sun Microsystems, Inc. All rights reserved. |
4 |
> |
* Copyright 2005 Sun Microsystems, Inc. All rights reserved. |
5 |
|
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. |
6 |
|
*/ |
7 |
|
|
8 |
< |
package java.util; |
8 |
> |
package java.util; |
9 |
> |
import java.util.*; // for javadoc (till 6280605 is fixed) |
10 |
|
|
11 |
|
/** |
12 |
< |
* This class implements the <tt>Set</tt> interface, backed by a |
13 |
< |
* <tt>TreeMap</tt> instance. This class guarantees that the sorted set will |
14 |
< |
* be in ascending element order, sorted according to the <i>natural order</i> |
15 |
< |
* of the elements (see <tt>Comparable</tt>), or by the comparator provided at |
15 |
< |
* set creation time, depending on which constructor is used.<p> |
12 |
> |
* A {@link NavigableSet} implementation based on a {@link TreeMap}. |
13 |
> |
* The elements are ordered using their {@linkplain Comparable natural |
14 |
> |
* ordering}, or by a {@link Comparator} provided at set creation |
15 |
> |
* time, depending on which constructor is used. |
16 |
|
* |
17 |
< |
* This implementation provides guaranteed log(n) time cost for the basic |
18 |
< |
* operations (<tt>add</tt>, <tt>remove</tt> and <tt>contains</tt>).<p> |
17 |
> |
* <p>This implementation provides guaranteed log(n) time cost for the basic |
18 |
> |
* operations (<tt>add</tt>, <tt>remove</tt> and <tt>contains</tt>). |
19 |
|
* |
20 |
< |
* Note that the ordering maintained by a set (whether or not an explicit |
20 |
> |
* <p>Note that the ordering maintained by a set (whether or not an explicit |
21 |
|
* comparator is provided) must be <i>consistent with equals</i> if it is to |
22 |
|
* correctly implement the <tt>Set</tt> interface. (See <tt>Comparable</tt> |
23 |
|
* or <tt>Comparator</tt> for a precise definition of <i>consistent with |
24 |
|
* equals</i>.) This is so because the <tt>Set</tt> interface is defined in |
25 |
|
* terms of the <tt>equals</tt> operation, but a <tt>TreeSet</tt> instance |
26 |
< |
* performs all key comparisons using its <tt>compareTo</tt> (or |
27 |
< |
* <tt>compare</tt>) method, so two keys that are deemed equal by this method |
26 |
> |
* performs all element comparisons using its <tt>compareTo</tt> (or |
27 |
> |
* <tt>compare</tt>) method, so two elements that are deemed equal by this method |
28 |
|
* are, from the standpoint of the set, equal. The behavior of a set |
29 |
|
* <i>is</i> well-defined even if its ordering is inconsistent with equals; it |
30 |
< |
* just fails to obey the general contract of the <tt>Set</tt> interface.<p> |
30 |
> |
* just fails to obey the general contract of the <tt>Set</tt> interface. |
31 |
|
* |
32 |
< |
* <b>Note that this implementation is not synchronized.</b> If multiple |
32 |
> |
* <p><b>Note that this implementation is not synchronized.</b> If multiple |
33 |
|
* threads access a set concurrently, and at least one of the threads modifies |
34 |
|
* the set, it <i>must</i> be synchronized externally. This is typically |
35 |
|
* accomplished by synchronizing on some object that naturally encapsulates |
37 |
|
* <tt>Collections.synchronizedSet</tt> method. This is best done at creation |
38 |
|
* time, to prevent accidental unsynchronized access to the set: <pre> |
39 |
|
* SortedSet s = Collections.synchronizedSortedSet(new TreeSet(...)); |
40 |
< |
* </pre><p> |
40 |
> |
* </pre> |
41 |
|
* |
42 |
< |
* The Iterators returned by this class's <tt>iterator</tt> method are |
42 |
> |
* <p>The iterators returned by this class's <tt>iterator</tt> method are |
43 |
|
* <i>fail-fast</i>: if the set is modified at any time after the iterator is |
44 |
|
* created, in any way except through the iterator's own <tt>remove</tt> |
45 |
< |
* method, the iterator will throw a <tt>ConcurrentModificationException</tt>. |
45 |
> |
* method, the iterator will throw a {@link ConcurrentModificationException}. |
46 |
|
* Thus, in the face of concurrent modification, the iterator fails quickly |
47 |
|
* and cleanly, rather than risking arbitrary, non-deterministic behavior at |
48 |
|
* an undetermined time in the future. |
53 |
|
* throw <tt>ConcurrentModificationException</tt> on a best-effort basis. |
54 |
|
* Therefore, it would be wrong to write a program that depended on this |
55 |
|
* exception for its correctness: <i>the fail-fast behavior of iterators |
56 |
< |
* should be used only to detect bugs.</i><p> |
56 |
> |
* should be used only to detect bugs.</i> |
57 |
|
* |
58 |
< |
* This class is a member of the |
58 |
> |
* <p>This class is a member of the |
59 |
|
* <a href="{@docRoot}/../guide/collections/index.html"> |
60 |
|
* Java Collections Framework</a>. |
61 |
|
* |
62 |
+ |
* @param <E> the type of elements maintained by this set |
63 |
+ |
* |
64 |
|
* @author Josh Bloch |
65 |
|
* @version %I%, %G% |
66 |
|
* @see Collection |
83 |
|
private static final Object PRESENT = new Object(); |
84 |
|
|
85 |
|
/** |
86 |
< |
* Constructs a set backed by the specified sorted map. |
86 |
> |
* Constructs a set backed by the specified navigable map. |
87 |
|
*/ |
88 |
|
private TreeSet(NavigableMap<E,Object> m) { |
89 |
|
this.m = m; |
90 |
|
} |
91 |
|
|
92 |
|
/** |
93 |
< |
* Constructs a new, empty set, sorted according to the elements' natural |
94 |
< |
* order. All elements inserted into the set must implement the |
95 |
< |
* <tt>Comparable</tt> interface. Furthermore, all such elements must be |
96 |
< |
* <i>mutually comparable</i>: <tt>e1.compareTo(e2)</tt> must not throw a |
93 |
> |
* Constructs a new, empty tree set, sorted according to the |
94 |
> |
* natural ordering of its elements. All elements inserted into |
95 |
> |
* the set must implement the {@link Comparable} interface. |
96 |
> |
* Furthermore, all such elements must be <i>mutually |
97 |
> |
* comparable</i>: <tt>e1.compareTo(e2)</tt> must not throw a |
98 |
|
* <tt>ClassCastException</tt> for any elements <tt>e1</tt> and |
99 |
< |
* <tt>e2</tt> in the set. If the user attempts to add an element to the |
100 |
< |
* set that violates this constraint (for example, the user attempts to |
101 |
< |
* add a string element to a set whose elements are integers), the |
102 |
< |
* <tt>add(Object)</tt> call will throw a <tt>ClassCastException</tt>. |
103 |
< |
* |
101 |
< |
* @see Comparable |
99 |
> |
* <tt>e2</tt> in the set. If the user attempts to add an element |
100 |
> |
* to the set that violates this constraint (for example, the user |
101 |
> |
* attempts to add a string element to a set whose elements are |
102 |
> |
* integers), the <tt>add(Object)</tt> call will throw a |
103 |
> |
* <tt>ClassCastException</tt>. |
104 |
|
*/ |
105 |
|
public TreeSet() { |
106 |
|
this(new TreeMap<E,Object>()); |
107 |
|
} |
108 |
|
|
109 |
|
/** |
110 |
< |
* Constructs a new, empty set, sorted according to the specified |
110 |
> |
* Constructs a new, empty tree set, sorted according to the specified |
111 |
|
* comparator. All elements inserted into the set must be <i>mutually |
112 |
|
* comparable</i> by the specified comparator: <tt>comparator.compare(e1, |
113 |
|
* e2)</tt> must not throw a <tt>ClassCastException</tt> for any elements |
115 |
|
* an element to the set that violates this constraint, the |
116 |
|
* <tt>add(Object)</tt> call will throw a <tt>ClassCastException</tt>. |
117 |
|
* |
118 |
< |
* @param c the comparator that will be used to sort this set. A |
119 |
< |
* <tt>null</tt> value indicates that the elements' <i>natural |
120 |
< |
* ordering</i> should be used. |
118 |
> |
* @param comparator the comparator that will be used to order this set. |
119 |
> |
* If <tt>null</tt>, the {@linkplain Comparable natural |
120 |
> |
* ordering} of the elements will be used. |
121 |
|
*/ |
122 |
< |
public TreeSet(Comparator<? super E> c) { |
123 |
< |
this(new TreeMap<E,Object>(c)); |
122 |
> |
public TreeSet(Comparator<? super E> comparator) { |
123 |
> |
this(new TreeMap<E,Object>(comparator)); |
124 |
|
} |
125 |
|
|
126 |
|
/** |
127 |
< |
* Constructs a new set containing the elements in the specified |
128 |
< |
* collection, sorted according to the elements' <i>natural order</i>. |
129 |
< |
* All keys inserted into the set must implement the <tt>Comparable</tt> |
130 |
< |
* interface. Furthermore, all such keys must be <i>mutually |
131 |
< |
* comparable</i>: <tt>k1.compareTo(k2)</tt> must not throw a |
132 |
< |
* <tt>ClassCastException</tt> for any elements <tt>k1</tt> and |
133 |
< |
* <tt>k2</tt> in the set. |
132 |
< |
* |
133 |
< |
* @param c The elements that will comprise the new set. |
127 |
> |
* Constructs a new tree set containing the elements in the specified |
128 |
> |
* collection, sorted according to the <i>natural ordering</i> of its |
129 |
> |
* elements. All elements inserted into the set must implement the |
130 |
> |
* {@link Comparable} interface. Furthermore, all such elements must be |
131 |
> |
* <i>mutually comparable</i>: <tt>e1.compareTo(e2)</tt> must not throw a |
132 |
> |
* <tt>ClassCastException</tt> for any elements <tt>e1</tt> and |
133 |
> |
* <tt>e2</tt> in the set. |
134 |
|
* |
135 |
< |
* @throws ClassCastException if the keys in the specified collection are |
136 |
< |
* not comparable, or are not mutually comparable. |
137 |
< |
* @throws NullPointerException if the specified collection is null. |
135 |
> |
* @param c collection whose elements will comprise the new set |
136 |
> |
* @throws ClassCastException if the elements in <tt>c</tt> are |
137 |
> |
* not {@link Comparable}, or are not mutually comparable |
138 |
> |
* @throws NullPointerException if the specified collection is null |
139 |
|
*/ |
140 |
|
public TreeSet(Collection<? extends E> c) { |
141 |
|
this(); |
143 |
|
} |
144 |
|
|
145 |
|
/** |
146 |
< |
* Constructs a new set containing the same elements as the specified |
147 |
< |
* sorted set, sorted according to the same ordering. |
146 |
> |
* Constructs a new tree set containing the same elements and |
147 |
> |
* using the same ordering as the specified sorted set. |
148 |
|
* |
149 |
< |
* @param s sorted set whose elements will comprise the new set. |
150 |
< |
* @throws NullPointerException if the specified sorted set is null. |
149 |
> |
* @param s sorted set whose elements will comprise the new set |
150 |
> |
* @throws NullPointerException if the specified sorted set is null |
151 |
|
*/ |
152 |
|
public TreeSet(SortedSet<E> s) { |
153 |
|
this(s.comparator()); |
155 |
|
} |
156 |
|
|
157 |
|
/** |
158 |
< |
* Returns an iterator over the elements in this set. The elements |
158 |
< |
* are returned in ascending order. |
158 |
> |
* Returns an iterator over the elements in this set in ascending order. |
159 |
|
* |
160 |
< |
* @return an iterator over the elements in this set. |
160 |
> |
* @return an iterator over the elements in this set in ascending order |
161 |
|
*/ |
162 |
|
public Iterator<E> iterator() { |
163 |
< |
return m.keySet().iterator(); |
163 |
> |
return m.keySet().iterator(); |
164 |
|
} |
165 |
|
|
166 |
|
/** |
167 |
< |
* Returns an iterator over the elements in this set. The elements |
168 |
< |
* are returned in descending order. |
167 |
> |
* Returns an iterator over the elements in this set in descending order. |
168 |
|
* |
169 |
< |
* @return an iterator over the elements in this set. |
169 |
> |
* @return an iterator over the elements in this set in descending order |
170 |
> |
* @since 1.6 |
171 |
|
*/ |
172 |
|
public Iterator<E> descendingIterator() { |
173 |
|
return m.descendingKeySet().iterator(); |
176 |
|
/** |
177 |
|
* Returns the number of elements in this set (its cardinality). |
178 |
|
* |
179 |
< |
* @return the number of elements in this set (its cardinality). |
179 |
> |
* @return the number of elements in this set (its cardinality) |
180 |
|
*/ |
181 |
|
public int size() { |
182 |
|
return m.size(); |
185 |
|
/** |
186 |
|
* Returns <tt>true</tt> if this set contains no elements. |
187 |
|
* |
188 |
< |
* @return <tt>true</tt> if this set contains no elements. |
188 |
> |
* @return <tt>true</tt> if this set contains no elements |
189 |
|
*/ |
190 |
|
public boolean isEmpty() { |
191 |
|
return m.isEmpty(); |
193 |
|
|
194 |
|
/** |
195 |
|
* Returns <tt>true</tt> if this set contains the specified element. |
196 |
+ |
* More formally, returns <tt>true</tt> if and only if this set |
197 |
+ |
* contains an element <tt>e</tt> such that |
198 |
+ |
* <tt>(o==null ? e==null : o.equals(e))</tt>. |
199 |
|
* |
200 |
< |
* @param o the object to be checked for containment in this set. |
201 |
< |
* @return <tt>true</tt> if this set contains the specified element. |
199 |
< |
* |
200 |
> |
* @param o object to be checked for containment in this set |
201 |
> |
* @return <tt>true</tt> if this set contains the specified element |
202 |
|
* @throws ClassCastException if the specified object cannot be compared |
203 |
< |
* with the elements currently in the set. |
204 |
< |
* @throws NullPointerException if o is <tt>null</tt> and this map |
205 |
< |
* uses natural ordering and is non-empty, or its comparator does |
206 |
< |
* not tolerate <tt>null</tt> keys. |
203 |
> |
* with the elements currently in the set |
204 |
> |
* @throws NullPointerException if the specified element is null |
205 |
> |
* and this set uses natural ordering, or its comparator |
206 |
> |
* does not permit null elements |
207 |
|
*/ |
208 |
|
public boolean contains(Object o) { |
209 |
|
return m.containsKey(o); |
211 |
|
|
212 |
|
/** |
213 |
|
* Adds the specified element to this set if it is not already present. |
214 |
< |
* |
215 |
< |
* @param o element to be added to this set. |
216 |
< |
* @return <tt>true</tt> if the set did not already contain the specified |
217 |
< |
* element. |
218 |
< |
* |
214 |
> |
* More formally, adds the specified element <tt>e</tt> to this set if |
215 |
> |
* the set contains no element <tt>e2</tt> such that |
216 |
> |
* <tt>(e==null ? e2==null : e.equals(e2))</tt>. |
217 |
> |
* If this set already contains the element, the call leaves the set |
218 |
> |
* unchanged and returns <tt>false</tt>. |
219 |
> |
* |
220 |
> |
* @param e element to be added to this set |
221 |
> |
* @return <tt>true</tt> if this set did not already contain the specified |
222 |
> |
* element |
223 |
|
* @throws ClassCastException if the specified object cannot be compared |
224 |
< |
* with the elements currently in the set. |
225 |
< |
* @throws NullPointerException if o is <tt>null</tt> and this map |
226 |
< |
* uses natural ordering and is non-empty, or its comparator does |
227 |
< |
* not tolerate <tt>null</tt> keys. |
224 |
> |
* with the elements currently in this set |
225 |
> |
* @throws NullPointerException if the specified element is null |
226 |
> |
* and this set uses natural ordering, or its comparator |
227 |
> |
* does not permit null elements |
228 |
|
*/ |
229 |
< |
public boolean add(E o) { |
230 |
< |
return m.put(o, PRESENT)==null; |
229 |
> |
public boolean add(E e) { |
230 |
> |
return m.put(e, PRESENT)==null; |
231 |
|
} |
232 |
|
|
233 |
|
/** |
234 |
|
* Removes the specified element from this set if it is present. |
235 |
+ |
* More formally, removes an element <tt>e</tt> such that |
236 |
+ |
* <tt>(o==null ? e==null : o.equals(e))</tt>, |
237 |
+ |
* if this set contains such an element. Returns <tt>true</tt> if |
238 |
+ |
* this set contained the element (or equivalently, if this set |
239 |
+ |
* changed as a result of the call). (This set will not contain the |
240 |
+ |
* element once the call returns.) |
241 |
|
* |
242 |
< |
* @param o object to be removed from this set, if present. |
243 |
< |
* @return <tt>true</tt> if the set contained the specified element. |
232 |
< |
* |
242 |
> |
* @param o object to be removed from this set, if present |
243 |
> |
* @return <tt>true</tt> if this set contained the specified element |
244 |
|
* @throws ClassCastException if the specified object cannot be compared |
245 |
< |
* with the elements currently in the set. |
246 |
< |
* @throws NullPointerException if o is <tt>null</tt> and this map |
247 |
< |
* uses natural ordering and is non-empty, or its comparator does |
248 |
< |
* not tolerate <tt>null</tt> keys. |
245 |
> |
* with the elements currently in this set |
246 |
> |
* @throws NullPointerException if the specified element is null |
247 |
> |
* and this set uses natural ordering, or its comparator |
248 |
> |
* does not permit null elements |
249 |
|
*/ |
250 |
|
public boolean remove(Object o) { |
251 |
|
return m.remove(o)==PRESENT; |
253 |
|
|
254 |
|
/** |
255 |
|
* Removes all of the elements from this set. |
256 |
+ |
* The set will be empty after this call returns. |
257 |
|
*/ |
258 |
|
public void clear() { |
259 |
|
m.clear(); |
262 |
|
/** |
263 |
|
* Adds all of the elements in the specified collection to this set. |
264 |
|
* |
265 |
< |
* @param c elements to be added |
266 |
< |
* @return <tt>true</tt> if this set changed as a result of the call. |
255 |
< |
* |
265 |
> |
* @param c collection containing elements to be added to this set |
266 |
> |
* @return <tt>true</tt> if this set changed as a result of the call |
267 |
|
* @throws ClassCastException if the elements provided cannot be compared |
268 |
< |
* with the elements currently in the set. |
269 |
< |
* @throws NullPointerException if the specified collection is |
270 |
< |
* <tt>null</tt> or if any element is <tt>null</tt> and this map |
271 |
< |
* uses natural ordering, or its comparator does not tolerate |
261 |
< |
* <tt>null</tt> keys. |
268 |
> |
* with the elements currently in the set |
269 |
> |
* @throws NullPointerException if the specified collection is null or |
270 |
> |
* if any element is null and this set uses natural ordering, or |
271 |
> |
* its comparator does not permit null elements |
272 |
|
*/ |
273 |
|
public boolean addAll(Collection<? extends E> c) { |
274 |
|
// Use linear-time version if applicable |
275 |
|
if (m.size()==0 && c.size() > 0 && |
276 |
|
c instanceof SortedSet && |
277 |
|
m instanceof TreeMap) { |
278 |
< |
SortedSet<Map.Entry<E, Object>> set = (SortedSet<Map.Entry<E, Object>>) (SortedSet) c; |
278 |
> |
SortedSet<? extends E> set = (SortedSet<? extends E>) c; |
279 |
|
TreeMap<E,Object> map = (TreeMap<E, Object>) m; |
280 |
< |
Comparator<? super E> cc = (Comparator<E>) set.comparator(); |
280 |
> |
Comparator<? super E> cc = (Comparator<? super E>) set.comparator(); |
281 |
|
Comparator<? super E> mc = map.comparator(); |
282 |
|
if (cc==mc || (cc != null && cc.equals(mc))) { |
283 |
|
map.addAllForTreeSet(set, PRESENT); |
288 |
|
} |
289 |
|
|
290 |
|
/** |
291 |
< |
* Returns a view of the portion of this set whose elements range |
282 |
< |
* from <tt>fromElement</tt>, inclusive, to <tt>toElement</tt>, |
283 |
< |
* exclusive. (If <tt>fromElement</tt> and <tt>toElement</tt> are |
284 |
< |
* equal, the returned navigable set is empty.) The returned |
285 |
< |
* navigable set is backed by this set, so changes in the returned |
286 |
< |
* navigable set are reflected in this set, and vice-versa. The |
287 |
< |
* returned navigable set supports all optional Set operations.<p> |
288 |
< |
* |
289 |
< |
* The navigable set returned by this method will throw an |
290 |
< |
* <tt>IllegalArgumentException</tt> if the user attempts to insert an |
291 |
< |
* element outside the specified range.<p> |
292 |
< |
* |
293 |
< |
* Note: this method always returns a <i>half-open range</i> |
294 |
< |
* (which includes its low endpoint but not its high endpoint). |
295 |
< |
* If you need a <i>closed range</i> (which includes both |
296 |
< |
* endpoints), and the element type allows for calculation of the |
297 |
< |
* successor of a specified value, merely request the subrange |
298 |
< |
* from <tt>lowEndpoint</tt> to <tt>successor(highEndpoint)</tt>. |
299 |
< |
* For example, suppose that <tt>s</tt> is a navigable set of |
300 |
< |
* strings. The following idiom obtains a view containing all of |
301 |
< |
* the strings in <tt>s</tt> from <tt>low</tt> to <tt>high</tt>, |
302 |
< |
* inclusive: |
303 |
< |
* <pre> NavigableSet sub = s.navigableSubSet(low, high+"\0"); |
304 |
< |
* </pre> |
305 |
< |
* |
306 |
< |
* A similar technique can be used to generate an <i>open range</i> (which |
307 |
< |
* contains neither endpoint). The following idiom obtains a view |
308 |
< |
* containing all of the strings in <tt>s</tt> from <tt>low</tt> to |
309 |
< |
* <tt>high</tt>, exclusive: <pre> |
310 |
< |
* NavigableSet sub = s.navigableSubSet(low+"\0", high); |
311 |
< |
* </pre> |
312 |
< |
* |
313 |
< |
* @param fromElement low endpoint (inclusive) of the range. |
314 |
< |
* @param toElement high endpoint (exclusive) of the range. |
315 |
< |
* @return a view of the portion of this set whose elements range from |
316 |
< |
* <tt>fromElement</tt>, inclusive, to <tt>toElement</tt>, |
317 |
< |
* exclusive. |
318 |
< |
* @throws ClassCastException if <tt>fromElement</tt> and |
319 |
< |
* <tt>toElement</tt> cannot be compared to one another using |
320 |
< |
* this set's comparator (or, if the set has no comparator, |
321 |
< |
* using natural ordering). |
322 |
< |
* @throws IllegalArgumentException if <tt>fromElement</tt> is greater than |
323 |
< |
* <tt>toElement</tt>. |
291 |
> |
* @throws ClassCastException {@inheritDoc} |
292 |
|
* @throws NullPointerException if <tt>fromElement</tt> or |
293 |
< |
* <tt>toElement</tt> is <tt>null</tt> and this set uses natural |
294 |
< |
* order, or its comparator does not tolerate <tt>null</tt> |
295 |
< |
* elements. |
293 |
> |
* <tt>toElement</tt> is null and this set uses natural ordering, |
294 |
> |
* or its comparator does not permit null elements |
295 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
296 |
> |
* @since 1.6 |
297 |
|
*/ |
298 |
|
public NavigableSet<E> navigableSubSet(E fromElement, E toElement) { |
299 |
|
return new TreeSet<E>(m.navigableSubMap(fromElement, toElement)); |
300 |
|
} |
301 |
|
|
302 |
|
/** |
303 |
< |
* Returns a view of the portion of this set whose elements are |
304 |
< |
* strictly less than <tt>toElement</tt>. The returned navigable |
305 |
< |
* set is backed by this set, so changes in the returned navigable |
306 |
< |
* set are reflected in this set, and vice-versa. The returned |
307 |
< |
* navigable set supports all optional set operations.<p> |
308 |
< |
* |
340 |
< |
* The navigable set returned by this method will throw an |
341 |
< |
* <tt>IllegalArgumentException</tt> if the user attempts to |
342 |
< |
* insert an element greater than or equal to |
343 |
< |
* <tt>toElement</tt>.<p> |
344 |
< |
* |
345 |
< |
* Note: this method always returns a view that does not contain |
346 |
< |
* its (high) endpoint. If you need a view that does contain this |
347 |
< |
* endpoint, and the element type allows for calculation of the |
348 |
< |
* successor of a specified value, merely request a headSet |
349 |
< |
* bounded by <tt>successor(highEndpoint)</tt>. For example, |
350 |
< |
* suppose that <tt>s</tt> is a navigable set of strings. The |
351 |
< |
* following idiom obtains a view containing all of the strings in |
352 |
< |
* <tt>s</tt> that are less than or equal to <tt>high</tt>: |
353 |
< |
* <pre> NavigableSet head = s.navigableHeadSet(high+"\0");</pre> |
354 |
< |
* |
355 |
< |
* @param toElement high endpoint (exclusive) of the headSet. |
356 |
< |
* @return a view of the portion of this set whose elements are strictly |
357 |
< |
* less than <tt>toElement</tt>. |
358 |
< |
* @throws ClassCastException if <tt>toElement</tt> is not compatible |
359 |
< |
* with this set's comparator (or, if the set has no comparator, |
360 |
< |
* if <tt>toElement</tt> does not implement <tt>Comparable</tt>). |
361 |
< |
* @throws IllegalArgumentException if this set is itself a subset, |
362 |
< |
* and <tt>toElement</tt> is not within the |
363 |
< |
* specified range of the subset. |
364 |
< |
* @throws NullPointerException if <tt>toElement</tt> is <tt>null</tt> and |
365 |
< |
* this set uses natural ordering, or its comparator does |
366 |
< |
* not tolerate <tt>null</tt> elements. |
303 |
> |
* @throws ClassCastException {@inheritDoc} |
304 |
> |
* @throws NullPointerException if <tt>toElement</tt> is null and |
305 |
> |
* this set uses natural ordering, or its comparator does |
306 |
> |
* not permit null elements |
307 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
308 |
> |
* @since 1.6 |
309 |
|
*/ |
310 |
|
public NavigableSet<E> navigableHeadSet(E toElement) { |
311 |
|
return new TreeSet<E>(m.navigableHeadMap(toElement)); |
312 |
|
} |
313 |
|
|
314 |
|
/** |
315 |
< |
* Returns a view of the portion of this set whose elements are |
316 |
< |
* greater than or equal to <tt>fromElement</tt>. The returned |
317 |
< |
* navigable set is backed by this set, so changes in the returned |
318 |
< |
* navigable set are reflected in this set, and vice-versa. The |
319 |
< |
* returned navigable set supports all optional set operations.<p> |
320 |
< |
* |
379 |
< |
* The navigable set returned by this method will throw an |
380 |
< |
* <tt>IllegalArgumentException</tt> if the user attempts to insert an |
381 |
< |
* element less than <tt>fromElement</tt>. |
382 |
< |
* |
383 |
< |
* Note: this method always returns a view that contains its (low) |
384 |
< |
* endpoint. If you need a view that does not contain this |
385 |
< |
* endpoint, and the element type allows for calculation of the |
386 |
< |
* successor of a specified value, merely request a tailSet |
387 |
< |
* bounded by <tt>successor(lowEndpoint)</tt>. For example, |
388 |
< |
* suppose that <tt>s</tt> is a navigable set of strings. The |
389 |
< |
* following idiom obtains a view containing all of the strings in |
390 |
< |
* <tt>s</tt> that are strictly greater than <tt>low</tt>: |
391 |
< |
* <pre> NavigableSet tail = s.navigableTailSet(low+"\0"); |
392 |
< |
* </pre> |
393 |
< |
* |
394 |
< |
* @param fromElement low endpoint (inclusive) of the tailSet. |
395 |
< |
* @return a view of the portion of this set whose elements are |
396 |
< |
* greater than or equal to <tt>fromElement</tt>. |
397 |
< |
* @throws ClassCastException if <tt>fromElement</tt> is not compatible |
398 |
< |
* with this set's comparator (or, if the set has no comparator, |
399 |
< |
* if <tt>fromElement</tt> does not implement <tt>Comparable</tt>). |
400 |
< |
* @throws IllegalArgumentException if this set is itself a subset, |
401 |
< |
* and <tt>fromElement</tt> is not within the |
402 |
< |
* specified range of the subset. |
403 |
< |
* @throws NullPointerException if <tt>fromElement</tt> is <tt>null</tt> |
404 |
< |
* and this set uses natural ordering, or its comparator does |
405 |
< |
* not tolerate <tt>null</tt> elements. |
315 |
> |
* @throws ClassCastException {@inheritDoc} |
316 |
> |
* @throws NullPointerException if <tt>fromElement</tt> is null and |
317 |
> |
* this set uses natural ordering, or its comparator does |
318 |
> |
* not permit null elements |
319 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
320 |
> |
* @since 1.6 |
321 |
|
*/ |
322 |
|
public NavigableSet<E> navigableTailSet(E fromElement) { |
323 |
|
return new TreeSet<E>(m.navigableTailMap(fromElement)); |
324 |
|
} |
325 |
|
|
411 |
– |
|
326 |
|
/** |
327 |
< |
* Equivalent to <tt>navigableSubSet</tt> but with a return |
328 |
< |
* type conforming to the <tt>SortedSet</tt> interface. |
329 |
< |
* @param fromElement low endpoint (inclusive) of the range. |
330 |
< |
* @param toElement high endpoint (exclusive) of the range. |
331 |
< |
* @return a view of the portion of this set whose elements range from |
332 |
< |
* <tt>fromElement</tt>, inclusive, to <tt>toElement</tt>, |
419 |
< |
* exclusive. |
420 |
< |
* @throws ClassCastException if <tt>fromElement</tt> and |
421 |
< |
* <tt>toElement</tt> cannot be compared to one another using |
422 |
< |
* this set's comparator (or, if the set has no comparator, |
423 |
< |
* using natural ordering). |
424 |
< |
* @throws IllegalArgumentException if <tt>fromElement</tt> is greater than |
425 |
< |
* <tt>toElement</tt>. |
327 |
> |
* Equivalent to {@link #navigableSubSet} but with a return type |
328 |
> |
* conforming to the <tt>SortedSet</tt> interface. |
329 |
> |
* |
330 |
> |
* <p>{@inheritDoc} |
331 |
> |
* |
332 |
> |
* @throws ClassCastException {@inheritDoc} |
333 |
|
* @throws NullPointerException if <tt>fromElement</tt> or |
334 |
< |
* <tt>toElement</tt> is <tt>null</tt> and this set uses natural |
335 |
< |
* order, or its comparator does not tolerate <tt>null</tt> |
336 |
< |
* elements. |
334 |
> |
* <tt>toElement</tt> is null and this set uses natural ordering, |
335 |
> |
* or its comparator does not permit null elements |
336 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
337 |
|
*/ |
338 |
|
public SortedSet<E> subSet(E fromElement, E toElement) { |
339 |
|
return new TreeSet<E>(m.navigableSubMap(fromElement, toElement)); |
340 |
|
} |
341 |
|
|
342 |
|
/** |
343 |
< |
* Equivalent to <tt>navigableHeadSet</tt> but with a return |
344 |
< |
* type conforming to the <tt>SortedSet</tt> interface. |
343 |
> |
* Equivalent to {@link #navigableHeadSet} but with a return type |
344 |
> |
* conforming to the <tt>SortedSet</tt> interface. |
345 |
> |
* |
346 |
> |
* <p>{@inheritDoc} |
347 |
|
* |
348 |
< |
* @param toElement high endpoint (exclusive) of the headSet. |
349 |
< |
* @return a view of the portion of this set whose elements are strictly |
350 |
< |
* less than <tt>toElement</tt>. |
351 |
< |
* @throws ClassCastException if <tt>toElement</tt> is not compatible |
352 |
< |
* with this set's comparator (or, if the set has no comparator, |
444 |
< |
* if <tt>toElement</tt> does not implement <tt>Comparable</tt>). |
445 |
< |
* @throws IllegalArgumentException if this set is itself a subset, |
446 |
< |
* and <tt>toElement</tt> is not within the |
447 |
< |
* specified range of the subset. |
448 |
< |
* @throws NullPointerException if <tt>toElement</tt> is <tt>null</tt> and |
449 |
< |
* this set uses natural ordering, or its comparator does |
450 |
< |
* not tolerate <tt>null</tt> elements. |
348 |
> |
* @throws ClassCastException {@inheritDoc} |
349 |
> |
* @throws NullPointerException if <tt>toElement</tt> is null |
350 |
> |
* and this set uses natural ordering, or its comparator does |
351 |
> |
* not permit null elements |
352 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
353 |
|
*/ |
354 |
|
public SortedSet<E> headSet(E toElement) { |
355 |
|
return new TreeSet<E>(m.navigableHeadMap(toElement)); |
356 |
|
} |
357 |
|
|
358 |
|
/** |
359 |
< |
* Equivalent to <tt>navigableTailSet</tt> but with a return |
360 |
< |
* type conforming to the <tt>SortedSet</tt> interface. |
361 |
< |
* @param fromElement low endpoint (inclusive) of the tailSet. |
362 |
< |
* @return a view of the portion of this set whose elements are |
363 |
< |
* greater than or equal to <tt>fromElement</tt>. |
364 |
< |
* @throws ClassCastException if <tt>fromElement</tt> is not compatible |
365 |
< |
* with this set's comparator (or, if the set has no comparator, |
366 |
< |
* if <tt>fromElement</tt> does not implement <tt>Comparable</tt>). |
367 |
< |
* @throws IllegalArgumentException if this set is itself a subset, |
368 |
< |
* and <tt>fromElement</tt> is not within the |
467 |
< |
* specified range of the subset. |
468 |
< |
* @throws NullPointerException if <tt>fromElement</tt> is <tt>null</tt> |
469 |
< |
* and this set uses natural ordering, or its comparator does |
470 |
< |
* not tolerate <tt>null</tt> elements. |
359 |
> |
* Equivalent to {@link #navigableTailSet} but with a return type |
360 |
> |
* conforming to the <tt>SortedSet</tt> interface. |
361 |
> |
* |
362 |
> |
* <p>{@inheritDoc} |
363 |
> |
* |
364 |
> |
* @throws ClassCastException {@inheritDoc} |
365 |
> |
* @throws NullPointerException if <tt>fromElement</tt> is null |
366 |
> |
* and this set uses natural ordering, or its comparator does |
367 |
> |
* not permit null elements |
368 |
> |
* @throws IllegalArgumentException {@inheritDoc} |
369 |
|
*/ |
370 |
|
public SortedSet<E> tailSet(E fromElement) { |
371 |
|
return new TreeSet<E>(m.navigableTailMap(fromElement)); |
372 |
|
} |
373 |
|
|
476 |
– |
/** |
477 |
– |
* Returns the comparator used to order this sorted set, or <tt>null</tt> |
478 |
– |
* if this tree set uses its elements natural ordering. |
479 |
– |
* |
480 |
– |
* @return the comparator used to order this sorted set, or <tt>null</tt> |
481 |
– |
* if this tree set uses its elements natural ordering. |
482 |
– |
*/ |
374 |
|
public Comparator<? super E> comparator() { |
375 |
|
return m.comparator(); |
376 |
|
} |
377 |
|
|
378 |
|
/** |
379 |
< |
* Returns the first (lowest) element currently in this sorted set. |
489 |
< |
* |
490 |
< |
* @return the first (lowest) element currently in this sorted set. |
491 |
< |
* @throws NoSuchElementException sorted set is empty. |
379 |
> |
* @throws NoSuchElementException {@inheritDoc} |
380 |
|
*/ |
381 |
|
public E first() { |
382 |
|
return m.firstKey(); |
383 |
|
} |
384 |
|
|
385 |
|
/** |
386 |
< |
* Returns the last (highest) element currently in this sorted set. |
499 |
< |
* |
500 |
< |
* @return the last (highest) element currently in this sorted set. |
501 |
< |
* @throws NoSuchElementException sorted set is empty. |
386 |
> |
* @throws NoSuchElementException {@inheritDoc} |
387 |
|
*/ |
388 |
|
public E last() { |
389 |
|
return m.lastKey(); |
391 |
|
|
392 |
|
// NavigableSet API methods |
393 |
|
|
394 |
+ |
/** |
395 |
+ |
* @throws ClassCastException {@inheritDoc} |
396 |
+ |
* @throws NullPointerException if the specified element is null |
397 |
+ |
* and this set uses natural ordering, or its comparator |
398 |
+ |
* does not permit null elements |
399 |
+ |
* @since 1.6 |
400 |
+ |
*/ |
401 |
+ |
public E lower(E e) { |
402 |
+ |
return m.lowerKey(e); |
403 |
+ |
} |
404 |
|
|
405 |
|
/** |
406 |
< |
* Returns an element greater than or equal to the given element, or |
407 |
< |
* <tt>null</tt> if there is no such element. |
408 |
< |
* |
409 |
< |
* @param o the value to match |
410 |
< |
* @return an element greater than or equal to given element, or |
516 |
< |
* <tt>null</tt> if there is no such element. |
517 |
< |
* @throws ClassCastException if o cannot be compared with the elements |
518 |
< |
* currently in the set. |
519 |
< |
* @throws NullPointerException if o is <tt>null</tt> and this map |
520 |
< |
* uses natural ordering and is non-empty, or its comparator does |
521 |
< |
* not tolerate <tt>null</tt> keys. |
522 |
< |
*/ |
523 |
< |
public E ceiling(E o) { |
524 |
< |
return m.ceilingKey(o); |
525 |
< |
} |
526 |
< |
|
527 |
< |
/** |
528 |
< |
* Returns an element strictly less than the given element, or |
529 |
< |
* <tt>null</tt> if there is no such element. |
530 |
< |
* |
531 |
< |
* @param o the value to match |
532 |
< |
* @return the greatest element less than the given element, or |
533 |
< |
* <tt>null</tt> if there is no such element. |
534 |
< |
* @throws ClassCastException if o cannot be compared with the elements |
535 |
< |
* currently in the set. |
536 |
< |
* @throws NullPointerException if o is <tt>null</tt> and this map |
537 |
< |
* uses natural ordering and is non-empty, or its comparator does |
538 |
< |
* not tolerate <tt>null</tt> keys. |
539 |
< |
*/ |
540 |
< |
public E lower(E o) { |
541 |
< |
return m.lowerKey(o); |
542 |
< |
} |
543 |
< |
|
544 |
< |
/** |
545 |
< |
* Returns an element less than or equal to the given element, or |
546 |
< |
* <tt>null</tt> if there is no such element. |
547 |
< |
* |
548 |
< |
* @param o the value to match |
549 |
< |
* @return the greatest element less than or equal to given |
550 |
< |
* element, or <tt>null</tt> if there is no such element. |
551 |
< |
* @throws ClassCastException if o cannot be compared with the elements |
552 |
< |
* currently in the set. |
553 |
< |
* @throws NullPointerException if o is <tt>null</tt> and this map |
554 |
< |
* uses natural ordering and is non-empty, or its comparator does |
555 |
< |
* not tolerate <tt>null</tt> keys. |
556 |
< |
*/ |
557 |
< |
public E floor(E o) { |
558 |
< |
return m.floorKey(o); |
559 |
< |
} |
560 |
< |
|
561 |
< |
/** |
562 |
< |
* Returns an element strictly greater than the given element, or |
563 |
< |
* <tt>null</tt> if there is no such element. |
564 |
< |
* |
565 |
< |
* @param o the value to match |
566 |
< |
* @return the least element greater than the given element, or |
567 |
< |
* <tt>null</tt> if there is no such element. |
568 |
< |
* @throws ClassCastException if o cannot be compared with the elements |
569 |
< |
* currently in the set. |
570 |
< |
* @throws NullPointerException if o is <tt>null</tt> and this map |
571 |
< |
* uses natural ordering and is non-empty, or its comparator does |
572 |
< |
* not tolerate <tt>null</tt> keys. |
406 |
> |
* @throws ClassCastException {@inheritDoc} |
407 |
> |
* @throws NullPointerException if the specified element is null |
408 |
> |
* and this set uses natural ordering, or its comparator |
409 |
> |
* does not permit null elements |
410 |
> |
* @since 1.6 |
411 |
|
*/ |
412 |
< |
public E higher(E o) { |
413 |
< |
return m.higherKey(o); |
412 |
> |
public E floor(E e) { |
413 |
> |
return m.floorKey(e); |
414 |
|
} |
415 |
|
|
416 |
|
/** |
417 |
< |
* Retrieves and removes the first (lowest) element. |
418 |
< |
* |
419 |
< |
* @return the least element, or <tt>null</tt> if empty. |
417 |
> |
* @throws ClassCastException {@inheritDoc} |
418 |
> |
* @throws NullPointerException if the specified element is null |
419 |
> |
* and this set uses natural ordering, or its comparator |
420 |
> |
* does not permit null elements |
421 |
> |
* @since 1.6 |
422 |
> |
*/ |
423 |
> |
public E ceiling(E e) { |
424 |
> |
return m.ceilingKey(e); |
425 |
> |
} |
426 |
> |
|
427 |
> |
/** |
428 |
> |
* @throws ClassCastException {@inheritDoc} |
429 |
> |
* @throws NullPointerException if the specified element is null |
430 |
> |
* and this set uses natural ordering, or its comparator |
431 |
> |
* does not permit null elements |
432 |
> |
* @since 1.6 |
433 |
> |
*/ |
434 |
> |
public E higher(E e) { |
435 |
> |
return m.higherKey(e); |
436 |
> |
} |
437 |
> |
|
438 |
> |
/** |
439 |
> |
* @since 1.6 |
440 |
|
*/ |
441 |
|
public E pollFirst() { |
442 |
|
Map.Entry<E,?> e = m.pollFirstEntry(); |
444 |
|
} |
445 |
|
|
446 |
|
/** |
447 |
< |
* Retrieves and removes the last (highest) element. |
590 |
< |
* |
591 |
< |
* @return the last element, or <tt>null</tt> if empty. |
447 |
> |
* @since 1.6 |
448 |
|
*/ |
449 |
|
public E pollLast() { |
450 |
|
Map.Entry<E,?> e = m.pollLastEntry(); |
455 |
|
* Returns a shallow copy of this <tt>TreeSet</tt> instance. (The elements |
456 |
|
* themselves are not cloned.) |
457 |
|
* |
458 |
< |
* @return a shallow copy of this set. |
458 |
> |
* @return a shallow copy of this set |
459 |
|
*/ |
460 |
|
public Object clone() { |
461 |
|
TreeSet<E> clone = null; |
475 |
|
* serialize it). |
476 |
|
* |
477 |
|
* @serialData Emits the comparator used to order this set, or |
478 |
< |
* <tt>null</tt> if it obeys its elements' natural ordering |
479 |
< |
* (Object), followed by the size of the set (the number of |
480 |
< |
* elements it contains) (int), followed by all of its |
481 |
< |
* elements (each an Object) in order (as determined by the |
482 |
< |
* set's Comparator, or by the elements' natural ordering if |
478 |
> |
* <tt>null</tt> if it obeys its elements' natural ordering |
479 |
> |
* (Object), followed by the size of the set (the number of |
480 |
> |
* elements it contains) (int), followed by all of its |
481 |
> |
* elements (each an Object) in order (as determined by the |
482 |
> |
* set's Comparator, or by the elements' natural ordering if |
483 |
|
* the set has no Comparator). |
484 |
|
*/ |
485 |
|
private void writeObject(java.io.ObjectOutputStream s) |
508 |
|
s.defaultReadObject(); |
509 |
|
|
510 |
|
// Read in Comparator |
511 |
< |
Comparator<E> c = (Comparator<E>) s.readObject(); |
511 |
> |
Comparator<? super E> c = (Comparator<? super E>) s.readObject(); |
512 |
|
|
513 |
|
// Create backing TreeMap |
514 |
|
TreeMap<E,Object> tm; |