-
Notifications
You must be signed in to change notification settings - Fork 668
/
CopyOnWriteArrayList.java
1803 lines (1574 loc) · 65.9 KB
/
CopyOnWriteArrayList.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* Written by Doug Lea with assistance from members of JCP JSR-166
* Expert Group. Adapted and released, under explicit permission,
* from JDK ArrayList.java which carries the following copyright:
*
* Copyright 1997 by Sun Microsystems, Inc.,
* 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
* All rights reserved.
*/
package java.util.concurrent;
import java.io.Serializable;
import java.lang.invoke.VarHandle;
import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.ConcurrentModificationException;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.RandomAccess;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.UnaryOperator;
import jdk.internal.misc.SharedSecrets;
/**
* A thread-safe variant of {@link java.util.ArrayList} in which all mutative
* operations ({@code add}, {@code set}, and so on) are implemented by
* making a fresh copy of the underlying array.
*
* <p>This is ordinarily too costly, but may be <em>more</em> efficient
* than alternatives when traversal operations vastly outnumber
* mutations, and is useful when you cannot or don't want to
* synchronize traversals, yet need to preclude interference among
* concurrent threads. The "snapshot" style iterator method uses a
* reference to the state of the array at the point that the iterator
* was created. This array never changes during the lifetime of the
* iterator, so interference is impossible and the iterator is
* guaranteed not to throw {@code ConcurrentModificationException}.
* The iterator will not reflect additions, removals, or changes to
* the list since the iterator was created. Element-changing
* operations on iterators themselves ({@code remove}, {@code set}, and
* {@code add}) are not supported. These methods throw
* {@code UnsupportedOperationException}.
*
* <p>All elements are permitted, including {@code null}.
*
* <p>Memory consistency effects: As with other concurrent
* collections, actions in a thread prior to placing an object into a
* {@code CopyOnWriteArrayList}
* <a href="package-summary.html#MemoryVisibility"><i>happen-before</i></a>
* actions subsequent to the access or removal of that element from
* the {@code CopyOnWriteArrayList} in another thread.
*
* <p>This class is a member of the
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework">
* Java Collections Framework</a>.
*
* @param <E> the type of elements held in this list
*
* @author Doug Lea
* @since 1.5
*/
// 需要写时复制的List:线性表的顺序存储结构,内部使用数组实现,线程安全。其特殊之处在于进行写入操作时,会在原线性表的副本上操作,再更新线性表
public class CopyOnWriteArrayList<E> implements List<E>, RandomAccess, Cloneable, Serializable {
/**
* The lock protecting all mutators. (We have a mild preference
* for builtin monitors over ReentrantLock when either will do.)
*/
final transient Object lock = new Object();
/** The array, accessed only via getArray/setArray. */
private transient volatile Object[] array; // 存储当前顺序表的元素
/*▼ 构造器 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Creates an empty list.
*/
public CopyOnWriteArrayList() {
setArray(new Object[0]);
}
/**
* Creates a list holding a copy of the given array.
*
* @param toCopyIn the array (a copy of this array is used as the
* internal array)
*
* @throws NullPointerException if the specified array is null
*/
public CopyOnWriteArrayList(E[] toCopyIn) {
setArray(Arrays.copyOf(toCopyIn, toCopyIn.length, Object[].class));
}
/**
* Creates a list containing the elements of the specified
* collection, in the order they are returned by the collection's
* iterator.
*
* @param c the collection of initially held elements
*
* @throws NullPointerException if the specified collection is null
*/
public CopyOnWriteArrayList(Collection<? extends E> c) {
Object[] es;
if(c.getClass() == CopyOnWriteArrayList.class) {
es = ((CopyOnWriteArrayList<?>) c).getArray();
} else {
es = c.toArray();
// defend against c.toArray (incorrectly) not returning Object[]
// (see e.g. https://bugs.openjdk.java.net/browse/JDK-6260652)
if(es.getClass() != Object[].class) {
es = Arrays.copyOf(es, es.length, Object[].class);
}
}
setArray(es);
}
/*▲ 构造器 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 存值 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Appends the specified element to the end of this list.
*
* @param e element to be appended to this list
*
* @return {@code true} (as specified by {@link Collection#add})
*/
// 将元素e追加到当前顺序表中(写入时先复制)
public boolean add(E e) {
synchronized(lock) {
Object[] es = getArray();
int len = es.length;
es = Arrays.copyOf(es, len + 1);
es[len] = e;
setArray(es);
return true;
}
}
/**
* Inserts the specified element at the specified position in this
* list. Shifts the element currently at that position (if any) and
* any subsequent elements to the right (adds one to their indices).
*
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
// 将元素element添加到顺序表index处(写入时先复制)
public void add(int index, E element) {
synchronized(lock) {
Object[] es = getArray();
int len = es.length;
if(index>len || index<0) {
throw new IndexOutOfBoundsException(outOfBounds(index, len));
}
Object[] newElements;
int numMoved = len - index;
if(numMoved == 0) {
newElements = Arrays.copyOf(es, len + 1);
} else {
newElements = new Object[len + 1];
System.arraycopy(es, 0, newElements, 0, index);
System.arraycopy(es, index, newElements, index + 1, numMoved);
}
newElements[index] = element;
setArray(newElements);
}
}
/**
* Appends all of the elements in the specified collection to the end
* of this list, in the order that they are returned by the specified
* collection's iterator.
*
* @param c collection containing elements to be added to this list
*
* @return {@code true} if this list changed as a result of the call
*
* @throws NullPointerException if the specified collection is null
* @see #add(Object)
*/
// 将指定容器中的元素追加到当前顺序表中(写入时先复制)
public boolean addAll(Collection<? extends E> c) {
Object[] cs = (c.getClass() == CopyOnWriteArrayList.class)
? ((CopyOnWriteArrayList<?>) c).getArray()
: c.toArray();
if(cs.length == 0) {
return false;
}
synchronized(lock) {
Object[] es = getArray();
int len = es.length;
Object[] newElements;
if(len == 0 && cs.getClass() == Object[].class) {
newElements = cs;
} else {
newElements = Arrays.copyOf(es, len + cs.length);
System.arraycopy(cs, 0, newElements, len, cs.length);
}
setArray(newElements);
return true;
}
}
/**
* Inserts all of the elements in the specified collection into this
* list, starting at the specified position. Shifts the element
* currently at that position (if any) and any subsequent elements to
* the right (increases their indices). The new elements will appear
* in this list in the order that they are returned by the
* specified collection's iterator.
*
* @param index index at which to insert the first element
* from the specified collection
* @param c collection containing elements to be added to this list
*
* @return {@code true} if this list changed as a result of the call
*
* @throws IndexOutOfBoundsException {@inheritDoc}
* @throws NullPointerException if the specified collection is null
* @see #add(int, Object)
*/
// 将指定容器中的元素添加到当前顺序表的index处(写入时先复制)
public boolean addAll(int index, Collection<? extends E> c) {
Object[] cs = c.toArray();
synchronized(lock) {
Object[] es = getArray();
int len = es.length;
if(index>len || index<0) {
throw new IndexOutOfBoundsException(outOfBounds(index, len));
}
if(cs.length == 0) {
return false;
}
int numMoved = len - index;
Object[] newElements;
if(numMoved == 0) {
newElements = Arrays.copyOf(es, len + cs.length);
} else {
newElements = new Object[len + cs.length];
System.arraycopy(es, 0, newElements, 0, index);
System.arraycopy(es, index, newElements, index + cs.length, numMoved);
}
System.arraycopy(cs, 0, newElements, index, cs.length);
setArray(newElements);
return true;
}
}
/**
* Appends the element, if not present.
*
* @param e element to be added to this list, if absent
*
* @return {@code true} if the element was added
*/
// 如果元素e不在当前顺序表中,则将元素e追加到当前顺序表中(写入时先复制)
public boolean addIfAbsent(E e) {
Object[] snapshot = getArray();
// 在snapshot中查找o,如果找到,返回其索引,否则返回-1
int index = indexOfRange(e, snapshot, 0, snapshot.length);
return index<0 && addIfAbsent(e, snapshot);
}
/**
* Appends all of the elements in the specified collection that
* are not already contained in this list, to the end of
* this list, in the order that they are returned by the
* specified collection's iterator.
*
* @param c collection containing elements to be added to this list
*
* @return the number of elements added
*
* @throws NullPointerException if the specified collection is null
* @see #addIfAbsent(Object)
*/
// 从指定的容器中选出不在当前顺序表中的元素,然后将它们追加到当前顺序表中(写入时先复制)
public int addAllAbsent(Collection<? extends E> c) {
Object[] cs = c.toArray();
if(cs.length == 0) {
return 0;
}
synchronized(lock) {
Object[] es = getArray();
int len = es.length;
int added = 0;
// uniquify and compact elements in cs
for(int i = 0; i<cs.length; ++i) {
// 获取容器中的元素
Object e = cs[i];
// 确保容器中取出的元素既不在当前顺序表中,也不在已经遍历过的容器元素中
if(indexOfRange(e, es, 0, len)<0 && indexOfRange(e, cs, 0, added)<0) {
cs[added++] = e;
}
}
if(added>0) {
Object[] newElements = Arrays.copyOf(es, len + added);
System.arraycopy(cs, 0, newElements, len, added);
setArray(newElements);
}
return added;
}
}
/*▲ 存值 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 取值 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* {@inheritDoc}
*
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
// 获取指定索引处的元素
public E get(int index) {
return elementAt(getArray(), index);
}
/*▲ 取值 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 移除 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Removes the element at the specified position in this list.
* Shifts any subsequent elements to the left (subtracts one from their
* indices). Returns the element that was removed from the list.
*
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
// 移除索引index处的元素,返回被移除的元素
public E remove(int index) {
synchronized(lock) {
Object[] es = getArray();
int len = es.length;
E oldValue = elementAt(es, index);
int numMoved = len - index - 1;
Object[] newElements;
if(numMoved == 0) {
newElements = Arrays.copyOf(es, len - 1);
} else {
newElements = new Object[len - 1];
System.arraycopy(es, 0, newElements, 0, index);
System.arraycopy(es, index + 1, newElements, index, numMoved);
}
setArray(newElements);
return oldValue;
}
}
/**
* Removes the first occurrence of the specified element from this list,
* if it is present. If this list does not contain the element, it is
* unchanged. More formally, removes the element with the lowest index
* {@code i} such that {@code Objects.equals(o, get(i))}
* (if such an element exists). Returns {@code true} if this list
* contained the specified element (or equivalently, if this list
* changed as a result of the call).
*
* @param o element to be removed from this list, if present
*
* @return {@code true} if this list contained the specified element
*/
// 移除指定的元素,返回值指示是否移除成功
public boolean remove(Object o) {
Object[] snapshot = getArray();
// 在snapshot中查找o,如果找到,返回其索引,否则返回-1
int index = indexOfRange(o, snapshot, 0, snapshot.length);
return index >= 0 && remove(o, snapshot, index);
}
/**
* @throws NullPointerException {@inheritDoc}
*/
// 移除满足条件的元素,移除条件由filter决定,返回值指示是否移除成功
public boolean removeIf(Predicate<? super E> filter) {
Objects.requireNonNull(filter);
return bulkRemove(filter);
}
/**
* Removes from this list all of its elements that are contained in
* the specified collection. This is a particularly expensive operation
* in this class because of the need for an internal temporary array.
*
* @param c collection containing elements to be removed from this list
*
* @return {@code true} if this list changed as a result of the call
*
* @throws ClassCastException if the class of an element of this list
* is incompatible with the specified collection
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
* @throws NullPointerException if this list contains a null element and the
* specified collection does not permit null elements
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>),
* or if the specified collection is null
* @see #remove(Object)
*/
// (匹配则移除)移除当前顺序表中所有与给定容器中的元素匹配的元素
public boolean removeAll(Collection<?> c) {
Objects.requireNonNull(c);
return bulkRemove(e -> c.contains(e));
}
/**
* Retains only the elements in this list that are contained in the
* specified collection. In other words, removes from this list all of
* its elements that are not contained in the specified collection.
*
* @param c collection containing elements to be retained in this list
*
* @return {@code true} if this list changed as a result of the call
*
* @throws ClassCastException if the class of an element of this list
* is incompatible with the specified collection
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
* @throws NullPointerException if this list contains a null element and the
* specified collection does not permit null elements
* (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>),
* or if the specified collection is null
* @see #remove(Object)
*/
// (不匹配则移除)移除当前顺序表中所有与给定容器中的元素不匹配的元素
public boolean retainAll(Collection<?> c) {
Objects.requireNonNull(c);
return bulkRemove(e -> !c.contains(e));
}
/**
* Removes all of the elements from this list.
* The list will be empty after this call returns.
*/
// 清空当前顺序表中的元素
public void clear() {
synchronized(lock) {
setArray(new Object[0]);
}
}
/*▲ 移除 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 替换 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Replaces the element at the specified position in this list with the
* specified element.
*
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
// 将index处的元素更新为element,并返回旧元素
public E set(int index, E element) {
synchronized(lock) {
Object[] es = getArray();
E oldValue = elementAt(es, index);
if(oldValue != element) {
// 对现有结构进行克隆
es = es.clone();
// 向
es[index] = element;
setArray(es);
}
return oldValue;
}
}
// 更新当前顺序表中所有元素,更新策略由operator决定
public void replaceAll(UnaryOperator<E> operator) {
synchronized(lock) {
replaceAllRange(operator, 0, getArray().length);
}
}
/*▲ 替换 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 包含查询 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns {@code true} if this list contains the specified element.
* More formally, returns {@code true} if and only if this list contains
* at least one element {@code e} such that {@code Objects.equals(o, e)}.
*
* @param o element whose presence in this list is to be tested
*
* @return {@code true} if this list contains the specified element
*/
// 判断当前顺序表中是否包含指定的元素
public boolean contains(Object o) {
return indexOf(o) >= 0;
}
/**
* Returns {@code true} if this list contains all of the elements of the
* specified collection.
*
* @param c collection to be checked for containment in this list
*
* @return {@code true} if this list contains all of the elements of the
* specified collection
*
* @throws NullPointerException if the specified collection is null
* @see #contains(Object)
*/
// 判读指定容器中的元素是否都包含在当前顺序表中
public boolean containsAll(Collection<?> c) {
Object[] es = getArray();
int len = es.length;
for(Object e : c) {
if(indexOfRange(e, es, 0, len)<0) {
return false;
}
}
return true;
}
/*▲ 包含查询 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 定位 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* {@inheritDoc}
*/
// 返回指定元素的正序索引(正序查找首个匹配的元素)
public int indexOf(Object o) {
Object[] es = getArray();
return indexOfRange(o, es, 0, es.length);
}
/**
* Returns the index of the first occurrence of the specified element in
* this list, searching forwards from {@code index}, or returns -1 if
* the element is not found.
* More formally, returns the lowest index {@code i} such that
* {@code i >= index && Objects.equals(get(i), e)},
* or -1 if there is no such index.
*
* @param e element to search for
* @param index index to start searching from
*
* @return the index of the first occurrence of the element in
* this list at position {@code index} or later in the list;
* {@code -1} if the element is not found.
*
* @throws IndexOutOfBoundsException if the specified index is negative
*/
// 从顺序表index索引处开始搜索,返回指定元素的正序索引(正序查找首个匹配的元素)
public int indexOf(E e, int index) {
Object[] es = getArray();
return indexOfRange(e, es, index, es.length);
}
/**
* {@inheritDoc}
*/
// 返回指定元素的逆序索引(逆序查找首个匹配的元素)
public int lastIndexOf(Object o) {
Object[] es = getArray();
return lastIndexOfRange(o, es, 0, es.length);
}
/**
* Returns the index of the last occurrence of the specified element in
* this list, searching backwards from {@code index}, or returns -1 if
* the element is not found.
* More formally, returns the highest index {@code i} such that
* {@code i <= index && Objects.equals(get(i), e)},
* or -1 if there is no such index.
*
* @param e element to search for
* @param index index to start searching backwards from
*
* @return the index of the last occurrence of the element at position
* less than or equal to {@code index} in this list;
* -1 if the element is not found.
*
* @throws IndexOutOfBoundsException if the specified index is greater
* than or equal to the current size of this list
*/
// 从顺序表index索引处开始搜索,返回指定元素的逆序索引(逆序查找首个匹配的元素)
public int lastIndexOf(E e, int index) {
Object[] es = getArray();
return lastIndexOfRange(e, es, 0, index + 1);
}
/*▲ 定位 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 视图 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns a view of the portion of this list between
* {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
* The returned list is backed by this list, so changes in the
* returned list are reflected in this list.
*
* <p>The semantics of the list returned by this method become
* undefined if the backing list (i.e., this list) is modified in
* any way other than via the returned list.
*
* @param fromIndex low endpoint (inclusive) of the subList
* @param toIndex high endpoint (exclusive) of the subList
*
* @return a view of the specified range within this list
*
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
// 返回[fromIndex, toIndex)之间的元素的视图
public List<E> subList(int fromIndex, int toIndex) {
synchronized(lock) {
Object[] es = getArray();
int len = es.length;
int size = toIndex - fromIndex;
if(fromIndex<0 || toIndex>len || size<0) {
throw new IndexOutOfBoundsException();
}
return new COWSubList(es, fromIndex, size);
}
}
/**
* Returns an array containing all of the elements in this list
* in proper sequence (from first to last element).
*
* <p>The returned array will be "safe" in that no references to it are
* maintained by this list. (In other words, this method must allocate
* a new array). The caller is thus free to modify the returned array.
*
* <p>This method acts as bridge between array-based and collection-based
* APIs.
*
* @return an array containing all the elements in this list
*/
public Object[] toArray() {
return getArray().clone();
}
/**
* Returns an array containing all of the elements in this list in
* proper sequence (from first to last element); the runtime type of
* the returned array is that of the specified array. If the list fits
* in the specified array, it is returned therein. Otherwise, a new
* array is allocated with the runtime type of the specified array and
* the size of this list.
*
* <p>If this list fits in the specified array with room to spare
* (i.e., the array has more elements than this list), the element in
* the array immediately following the end of the list is set to
* {@code null}. (This is useful in determining the length of this
* list <i>only</i> if the caller knows that this list does not contain
* any null elements.)
*
* <p>Like the {@link #toArray()} method, this method acts as bridge between
* array-based and collection-based APIs. Further, this method allows
* precise control over the runtime type of the output array, and may,
* under certain circumstances, be used to save allocation costs.
*
* <p>Suppose {@code x} is a list known to contain only strings.
* The following code can be used to dump the list into a newly
* allocated array of {@code String}:
*
* <pre> {@code String[] y = x.toArray(new String[0]);}</pre>
*
* Note that {@code toArray(new Object[0])} is identical in function to
* {@code toArray()}.
*
* @param a the array into which the elements of the list are to
* be stored, if it is big enough; otherwise, a new array of the
* same runtime type is allocated for this purpose.
*
* @return an array containing all the elements in this list
*
* @throws ArrayStoreException if the runtime type of the specified array
* is not a supertype of the runtime type of every element in
* this list
* @throws NullPointerException if the specified array is null
*/
@SuppressWarnings("unchecked")
public <T> T[] toArray(T[] a) {
Object[] es = getArray();
int len = es.length;
if(a.length<len) {
return (T[]) Arrays.copyOf(es, len, a.getClass());
} else {
System.arraycopy(es, 0, a, 0, len);
if(a.length>len) {
a[len] = null;
}
return a;
}
}
/*▲ 视图 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 迭代 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* @throws NullPointerException {@inheritDoc}
*/
// 遍历当前顺序表中的元素,并对其应用指定的择取操作
public void forEach(Consumer<? super E> action) {
Objects.requireNonNull(action);
for(Object x : getArray()) {
@SuppressWarnings("unchecked")
E e = (E) x;
action.accept(e);
}
}
/**
* Returns an iterator over the elements in this list in proper sequence.
*
* <p>The returned iterator provides a snapshot of the state of the list
* when the iterator was constructed. No synchronization is needed while
* traversing the iterator. The iterator does <em>NOT</em> support the
* {@code remove} method.
*
* @return an iterator over the elements in this list in proper sequence
*/
// 返回当前顺序表的一个迭代器
public Iterator<E> iterator() {
return new COWIterator<E>(getArray(), 0);
}
/**
* {@inheritDoc}
*
* <p>The returned iterator provides a snapshot of the state of the list
* when the iterator was constructed. No synchronization is needed while
* traversing the iterator. The iterator does <em>NOT</em> support the
* {@code remove}, {@code set} or {@code add} methods.
*/
// 返回当前顺序表的一个增强的迭代器,且设定下一个待遍历元素为索引0处的元素
public ListIterator<E> listIterator() {
return new COWIterator<E>(getArray(), 0);
}
/**
* {@inheritDoc}
*
* <p>The returned iterator provides a snapshot of the state of the list
* when the iterator was constructed. No synchronization is needed while
* traversing the iterator. The iterator does <em>NOT</em> support the
* {@code remove}, {@code set} or {@code add} methods.
*
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
// 返回当前顺序表的一个增强的迭代器,且设定下一个待遍历元素为索引index处的元素
public ListIterator<E> listIterator(int index) {
Object[] es = getArray();
int len = es.length;
if(index<0 || index>len) {
throw new IndexOutOfBoundsException(outOfBounds(index, len));
}
return new COWIterator<E>(es, index);
}
/**
* Returns a {@link Spliterator} over the elements in this list.
*
* <p>The {@code Spliterator} reports {@link Spliterator#IMMUTABLE},
* {@link Spliterator#ORDERED}, {@link Spliterator#SIZED}, and
* {@link Spliterator#SUBSIZED}.
*
* <p>The spliterator provides a snapshot of the state of the list
* when the spliterator was constructed. No synchronization is needed while
* operating on the spliterator.
*
* @return a {@code Spliterator} over the elements in this list
*
* @since 1.8
*/
// 返回一个可分割的迭代器
public Spliterator<E> spliterator() {
return Spliterators.spliterator(getArray(), Spliterator.IMMUTABLE | Spliterator.ORDERED);
}
/*▲ 迭代 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 杂项 ████████████████████████████████████████████████████████████████████████████████┓ */
/**
* Returns the number of elements in this list.
*
* @return the number of elements in this list
*/
// 返回当前顺序表的元素数量
public int size() {
return getArray().length;
}
/**
* Returns {@code true} if this list contains no elements.
*
* @return {@code true} if this list contains no elements
*/
// 判断当前顺序表是否为空
public boolean isEmpty() {
return size() == 0;
}
// 使用指定的比较器对当前顺序表内的元素进行排序
public void sort(Comparator<? super E> c) {
synchronized(lock) {
sortRange(c, 0, getArray().length);
}
}
/*▲ 杂项 ████████████████████████████████████████████████████████████████████████████████┛ */
/*▼ 序列化 ████████████████████████████████████████████████████████████████████████████████┓ */
private static final long serialVersionUID = 8673264195747942595L;
/**
* Saves this list to a stream (that is, serializes it).
*
* @param s the stream
*
* @throws java.io.IOException if an I/O error occurs
* @serialData The length of the array backing the list is emitted
* (int), followed by all of its elements (each an Object)
* in the proper order.
*/
private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException {
s.defaultWriteObject();
Object[] es = getArray();
// Write out array length
s.writeInt(es.length);
// Write out all elements in the proper order.
for(Object element : es) {
s.writeObject(element);
}
}
/**
* Reconstitutes this list from a stream (that is, deserializes it).
*
* @param s the stream
*
* @throws ClassNotFoundException if the class of a serialized object
* could not be found
* @throws java.io.IOException if an I/O error occurs
*/
private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException {
s.defaultReadObject();
// bind to new lock
resetLock();
// Read in array length and allocate array
int len = s.readInt();
SharedSecrets.getJavaObjectInputStreamAccess().checkArray(s, Object[].class, len);
Object[] es = new Object[len];
// Read in all elements in the proper order.
for(int i = 0; i<len; i++) {
es[i] = s.readObject();
}
setArray(es);
}
/*▲ 序列化 ████████████████████████████████████████████████████████████████████████████████┛ */
/**
* Compares the specified object with this list for equality.
* Returns {@code true} if the specified object is the same object
* as this object, or if it is also a {@link List} and the sequence
* of elements returned by an {@linkplain List#iterator() iterator}
* over the specified list is the same as the sequence returned by
* an iterator over this list. The two sequences are considered to
* be the same if they have the same length and corresponding
* elements at the same position in the sequence are <em>equal</em>.
* Two elements {@code e1} and {@code e2} are considered
* <em>equal</em> if {@code Objects.equals(e1, e2)}.
*
* @param o the object to be compared for equality with this list
*
* @return {@code true} if the specified object is equal to this list
*/
public boolean equals(Object o) {
if(o == this) {
return true;
}
if(!(o instanceof List)) {
return false;
}
List<?> list = (List<?>) o;
Iterator<?> it = list.iterator();
for(Object element : getArray()) {
if(!it.hasNext() || !Objects.equals(element, it.next())) {
return false;
}
}
return !it.hasNext();
}
/**
* Returns the hash code value for this list.
*
* <p>This implementation uses the definition in {@link List#hashCode}.
*
* @return the hash code value for this list
*/
public int hashCode() {
Object[] es = getArray();