1 |
/* |
2 |
* Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved. |
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
5 |
* This code is free software; you can redistribute it and/or modify it |
6 |
* under the terms of the GNU General Public License version 2 only, as |
7 |
* published by the Free Software Foundation. Sun designates this |
8 |
* particular file as subject to the "Classpath" exception as provided |
9 |
* by Sun in the LICENSE file that accompanied this code. |
10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
15 |
* accompanied this code). |
16 |
* |
17 |
* You should have received a copy of the GNU General Public License version |
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
20 |
* |
21 |
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
22 |
* CA 95054 USA or visit www.sun.com if you need additional information or |
23 |
* have any questions. |
24 |
*/ |
25 |
|
26 |
package java.util; |
27 |
|
28 |
/** |
29 |
* Resizable-array implementation of the <tt>List</tt> interface. Implements |
30 |
* all optional list operations, and permits all elements, including |
31 |
* <tt>null</tt>. In addition to implementing the <tt>List</tt> interface, |
32 |
* this class provides methods to manipulate the size of the array that is |
33 |
* used internally to store the list. (This class is roughly equivalent to |
34 |
* <tt>Vector</tt>, except that it is unsynchronized.) |
35 |
* |
36 |
* <p>The <tt>size</tt>, <tt>isEmpty</tt>, <tt>get</tt>, <tt>set</tt>, |
37 |
* <tt>iterator</tt>, and <tt>listIterator</tt> operations run in constant |
38 |
* time. The <tt>add</tt> operation runs in <i>amortized constant time</i>, |
39 |
* that is, adding n elements requires O(n) time. All of the other operations |
40 |
* run in linear time (roughly speaking). The constant factor is low compared |
41 |
* to that for the <tt>LinkedList</tt> implementation. |
42 |
* |
43 |
* <p>Each <tt>ArrayList</tt> instance has a <i>capacity</i>. The capacity is |
44 |
* the size of the array used to store the elements in the list. It is always |
45 |
* at least as large as the list size. As elements are added to an ArrayList, |
46 |
* its capacity grows automatically. The details of the growth policy are not |
47 |
* specified beyond the fact that adding an element has constant amortized |
48 |
* time cost. |
49 |
* |
50 |
* <p>An application can increase the capacity of an <tt>ArrayList</tt> instance |
51 |
* before adding a large number of elements using the <tt>ensureCapacity</tt> |
52 |
* operation. This may reduce the amount of incremental reallocation. |
53 |
* |
54 |
* <p><strong>Note that this implementation is not synchronized.</strong> |
55 |
* If multiple threads access an <tt>ArrayList</tt> instance concurrently, |
56 |
* and at least one of the threads modifies the list structurally, it |
57 |
* <i>must</i> be synchronized externally. (A structural modification is |
58 |
* any operation that adds or deletes one or more elements, or explicitly |
59 |
* resizes the backing array; merely setting the value of an element is not |
60 |
* a structural modification.) This is typically accomplished by |
61 |
* synchronizing on some object that naturally encapsulates the list. |
62 |
* |
63 |
* If no such object exists, the list should be "wrapped" using the |
64 |
* {@link Collections#synchronizedList Collections.synchronizedList} |
65 |
* method. This is best done at creation time, to prevent accidental |
66 |
* unsynchronized access to the list:<pre> |
67 |
* List list = Collections.synchronizedList(new ArrayList(...));</pre> |
68 |
* |
69 |
* <p><a name="fail-fast"/> |
70 |
* The iterators returned by this class's {@link #iterator() iterator} and |
71 |
* {@link #listIterator(int) listIterator} methods are <em>fail-fast</em>: |
72 |
* if the list is structurally modified at any time after the iterator is |
73 |
* created, in any way except through the iterator's own |
74 |
* {@link ListIterator#remove() remove} or |
75 |
* {@link ListIterator#add(Object) add} methods, the iterator will throw a |
76 |
* {@link ConcurrentModificationException}. Thus, in the face of |
77 |
* concurrent modification, the iterator fails quickly and cleanly, rather |
78 |
* than risking arbitrary, non-deterministic behavior at an undetermined |
79 |
* time in the future. |
80 |
* |
81 |
* <p>Note that the fail-fast behavior of an iterator cannot be guaranteed |
82 |
* as it is, generally speaking, impossible to make any hard guarantees in the |
83 |
* presence of unsynchronized concurrent modification. Fail-fast iterators |
84 |
* throw {@code ConcurrentModificationException} on a best-effort basis. |
85 |
* Therefore, it would be wrong to write a program that depended on this |
86 |
* exception for its correctness: <i>the fail-fast behavior of iterators |
87 |
* should be used only to detect bugs.</i> |
88 |
* |
89 |
* <p>This class is a member of the |
90 |
* <a href="{@docRoot}/../technotes/guides/collections/index.html"> |
91 |
* Java Collections Framework</a>. |
92 |
* |
93 |
* @author Josh Bloch |
94 |
* @author Neal Gafter |
95 |
* @version %I%, %G% |
96 |
* @see Collection |
97 |
* @see List |
98 |
* @see LinkedList |
99 |
* @see Vector |
100 |
* @since 1.2 |
101 |
*/ |
102 |
|
103 |
public class ArrayList<E> extends AbstractList<E> |
104 |
implements List<E>, RandomAccess, Cloneable, java.io.Serializable |
105 |
{ |
106 |
private static final long serialVersionUID = 8683452581122892189L; |
107 |
|
108 |
/** |
109 |
* The array buffer into which the elements of the ArrayList are stored. |
110 |
* The capacity of the ArrayList is the length of this array buffer. |
111 |
*/ |
112 |
private transient Object[] elementData; |
113 |
|
114 |
/** |
115 |
* The size of the ArrayList (the number of elements it contains). |
116 |
* |
117 |
* @serial |
118 |
*/ |
119 |
private int size; |
120 |
|
121 |
/** |
122 |
* Constructs an empty list with the specified initial capacity. |
123 |
* |
124 |
* @param initialCapacity the initial capacity of the list |
125 |
* @exception IllegalArgumentException if the specified initial capacity |
126 |
* is negative |
127 |
*/ |
128 |
public ArrayList(int initialCapacity) { |
129 |
super(); |
130 |
if (initialCapacity < 0) |
131 |
throw new IllegalArgumentException("Illegal Capacity: "+ |
132 |
initialCapacity); |
133 |
this.elementData = new Object[initialCapacity]; |
134 |
} |
135 |
|
136 |
/** |
137 |
* Constructs an empty list with an initial capacity of ten. |
138 |
*/ |
139 |
public ArrayList() { |
140 |
this(10); |
141 |
} |
142 |
|
143 |
/** |
144 |
* Constructs a list containing the elements of the specified |
145 |
* collection, in the order they are returned by the collection's |
146 |
* iterator. |
147 |
* |
148 |
* @param c the collection whose elements are to be placed into this list |
149 |
* @throws NullPointerException if the specified collection is null |
150 |
*/ |
151 |
public ArrayList(Collection<? extends E> c) { |
152 |
elementData = c.toArray(); |
153 |
size = elementData.length; |
154 |
// c.toArray might (incorrectly) not return Object[] (see 6260652) |
155 |
if (elementData.getClass() != Object[].class) |
156 |
elementData = Arrays.copyOf(elementData, size, Object[].class); |
157 |
} |
158 |
|
159 |
/** |
160 |
* Trims the capacity of this <tt>ArrayList</tt> instance to be the |
161 |
* list's current size. An application can use this operation to minimize |
162 |
* the storage of an <tt>ArrayList</tt> instance. |
163 |
*/ |
164 |
public void trimToSize() { |
165 |
modCount++; |
166 |
int oldCapacity = elementData.length; |
167 |
if (size < oldCapacity) { |
168 |
elementData = Arrays.copyOf(elementData, size); |
169 |
} |
170 |
} |
171 |
|
172 |
/** |
173 |
* Increases the capacity of this <tt>ArrayList</tt> instance, if |
174 |
* necessary, to ensure that it can hold at least the number of elements |
175 |
* specified by the minimum capacity argument. |
176 |
* |
177 |
* @param minCapacity the desired minimum capacity |
178 |
*/ |
179 |
public void ensureCapacity(int minCapacity) { |
180 |
modCount++; |
181 |
int oldCapacity = elementData.length; |
182 |
if (minCapacity > oldCapacity) { |
183 |
Object oldData[] = elementData; |
184 |
int newCapacity = (oldCapacity * 3)/2 + 1; |
185 |
if (newCapacity < minCapacity) |
186 |
newCapacity = minCapacity; |
187 |
// minCapacity is usually close to size, so this is a win: |
188 |
elementData = Arrays.copyOf(elementData, newCapacity); |
189 |
} |
190 |
} |
191 |
|
192 |
/** |
193 |
* Returns the number of elements in this list. |
194 |
* |
195 |
* @return the number of elements in this list |
196 |
*/ |
197 |
public int size() { |
198 |
return size; |
199 |
} |
200 |
|
201 |
/** |
202 |
* Returns <tt>true</tt> if this list contains no elements. |
203 |
* |
204 |
* @return <tt>true</tt> if this list contains no elements |
205 |
*/ |
206 |
public boolean isEmpty() { |
207 |
return size == 0; |
208 |
} |
209 |
|
210 |
/** |
211 |
* Returns <tt>true</tt> if this list contains the specified element. |
212 |
* More formally, returns <tt>true</tt> if and only if this list contains |
213 |
* at least one element <tt>e</tt> such that |
214 |
* <tt>(o==null ? e==null : o.equals(e))</tt>. |
215 |
* |
216 |
* @param o element whose presence in this list is to be tested |
217 |
* @return <tt>true</tt> if this list contains the specified element |
218 |
*/ |
219 |
public boolean contains(Object o) { |
220 |
return indexOf(o) >= 0; |
221 |
} |
222 |
|
223 |
/** |
224 |
* Returns the index of the first occurrence of the specified element |
225 |
* in this list, or -1 if this list does not contain the element. |
226 |
* More formally, returns the lowest index <tt>i</tt> such that |
227 |
* <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt>, |
228 |
* or -1 if there is no such index. |
229 |
*/ |
230 |
public int indexOf(Object o) { |
231 |
if (o == null) { |
232 |
for (int i = 0; i < size; i++) |
233 |
if (elementData[i]==null) |
234 |
return i; |
235 |
} else { |
236 |
for (int i = 0; i < size; i++) |
237 |
if (o.equals(elementData[i])) |
238 |
return i; |
239 |
} |
240 |
return -1; |
241 |
} |
242 |
|
243 |
/** |
244 |
* Returns the index of the last occurrence of the specified element |
245 |
* in this list, or -1 if this list does not contain the element. |
246 |
* More formally, returns the highest index <tt>i</tt> such that |
247 |
* <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt>, |
248 |
* or -1 if there is no such index. |
249 |
*/ |
250 |
public int lastIndexOf(Object o) { |
251 |
if (o == null) { |
252 |
for (int i = size-1; i >= 0; i--) |
253 |
if (elementData[i]==null) |
254 |
return i; |
255 |
} else { |
256 |
for (int i = size-1; i >= 0; i--) |
257 |
if (o.equals(elementData[i])) |
258 |
return i; |
259 |
} |
260 |
return -1; |
261 |
} |
262 |
|
263 |
/** |
264 |
* Returns a shallow copy of this <tt>ArrayList</tt> instance. (The |
265 |
* elements themselves are not copied.) |
266 |
* |
267 |
* @return a clone of this <tt>ArrayList</tt> instance |
268 |
*/ |
269 |
public Object clone() { |
270 |
try { |
271 |
@SuppressWarnings("unchecked") |
272 |
ArrayList<E> v = (ArrayList<E>) super.clone(); |
273 |
v.elementData = Arrays.copyOf(elementData, size); |
274 |
v.modCount = 0; |
275 |
return v; |
276 |
} catch (CloneNotSupportedException e) { |
277 |
// this shouldn't happen, since we are Cloneable |
278 |
throw new InternalError(); |
279 |
} |
280 |
} |
281 |
|
282 |
/** |
283 |
* Returns an array containing all of the elements in this list |
284 |
* in proper sequence (from first to last element). |
285 |
* |
286 |
* <p>The returned array will be "safe" in that no references to it are |
287 |
* maintained by this list. (In other words, this method must allocate |
288 |
* a new array). The caller is thus free to modify the returned array. |
289 |
* |
290 |
* <p>This method acts as bridge between array-based and collection-based |
291 |
* APIs. |
292 |
* |
293 |
* @return an array containing all of the elements in this list in |
294 |
* proper sequence |
295 |
*/ |
296 |
public Object[] toArray() { |
297 |
return Arrays.copyOf(elementData, size); |
298 |
} |
299 |
|
300 |
/** |
301 |
* Returns an array containing all of the elements in this list in proper |
302 |
* sequence (from first to last element); the runtime type of the returned |
303 |
* array is that of the specified array. If the list fits in the |
304 |
* specified array, it is returned therein. Otherwise, a new array is |
305 |
* allocated with the runtime type of the specified array and the size of |
306 |
* this list. |
307 |
* |
308 |
* <p>If the list fits in the specified array with room to spare |
309 |
* (i.e., the array has more elements than the list), the element in |
310 |
* the array immediately following the end of the collection is set to |
311 |
* <tt>null</tt>. (This is useful in determining the length of the |
312 |
* list <i>only</i> if the caller knows that the list does not contain |
313 |
* any null elements.) |
314 |
* |
315 |
* @param a the array into which the elements of the list are to |
316 |
* be stored, if it is big enough; otherwise, a new array of the |
317 |
* same runtime type is allocated for this purpose. |
318 |
* @return an array containing the elements of the list |
319 |
* @throws ArrayStoreException if the runtime type of the specified array |
320 |
* is not a supertype of the runtime type of every element in |
321 |
* this list |
322 |
* @throws NullPointerException if the specified array is null |
323 |
*/ |
324 |
@SuppressWarnings("unchecked") |
325 |
public <T> T[] toArray(T[] a) { |
326 |
if (a.length < size) |
327 |
// Make a new array of a's runtime type, but my contents: |
328 |
return (T[]) Arrays.copyOf(elementData, size, a.getClass()); |
329 |
System.arraycopy(elementData, 0, a, 0, size); |
330 |
if (a.length > size) |
331 |
a[size] = null; |
332 |
return a; |
333 |
} |
334 |
|
335 |
// Positional Access Operations |
336 |
|
337 |
@SuppressWarnings("unchecked") |
338 |
E elementData(int index) { |
339 |
return (E) elementData[index]; |
340 |
} |
341 |
|
342 |
/** |
343 |
* Returns the element at the specified position in this list. |
344 |
* |
345 |
* @param index index of the element to return |
346 |
* @return the element at the specified position in this list |
347 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
348 |
*/ |
349 |
public E get(int index) { |
350 |
rangeCheck(index); |
351 |
|
352 |
return elementData(index); |
353 |
} |
354 |
|
355 |
/** |
356 |
* Replaces the element at the specified position in this list with |
357 |
* the specified element. |
358 |
* |
359 |
* @param index index of the element to replace |
360 |
* @param element element to be stored at the specified position |
361 |
* @return the element previously at the specified position |
362 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
363 |
*/ |
364 |
public E set(int index, E element) { |
365 |
rangeCheck(index); |
366 |
|
367 |
E oldValue = elementData(index); |
368 |
elementData[index] = element; |
369 |
return oldValue; |
370 |
} |
371 |
|
372 |
/** |
373 |
* Appends the specified element to the end of this list. |
374 |
* |
375 |
* @param e element to be appended to this list |
376 |
* @return <tt>true</tt> (as specified by {@link Collection#add}) |
377 |
*/ |
378 |
public boolean add(E e) { |
379 |
ensureCapacity(size + 1); // Increments modCount!! |
380 |
elementData[size++] = e; |
381 |
return true; |
382 |
} |
383 |
|
384 |
/** |
385 |
* Inserts the specified element at the specified position in this |
386 |
* list. Shifts the element currently at that position (if any) and |
387 |
* any subsequent elements to the right (adds one to their indices). |
388 |
* |
389 |
* @param index index at which the specified element is to be inserted |
390 |
* @param element element to be inserted |
391 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
392 |
*/ |
393 |
public void add(int index, E element) { |
394 |
rangeCheckForAdd(index); |
395 |
|
396 |
ensureCapacity(size+1); // Increments modCount!! |
397 |
System.arraycopy(elementData, index, elementData, index + 1, |
398 |
size - index); |
399 |
elementData[index] = element; |
400 |
size++; |
401 |
} |
402 |
|
403 |
/** |
404 |
* Removes the element at the specified position in this list. |
405 |
* Shifts any subsequent elements to the left (subtracts one from their |
406 |
* indices). |
407 |
* |
408 |
* @param index the index of the element to be removed |
409 |
* @return the element that was removed from the list |
410 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
411 |
*/ |
412 |
public E remove(int index) { |
413 |
rangeCheck(index); |
414 |
|
415 |
modCount++; |
416 |
E oldValue = elementData(index); |
417 |
|
418 |
int numMoved = size - index - 1; |
419 |
if (numMoved > 0) |
420 |
System.arraycopy(elementData, index+1, elementData, index, |
421 |
numMoved); |
422 |
elementData[--size] = null; // Let gc do its work |
423 |
|
424 |
return oldValue; |
425 |
} |
426 |
|
427 |
/** |
428 |
* Removes the first occurrence of the specified element from this list, |
429 |
* if it is present. If the list does not contain the element, it is |
430 |
* unchanged. More formally, removes the element with the lowest index |
431 |
* <tt>i</tt> such that |
432 |
* <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt> |
433 |
* (if such an element exists). Returns <tt>true</tt> if this list |
434 |
* contained the specified element (or equivalently, if this list |
435 |
* changed as a result of the call). |
436 |
* |
437 |
* @param o element to be removed from this list, if present |
438 |
* @return <tt>true</tt> if this list contained the specified element |
439 |
*/ |
440 |
public boolean remove(Object o) { |
441 |
if (o == null) { |
442 |
for (int index = 0; index < size; index++) |
443 |
if (elementData[index] == null) { |
444 |
fastRemove(index); |
445 |
return true; |
446 |
} |
447 |
} else { |
448 |
for (int index = 0; index < size; index++) |
449 |
if (o.equals(elementData[index])) { |
450 |
fastRemove(index); |
451 |
return true; |
452 |
} |
453 |
} |
454 |
return false; |
455 |
} |
456 |
|
457 |
/* |
458 |
* Private remove method that skips bounds checking and does not |
459 |
* return the value removed. |
460 |
*/ |
461 |
private void fastRemove(int index) { |
462 |
modCount++; |
463 |
int numMoved = size - index - 1; |
464 |
if (numMoved > 0) |
465 |
System.arraycopy(elementData, index+1, elementData, index, |
466 |
numMoved); |
467 |
elementData[--size] = null; // Let gc do its work |
468 |
} |
469 |
|
470 |
/** |
471 |
* Removes all of the elements from this list. The list will |
472 |
* be empty after this call returns. |
473 |
*/ |
474 |
public void clear() { |
475 |
modCount++; |
476 |
|
477 |
// Let gc do its work |
478 |
for (int i = 0; i < size; i++) |
479 |
elementData[i] = null; |
480 |
|
481 |
size = 0; |
482 |
} |
483 |
|
484 |
/** |
485 |
* Appends all of the elements in the specified collection to the end of |
486 |
* this list, in the order that they are returned by the |
487 |
* specified collection's Iterator. The behavior of this operation is |
488 |
* undefined if the specified collection is modified while the operation |
489 |
* is in progress. (This implies that the behavior of this call is |
490 |
* undefined if the specified collection is this list, and this |
491 |
* list is nonempty.) |
492 |
* |
493 |
* @param c collection containing elements to be added to this list |
494 |
* @return <tt>true</tt> if this list changed as a result of the call |
495 |
* @throws NullPointerException if the specified collection is null |
496 |
*/ |
497 |
public boolean addAll(Collection<? extends E> c) { |
498 |
Object[] a = c.toArray(); |
499 |
int numNew = a.length; |
500 |
ensureCapacity(size + numNew); // Increments modCount |
501 |
System.arraycopy(a, 0, elementData, size, numNew); |
502 |
size += numNew; |
503 |
return numNew != 0; |
504 |
} |
505 |
|
506 |
/** |
507 |
* Inserts all of the elements in the specified collection into this |
508 |
* list, starting at the specified position. Shifts the element |
509 |
* currently at that position (if any) and any subsequent elements to |
510 |
* the right (increases their indices). The new elements will appear |
511 |
* in the list in the order that they are returned by the |
512 |
* specified collection's iterator. |
513 |
* |
514 |
* @param index index at which to insert the first element from the |
515 |
* specified collection |
516 |
* @param c collection containing elements to be added to this list |
517 |
* @return <tt>true</tt> if this list changed as a result of the call |
518 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
519 |
* @throws NullPointerException if the specified collection is null |
520 |
*/ |
521 |
public boolean addAll(int index, Collection<? extends E> c) { |
522 |
rangeCheckForAdd(index); |
523 |
|
524 |
Object[] a = c.toArray(); |
525 |
int numNew = a.length; |
526 |
ensureCapacity(size + numNew); // Increments modCount |
527 |
|
528 |
int numMoved = size - index; |
529 |
if (numMoved > 0) |
530 |
System.arraycopy(elementData, index, elementData, index + numNew, |
531 |
numMoved); |
532 |
|
533 |
System.arraycopy(a, 0, elementData, index, numNew); |
534 |
size += numNew; |
535 |
return numNew != 0; |
536 |
} |
537 |
|
538 |
/** |
539 |
* Removes from this list all of the elements whose index is between |
540 |
* {@code fromIndex}, inclusive, and {@code toIndex}, exclusive. |
541 |
* Shifts any succeeding elements to the left (reduces their index). |
542 |
* This call shortens the list by {@code (toIndex - fromIndex)} elements. |
543 |
* (If {@code toIndex==fromIndex}, this operation has no effect.) |
544 |
* |
545 |
* @throws IndexOutOfBoundsException if {@code fromIndex} or |
546 |
* {@code toIndex} is out of range |
547 |
* ({@code fromIndex < 0 || |
548 |
* fromIndex >= size() || |
549 |
* toIndex > size() || |
550 |
* toIndex < fromIndex}) |
551 |
*/ |
552 |
protected void removeRange(int fromIndex, int toIndex) { |
553 |
modCount++; |
554 |
int numMoved = size - toIndex; |
555 |
System.arraycopy(elementData, toIndex, elementData, fromIndex, |
556 |
numMoved); |
557 |
|
558 |
// Let gc do its work |
559 |
int newSize = size - (toIndex-fromIndex); |
560 |
while (size != newSize) |
561 |
elementData[--size] = null; |
562 |
} |
563 |
|
564 |
/** |
565 |
* Checks if the given index is in range. If not, throws an appropriate |
566 |
* runtime exception. This method does *not* check if the index is |
567 |
* negative: It is always used immediately prior to an array access, |
568 |
* which throws an ArrayIndexOutOfBoundsException if index is negative. |
569 |
*/ |
570 |
private void rangeCheck(int index) { |
571 |
if (index >= size) |
572 |
throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); |
573 |
} |
574 |
|
575 |
/** |
576 |
* A version of rangeCheck used by add and addAll. |
577 |
*/ |
578 |
private void rangeCheckForAdd(int index) { |
579 |
if (index > size || index < 0) |
580 |
throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); |
581 |
} |
582 |
|
583 |
/** |
584 |
* Constructs an IndexOutOfBoundsException detail message. |
585 |
* Of the many possible refactorings of the error handling code, |
586 |
* this "outlining" performs best with both server and client VMs. |
587 |
*/ |
588 |
private String outOfBoundsMsg(int index) { |
589 |
return "Index: "+index+", Size: "+size; |
590 |
} |
591 |
|
592 |
/** |
593 |
* Removes from this list all of its elements that are contained in the |
594 |
* specified collection. |
595 |
* |
596 |
* @param c collection containing elements to be removed from this list |
597 |
* @return {@code true} if this list changed as a result of the call |
598 |
* @throws ClassCastException if the class of an element of this list |
599 |
* is incompatible with the specified collection (optional) |
600 |
* @throws NullPointerException if this list contains a null element and the |
601 |
* specified collection does not permit null elements (optional), |
602 |
* or if the specified collection is null |
603 |
* @see Collection#contains(Object) |
604 |
*/ |
605 |
public boolean removeAll(Collection<?> c) { |
606 |
return batchRemove(c, false); |
607 |
} |
608 |
|
609 |
/** |
610 |
* Retains only the elements in this list that are contained in the |
611 |
* specified collection. In other words, removes from this list all |
612 |
* of its elements that are not contained in the specified collection. |
613 |
* |
614 |
* @param c collection containing elements to be retained in this list |
615 |
* @return {@code true} if this list changed as a result of the call |
616 |
* @throws ClassCastException if the class of an element of this list |
617 |
* is incompatible with the specified collection (optional) |
618 |
* @throws NullPointerException if this list contains a null element and the |
619 |
* specified collection does not permit null elements (optional), |
620 |
* or if the specified collection is null |
621 |
* @see Collection#contains(Object) |
622 |
*/ |
623 |
public boolean retainAll(Collection<?> c) { |
624 |
return batchRemove(c, true); |
625 |
} |
626 |
|
627 |
private boolean batchRemove(Collection<?> c, boolean complement) { |
628 |
final Object[] elementData = this.elementData; |
629 |
int r = 0, w = 0; |
630 |
boolean modified = false; |
631 |
try { |
632 |
for (; r < size; r++) |
633 |
if (c.contains(elementData[r]) == complement) |
634 |
elementData[w++] = elementData[r]; |
635 |
} finally { |
636 |
// Preserve behavioral compatibility with AbstractCollection, |
637 |
// even if c.contains() throws. |
638 |
if (r != size) { |
639 |
System.arraycopy(elementData, r, |
640 |
elementData, w, |
641 |
size - r); |
642 |
w += size - r; |
643 |
} |
644 |
if (w != size) { |
645 |
for (int i = w; i < size; i++) |
646 |
elementData[i] = null; |
647 |
modCount += size - w; |
648 |
size = w; |
649 |
modified = true; |
650 |
} |
651 |
} |
652 |
return modified; |
653 |
} |
654 |
|
655 |
/** |
656 |
* Save the state of the <tt>ArrayList</tt> instance to a stream (that |
657 |
* is, serialize it). |
658 |
* |
659 |
* @serialData The length of the array backing the <tt>ArrayList</tt> |
660 |
* instance is emitted (int), followed by all of its elements |
661 |
* (each an <tt>Object</tt>) in the proper order. |
662 |
*/ |
663 |
private void writeObject(java.io.ObjectOutputStream s) |
664 |
throws java.io.IOException{ |
665 |
// Write out element count, and any hidden stuff |
666 |
int expectedModCount = modCount; |
667 |
s.defaultWriteObject(); |
668 |
|
669 |
// Write out array length |
670 |
s.writeInt(elementData.length); |
671 |
|
672 |
// Write out all elements in the proper order. |
673 |
for (int i=0; i<size; i++) |
674 |
s.writeObject(elementData[i]); |
675 |
|
676 |
if (modCount != expectedModCount) { |
677 |
throw new ConcurrentModificationException(); |
678 |
} |
679 |
|
680 |
} |
681 |
|
682 |
/** |
683 |
* Reconstitute the <tt>ArrayList</tt> instance from a stream (that is, |
684 |
* deserialize it). |
685 |
*/ |
686 |
private void readObject(java.io.ObjectInputStream s) |
687 |
throws java.io.IOException, ClassNotFoundException { |
688 |
// Read in size, and any hidden stuff |
689 |
s.defaultReadObject(); |
690 |
|
691 |
// Read in array length and allocate array |
692 |
int arrayLength = s.readInt(); |
693 |
Object[] a = elementData = new Object[arrayLength]; |
694 |
|
695 |
// Read in all elements in the proper order. |
696 |
for (int i=0; i<size; i++) |
697 |
a[i] = s.readObject(); |
698 |
} |
699 |
|
700 |
/** |
701 |
* Returns a list iterator over the elements in this list (in proper |
702 |
* sequence), starting at the specified position in the list. |
703 |
* The specified index indicates the first element that would be |
704 |
* returned by an initial call to {@link ListIterator#next next}. |
705 |
* An initial call to {@link ListIterator#previous previous} would |
706 |
* return the element with the specified index minus one. |
707 |
* |
708 |
* <p>The returned list iterator is <a href="#fail-fast"><i>fail-fast</i></a>. |
709 |
* |
710 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
711 |
*/ |
712 |
public ListIterator<E> listIterator(int index) { |
713 |
if (index < 0 || index > size) |
714 |
throw new IndexOutOfBoundsException("Index: "+index); |
715 |
return new ListItr(index); |
716 |
} |
717 |
|
718 |
/** |
719 |
* Returns a list iterator over the elements in this list (in proper |
720 |
* sequence). |
721 |
* |
722 |
* <p>The returned list iterator is <a href="#fail-fast"><i>fail-fast</i></a>. |
723 |
* |
724 |
* @see #listIterator(int) |
725 |
*/ |
726 |
public ListIterator<E> listIterator() { |
727 |
return new ListItr(0); |
728 |
} |
729 |
|
730 |
/** |
731 |
* Returns an iterator over the elements in this list in proper sequence. |
732 |
* |
733 |
* <p>The returned iterator is <a href="#fail-fast"><i>fail-fast</i></a>. |
734 |
* |
735 |
* @return an iterator over the elements in this list in proper sequence |
736 |
*/ |
737 |
public Iterator<E> iterator() { |
738 |
return new Itr(); |
739 |
} |
740 |
|
741 |
/** |
742 |
* An optimized version of AbstractList.Itr |
743 |
*/ |
744 |
private class Itr implements Iterator<E> { |
745 |
int cursor; // index of next element to return |
746 |
int lastRet = -1; // index of last element returned; -1 if no such |
747 |
int expectedModCount = modCount; |
748 |
|
749 |
public boolean hasNext() { |
750 |
return cursor != size; |
751 |
} |
752 |
|
753 |
@SuppressWarnings("unchecked") |
754 |
public E next() { |
755 |
checkForComodification(); |
756 |
int i = cursor; |
757 |
if (i >= size) |
758 |
throw new NoSuchElementException(); |
759 |
Object[] elementData = ArrayList.this.elementData; |
760 |
if (i >= elementData.length) |
761 |
throw new ConcurrentModificationException(); |
762 |
cursor = i + 1; |
763 |
return (E) elementData[lastRet = i]; |
764 |
} |
765 |
|
766 |
public void remove() { |
767 |
if (lastRet < 0) |
768 |
throw new IllegalStateException(); |
769 |
checkForComodification(); |
770 |
|
771 |
try { |
772 |
ArrayList.this.remove(lastRet); |
773 |
cursor = lastRet; |
774 |
lastRet = -1; |
775 |
expectedModCount = modCount; |
776 |
} catch (IndexOutOfBoundsException ex) { |
777 |
throw new ConcurrentModificationException(); |
778 |
} |
779 |
} |
780 |
|
781 |
final void checkForComodification() { |
782 |
if (modCount != expectedModCount) |
783 |
throw new ConcurrentModificationException(); |
784 |
} |
785 |
} |
786 |
|
787 |
/** |
788 |
* An optimized version of AbstractList.ListItr |
789 |
*/ |
790 |
private class ListItr extends Itr implements ListIterator<E> { |
791 |
ListItr(int index) { |
792 |
super(); |
793 |
cursor = index; |
794 |
} |
795 |
|
796 |
public boolean hasPrevious() { |
797 |
return cursor != 0; |
798 |
} |
799 |
|
800 |
public int nextIndex() { |
801 |
return cursor; |
802 |
} |
803 |
|
804 |
public int previousIndex() { |
805 |
return cursor - 1; |
806 |
} |
807 |
|
808 |
@SuppressWarnings("unchecked") |
809 |
public E previous() { |
810 |
checkForComodification(); |
811 |
int i = cursor - 1; |
812 |
if (i < 0) |
813 |
throw new NoSuchElementException(); |
814 |
Object[] elementData = ArrayList.this.elementData; |
815 |
if (i >= elementData.length) |
816 |
throw new ConcurrentModificationException(); |
817 |
cursor = i; |
818 |
return (E) elementData[lastRet = i]; |
819 |
} |
820 |
|
821 |
public void set(E e) { |
822 |
if (lastRet < 0) |
823 |
throw new IllegalStateException(); |
824 |
checkForComodification(); |
825 |
|
826 |
try { |
827 |
ArrayList.this.set(lastRet, e); |
828 |
} catch (IndexOutOfBoundsException ex) { |
829 |
throw new ConcurrentModificationException(); |
830 |
} |
831 |
} |
832 |
|
833 |
public void add(E e) { |
834 |
checkForComodification(); |
835 |
|
836 |
try { |
837 |
int i = cursor; |
838 |
ArrayList.this.add(i, e); |
839 |
cursor = i + 1; |
840 |
lastRet = -1; |
841 |
expectedModCount = modCount; |
842 |
} catch (IndexOutOfBoundsException ex) { |
843 |
throw new ConcurrentModificationException(); |
844 |
} |
845 |
} |
846 |
} |
847 |
|
848 |
/** |
849 |
* Returns a view of the portion of this list between the specified |
850 |
* {@code fromIndex}, inclusive, and {@code toIndex}, exclusive. (If |
851 |
* {@code fromIndex} and {@code toIndex} are equal, the returned list is |
852 |
* empty.) The returned list is backed by this list, so non-structural |
853 |
* changes in the returned list are reflected in this list, and vice-versa. |
854 |
* The returned list supports all of the optional list operations. |
855 |
* |
856 |
* <p>This method eliminates the need for explicit range operations (of |
857 |
* the sort that commonly exist for arrays). Any operation that expects |
858 |
* a list can be used as a range operation by passing a subList view |
859 |
* instead of a whole list. For example, the following idiom |
860 |
* removes a range of elements from a list: |
861 |
* <pre> |
862 |
* list.subList(from, to).clear(); |
863 |
* </pre> |
864 |
* Similar idioms may be constructed for {@link #indexOf(Object)} and |
865 |
* {@link #lastIndexOf(Object)}, and all of the algorithms in the |
866 |
* {@link Collections} class can be applied to a subList. |
867 |
* |
868 |
* <p>The semantics of the list returned by this method become undefined if |
869 |
* the backing list (i.e., this list) is <i>structurally modified</i> in |
870 |
* any way other than via the returned list. (Structural modifications are |
871 |
* those that change the size of this list, or otherwise perturb it in such |
872 |
* a fashion that iterations in progress may yield incorrect results.) |
873 |
* |
874 |
* @throws IndexOutOfBoundsException {@inheritDoc} |
875 |
* @throws IllegalArgumentException {@inheritDoc} |
876 |
*/ |
877 |
public List<E> subList(int fromIndex, int toIndex) { |
878 |
subListRangeCheck(fromIndex, toIndex, size); |
879 |
return new SubList(this, 0, fromIndex, toIndex); |
880 |
} |
881 |
|
882 |
static void subListRangeCheck(int fromIndex, int toIndex, int size) { |
883 |
if (fromIndex < 0) |
884 |
throw new IndexOutOfBoundsException("fromIndex = " + fromIndex); |
885 |
if (toIndex > size) |
886 |
throw new IndexOutOfBoundsException("toIndex = " + toIndex); |
887 |
if (fromIndex > toIndex) |
888 |
throw new IllegalArgumentException("fromIndex(" + fromIndex + |
889 |
") > toIndex(" + toIndex + ")"); |
890 |
} |
891 |
|
892 |
private class SubList extends AbstractList<E> implements RandomAccess { |
893 |
private final AbstractList<E> parent; |
894 |
private final int parentOffset; |
895 |
private final int offset; |
896 |
private int size; |
897 |
|
898 |
SubList(AbstractList<E> parent, |
899 |
int offset, int fromIndex, int toIndex) { |
900 |
this.parent = parent; |
901 |
this.parentOffset = fromIndex; |
902 |
this.offset = offset + fromIndex; |
903 |
this.size = toIndex - fromIndex; |
904 |
this.modCount = ArrayList.this.modCount; |
905 |
} |
906 |
|
907 |
public E set(int index, E e) { |
908 |
rangeCheck(index); |
909 |
checkForComodification(); |
910 |
E oldValue = ArrayList.this.elementData(offset + index); |
911 |
ArrayList.this.elementData[offset + index] = e; |
912 |
return oldValue; |
913 |
} |
914 |
|
915 |
public E get(int index) { |
916 |
rangeCheck(index); |
917 |
checkForComodification(); |
918 |
return ArrayList.this.elementData(offset + index); |
919 |
} |
920 |
|
921 |
public int size() { |
922 |
checkForComodification(); |
923 |
return this.size; |
924 |
} |
925 |
|
926 |
public void add(int index, E e) { |
927 |
rangeCheckForAdd(index); |
928 |
checkForComodification(); |
929 |
parent.add(parentOffset + index, e); |
930 |
this.modCount = parent.modCount; |
931 |
this.size++; |
932 |
} |
933 |
|
934 |
public E remove(int index) { |
935 |
rangeCheck(index); |
936 |
checkForComodification(); |
937 |
E result = parent.remove(parentOffset + index); |
938 |
this.modCount = parent.modCount; |
939 |
this.size--; |
940 |
return result; |
941 |
} |
942 |
|
943 |
protected void removeRange(int fromIndex, int toIndex) { |
944 |
checkForComodification(); |
945 |
parent.removeRange(parentOffset + fromIndex, |
946 |
parentOffset + toIndex); |
947 |
this.modCount = parent.modCount; |
948 |
this.size -= toIndex - fromIndex; |
949 |
} |
950 |
|
951 |
public boolean addAll(Collection<? extends E> c) { |
952 |
return addAll(this.size, c); |
953 |
} |
954 |
|
955 |
public boolean addAll(int index, Collection<? extends E> c) { |
956 |
rangeCheckForAdd(index); |
957 |
int cSize = c.size(); |
958 |
if (cSize==0) |
959 |
return false; |
960 |
|
961 |
checkForComodification(); |
962 |
parent.addAll(parentOffset + index, c); |
963 |
this.modCount = parent.modCount; |
964 |
this.size += cSize; |
965 |
return true; |
966 |
} |
967 |
|
968 |
public Iterator<E> iterator() { |
969 |
return listIterator(); |
970 |
} |
971 |
|
972 |
public ListIterator<E> listIterator(final int index) { |
973 |
checkForComodification(); |
974 |
rangeCheckForAdd(index); |
975 |
|
976 |
return new ListIterator<E>() { |
977 |
int cursor = index; |
978 |
int lastRet = -1; |
979 |
int expectedModCount = ArrayList.this.modCount; |
980 |
|
981 |
public boolean hasNext() { |
982 |
return cursor != SubList.this.size; |
983 |
} |
984 |
|
985 |
@SuppressWarnings("unchecked") |
986 |
public E next() { |
987 |
checkForComodification(); |
988 |
int i = cursor; |
989 |
if (i >= SubList.this.size) |
990 |
throw new NoSuchElementException(); |
991 |
Object[] elementData = ArrayList.this.elementData; |
992 |
if (offset + i >= elementData.length) |
993 |
throw new ConcurrentModificationException(); |
994 |
cursor = i + 1; |
995 |
return (E) elementData[offset + (lastRet = i)]; |
996 |
} |
997 |
|
998 |
public boolean hasPrevious() { |
999 |
return cursor != 0; |
1000 |
} |
1001 |
|
1002 |
@SuppressWarnings("unchecked") |
1003 |
public E previous() { |
1004 |
checkForComodification(); |
1005 |
int i = cursor - 1; |
1006 |
if (i < 0) |
1007 |
throw new NoSuchElementException(); |
1008 |
Object[] elementData = ArrayList.this.elementData; |
1009 |
if (offset + i >= elementData.length) |
1010 |
throw new ConcurrentModificationException(); |
1011 |
cursor = i; |
1012 |
return (E) elementData[offset + (lastRet = i)]; |
1013 |
} |
1014 |
|
1015 |
public int nextIndex() { |
1016 |
return cursor; |
1017 |
} |
1018 |
|
1019 |
public int previousIndex() { |
1020 |
return cursor - 1; |
1021 |
} |
1022 |
|
1023 |
public void remove() { |
1024 |
if (lastRet < 0) |
1025 |
throw new IllegalStateException(); |
1026 |
checkForComodification(); |
1027 |
|
1028 |
try { |
1029 |
SubList.this.remove(lastRet); |
1030 |
cursor = lastRet; |
1031 |
lastRet = -1; |
1032 |
expectedModCount = ArrayList.this.modCount; |
1033 |
} catch (IndexOutOfBoundsException ex) { |
1034 |
throw new ConcurrentModificationException(); |
1035 |
} |
1036 |
} |
1037 |
|
1038 |
public void set(E e) { |
1039 |
if (lastRet < 0) |
1040 |
throw new IllegalStateException(); |
1041 |
checkForComodification(); |
1042 |
|
1043 |
try { |
1044 |
ArrayList.this.set(offset + lastRet, e); |
1045 |
} catch (IndexOutOfBoundsException ex) { |
1046 |
throw new ConcurrentModificationException(); |
1047 |
} |
1048 |
} |
1049 |
|
1050 |
public void add(E e) { |
1051 |
checkForComodification(); |
1052 |
|
1053 |
try { |
1054 |
int i = cursor; |
1055 |
SubList.this.add(i, e); |
1056 |
cursor = i + 1; |
1057 |
lastRet = -1; |
1058 |
expectedModCount = ArrayList.this.modCount; |
1059 |
} catch (IndexOutOfBoundsException ex) { |
1060 |
throw new ConcurrentModificationException(); |
1061 |
} |
1062 |
} |
1063 |
|
1064 |
final void checkForComodification() { |
1065 |
if (expectedModCount != ArrayList.this.modCount) |
1066 |
throw new ConcurrentModificationException(); |
1067 |
} |
1068 |
}; |
1069 |
} |
1070 |
|
1071 |
public List<E> subList(int fromIndex, int toIndex) { |
1072 |
subListRangeCheck(fromIndex, toIndex, size); |
1073 |
return new SubList(this, offset, fromIndex, toIndex); |
1074 |
} |
1075 |
|
1076 |
private void rangeCheck(int index) { |
1077 |
if (index < 0 || index >= this.size) |
1078 |
throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); |
1079 |
} |
1080 |
|
1081 |
private void rangeCheckForAdd(int index) { |
1082 |
if (index < 0 || index > this.size) |
1083 |
throw new IndexOutOfBoundsException(outOfBoundsMsg(index)); |
1084 |
} |
1085 |
|
1086 |
private String outOfBoundsMsg(int index) { |
1087 |
return "Index: "+index+", Size: "+this.size; |
1088 |
} |
1089 |
|
1090 |
private void checkForComodification() { |
1091 |
if (ArrayList.this.modCount != this.modCount) |
1092 |
throw new ConcurrentModificationException(); |
1093 |
} |
1094 |
} |
1095 |
} |