Java8 LinkedList源码阅读

概述

1
2
public class LinkedList<E> extends AbstractSequentialList<E>
implements List<E>, Deque<E>, Cloneablejava.io.Serializable

ArrayList继承于AbstractSequentialList,实现了List接口、Deque接口、Cloneable接口(浅拷贝)、Serializable接口。总的来说,LinkedList是线程不安全的,允许元素为null的双向链表,它也可以被当作栈、队列或双向队列进行操作。

与ArrayList的比较

LinkedList与ArrayList相比,ArrayList的增删效率低(O(n)),但是改查效率高(O(1))。而LinkedList正好相反,由于其底层是链表实现的,增删(O(1))只需要修改链表节点指针,所以增删效率较高,而改查都需要先定位到目标节点(O(n)),故改查效率较低。同时,LinkedList不需要ArrayList中的批量扩容,也不需要预留空间,所以空间效率也比ArrayList高。

但是和ArrayList比,LinkedList没有实现RandomAccess接口,所以随机访问元素速度较慢。虽然作者做了折半查找的优化(根据index判断目标节点在链表的前半段还是后半段,然后决定是从头部开始尾部开始查找),但查找的时间效率仍然比较低。

LinkedList源码阅读笔记

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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
package java.util;

import java.util.function.Consumer;


public class LinkedList<E>
extends AbstractSequentialList<E>
implements List<E>, Deque<E>, Cloneable, java.io.Serializable
{

// 链接节点初始个数
transient int size = 0;


/**

* 头节点

* Invariant: (first == null && last == null) ||

* (first.prev == null && first.item != null)

*/

transient Node<E> first;



/**

* first与last都需要保持全局不变性,即:

* 1.如果链表为空,两个都必须为null

* 2.如果链表不为空,那么first的前向指针一定是null,first的元素一定不为null,同理last的后向指针一定是null,last的元素一定不为null

*/



/**

* 尾节点

* Invariant: (first == null && last == null) ||

* (last.next == null && last.item != null)

*/

transient Node<E> last;



// 构造一个空链表

public LinkedList() {

}



// 构造一个包含指定集合c内元素的列表,元素顺序由该集合的迭代器返回顺序决定,如果指定集合为空会抛出NullPointerException异常

public LinkedList(Collection<? extends E> c) {

this();

addAll(c);

}



// 将指定元素e链接到头部(设为头节点)

private void linkFirst(E e) {

// f用来临时保存当前的头节点

final Node<E> f = first;

// 构造一个新节点newNode,前向指针为null,元素为e,后向指针指向f,这就是更新后的头节点

final Node<E> newNode = new Node<>(null, e, f);

// first赋为newNode

first = newNode;

// 下面操作是为了保持first与last的不变性

// 若原先头结点为空

if (f == null)

// 构造的结点不仅为头结点,也是尾结点

last = newNode;

// 不为空

else

// 将f的前向指针指向nowNode

f.prev = newNode;

size++;

// 链表结构改变,modCount++

modCount++;

}



// 将指定元素e链接到尾部(设为尾节点)

// 原理与linkFirst()类似

void linkLast(E e) {

final Node<E> l = last;

final Node<E> newNode = new Node<>(l, e, null);

last = newNode;

if (l == null)

first = newNode;

else

l.next = newNode;

size++;

modCount++;

}



// 在指定节点前插入节点,被插入节点不为null

void linkBefore(E e, Node<E> succ) {

// assert succ != null;

// 获取前一个节点

final Node<E> pred = succ.prev;

// 构造一个新节点newNode,前向指针指向pred,元素为e,后向指针指向succ,这就是要插入的节点

final Node<E> newNode = new Node<>(pred, e, succ);

// 被插入节点succ的前向指针指向新节点newNode

succ.prev = newNode;

// 如果前一个节点为null,新节点newNode就是头节点

if (pred == null)

first = newNode;

// 不为null

else

// 被插入节点的后向指针指向新节点newNode

pred.next = newNode;

size++;

// 链表结构改变,modCount++

modCount++;

}



// 删除头节点并返回删除的前头节点的值,内部的私有方法

// 使用该方法的前提是参数f是头节点,而且f不能为空

private E unlinkFirst(Node<E> f) {

// assert f == first && f != null;

// 临时保存头节点f的值

final E element = f.item;

// 临时保存头节点f的后驱节点

final Node<E> next = f.next;

// 将f的值与后向指针设为null

f.item = null;

f.next = null; // 方便 GC

// 原头节点的后驱节点变成新的头节点

first = next;

// 如果不存后驱节点,则尾节点也设为null,此时是一个空链表

if (next == null)

last = null;

// 如果存在后驱节点,前向指针指向null(头节点的要求)

else

next.prev = null;

size--;

// 链表结构改变,modCount++

modCount++;

// 返回被删除的头节点f的值

return element;

}



// 删除尾节点并返回删除的前头节点的值,内部的私有方法,与上个方法类似

// 使用该方法的前提是参数f是尾节点,而且f不能为空

private E unlinkLast(Node<E> l) {

// assert l == last && l != null;

// 临时保存尾节点f的值

final E element = l.item;

// 临时保存尾节点f的前驱节点

final Node<E> prev = l.prev;

// 将f的值与前向指针设为null

l.item = null;

l.prev = null; // 方便 GC

// 原尾节点的前驱节点变成新的尾节点

last = prev;

// 如果不存前驱节点,则头节点也设为null,此时是一个空链表

if (prev == null)

first = null;

else

// 如果存在前驱节点,后向指针指向null(尾节点的要求)

prev.next = null;

size--;

// 链表结构改变,modCount++

modCount++;

// 返回被删除的头节点f的值

return element;

}



// 删除指定节点并返回被删除节点的值

E unlink(Node<E> x) {

// assert x != null;

// 获得指定节点x的值、前驱节点、后驱节点

final E element = x.item;

final Node<E> next = x.next;

final Node<E> prev = x.prev;



// 如果前驱节点为null(即指定节点x为头节点)

if (prev == null) {

// 指定节点x的后驱节点成为新的头节点

first = next;



// 如果前驱节点不为空

} else {

// 指定节点x的前驱节点的后向指针指向x的后驱节点

prev.next = next;

// x的前向指针指向null

x.prev = null;

}



// 如果后驱节点为null(即指定节点x为尾节点)

if (next == null) {

// 指定节点x的前驱节点成为新的尾节点

last = prev;

// 如果后驱节点不为空

} else {

// 指定节点x的后驱节点的前向指针指向x的前驱节点

next.prev = prev;

// x的后向指针指向null

x.next = null;

}



// 将x的值设为null

x.item = null;

size--;

// 链表结构改变,modCount++

modCount++;

// 返回被删除节点x的值

return element;

}



//返回头节点,如果链表为空,则抛出异常NoSuchElementException

public E getFirst() {

final Node<E> f = first;

if (f == null)

throw new NoSuchElementException();

return f.item;

}



//返回尾节点,如果链表为空,则抛出异常NoSuchElementException

public E getLast() {

final Node<E> l = last;

if (l == null)

throw new NoSuchElementException();

return l.item;

}



// 删除头节点,利用unlinkFirst()方法实现,会返回被删除的头节点值;如果链表为空抛出异常NoSuchElementException

public E removeFirst() {

final Node<E> f = first;

if (f == null)

throw new NoSuchElementException();

return unlinkFirst(f);

}



// 删除尾节点,利用unlinkLast()方法实现,会返回被删除的头节点值;如果链表为空抛出异常NoSuchElementException

public E removeLast() {

final Node<E> l = last;

if (l == null)

throw new NoSuchElementException();

return unlinkLast(l);

}



// 插入新的头节点,利用linkFirst()实现

public void addFirst(E e) {

linkFirst(e);

}



// 插入新的尾节点,利用linkLast()实现

public void addLast(E e) {

linkLast(e);

}



// 判断链表是否包含指定元素,利用indexOf()实现,若indexOf()方法找不到指定元素会返回-1

public boolean contains(Object o) {

return indexOf(o) != -1;

}



// 返回链表长度

public int size() {

return size;

}



// 在尾部添加指定元素

public boolean add(E e) {

linkLast(e);

return true;

}



// 删除在链表中第一次出现的指定元素(遍历形式),找到并删除返回true,没找到则返回false

public boolean remove(Object o) {



// 如果指定元素为null

if (o == null) {

// 遍历链表

for (Node<E> x = first; x != null; x = x.next) {

// 找到第一次出现的null

if (x.item == null) {

// 找到则删除该节点

unlink(x);

return true;

}

}

// 如果指定元素不为null

} else {

// 遍历链表

for (Node<E> x = first; x != null; x = x.next) {

// 利用equals()判断是否相等

if (o.equals(x.item)) {

// 找到则删除该节点

unlink(x);

return true;

}

}

}

// 没找到返回false

return false;

}



// 从尾部开始添加添加指定集合的元素到链表中,元素顺序由该集合的迭代器返回顺序决定,若指定集合为null会抛出异常NullPointerException

public boolean addAll(Collection<? extends E> c) {

// 从size处开始添加,元素位置(1~size)

return addAll(size, c);

}



// 该方法很重要!从特定位置开始添加指定集合的元素到链表中,注意作者原注释表述的不是下标index而是位置position

// index位置的元素(如果有的话)和后面所有的节点将向右移动

// 元素顺序由该集合的迭代器返回顺序决定,若指定集合为null会抛出异常NullPointerException

public boolean addAll(int index, Collection<? extends E> c) {

// 检查插入位置是否合法

checkPositionIndex(index);

// 将指定集合转为数组

Object[] a = c.toArray();

// 得到数组长度

int numNew = a.length;

// 如果数组长度为0

if (numNew == 0)

// 返回false

return false;



// pred:index的前驱节点;succ:最后一个节点;

Node<E> pred, succ;

// 如果添加的位置是尾部

if (index == size) {

// succ设为空,pred指向尾节点

succ = null;

pred = last;

// 如果添加的位置不是尾部

} else {

// succ指向待插入位置的节点

succ = node(index);

// pred指向succ节点的前驱节点

pred = succ.prev;

}

// 遍历数组中的每个元素

for (Object o : a) {

// 告诉编译器忽略指定的警告,不用在编译完成后出现警告信息

@SuppressWarnings("unchecked")

E e = (E) o;

// 每次遍历都新建一个节点,值为遍历当前元素值

// 向前指向pred,向后指向null

Node<E> newNode = new Node<>(pred, e, null);

// 如果前驱节点为null

if (pred == null)

// newNode设为头节点

first = newNode;

// 如果前向节点不为null

else

// pred的后驱节点设为newNode

pred.next = newNode;

// newNode成为前一个节点pred,向后移动

pred = newNode;

}



// 如果succ为null,即新添加节点位于尾部(succ=pred.next)

// 因为遍历完成后pred指向的是链表中的最后一个元素

if (succ == null) {

// pred设为尾节点

last = pred;

// 如果不为空

} else {

// pred向后指向succ,succ向前指向pred

pred.next = succ;

succ.prev = pred;

}

// 链表长度增加

size += numNew;

// 链表结构改变,modCount++

modCount++;

// 添加成功,返回true

return true;

}



// 清空链表

public void clear() {

// 清空所有节点间的链接是“不必要”的,但这样可以方便GC

// 遍历链表,每个节点都置空

for (Node<E> x = first; x != null; ) {

Node<E> next = x.next;

x.item = null;

x.next = null;

x.prev = null;

x = next;

}

// 头节点和尾节点置为空

first = last = null;

// 链表长度置0

size = 0;

// 链表结构改变,modCount仍要++

modCount++;

}





// 获取指定index的节点值,index非法会抛出异常IndexOutOfBoundsException

public E get(int index) {

// 检查index是否合法

checkElementIndex(index);

return node(index).item;

}



// 修改指定index的值并返回之前的值,index非法会抛出异常IndexOutOfBoundsException

public E set(int index, E element) {

// 检查index是否合法

checkElementIndex(index);

Node<E> x = node(index);

E oldVal = x.item;

x.item = element;

return oldVal;

}



// 添加新元素至指定index

public void add(int index, E element) {

// 检查index是否合法

checkPositionIndex(index);

// 如果是尾部

if (index == size)

// 直接调用linkLast()方法

linkLast(element);

// 不是尾部

else

// 调用linkBefore()方法添加到指定index前

linkBefore(element, node(index));

}



// 删除指定index上的元素

public E remove(int index) {

// 检查index是否合法

checkElementIndex(index);

// 调用unlink()方法

return unlink(node(index));

}



// 检查index是否越界

private boolean isElementIndex(int index) {

return index >= 0 && index < size;

}



// 检查位置是否越界,由于可以在LinkedList尾部处添加新元素,所以允许index<=size

private boolean isPositionIndex(int index) {

return index >= 0 && index <= size;

}



// 返回IndexOutOfBoundsException的具体异常信息

private String outOfBoundsMsg(int index) {

return "Index: "+index+", Size: "+size;

}



// 检查参数index是否是元素的索引,若不是则抛出异常IndexOutOfBoundsException

private void checkElementIndex(int index) {

if (!isElementIndex(index))

throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

}



// 这个方法用于判断当新添加元素时传进来的参数index是否合法,若不是则抛出异常IndexOutOfBoundsException

private void checkPositionIndex(int index) {

if (!isPositionIndex(index))

throw new IndexOutOfBoundsException(outOfBoundsMsg(index));

}



// 获取指定位置的节点

Node<E> node(int index) {

// assert isElementIndex(index);

// 如果index小于链表长度一半,则从头节点开始遍历

if (index < (size >> 1)) {

Node<E> x = first;

for (int i = 0; i < index; i++)

x = x.next;

return x;

// 如果index小于链表长度一半,则从尾节点开始遍历

} else {

Node<E> x = last;

for (int i = size - 1; i > index; i--)

x = x.prev;

return x;

}

}



// Search Operations

// 查找操作



// 返回指定元素在LinkedList中第一次出现的位置,找不到则返回-1

public int indexOf(Object o) {

int index = 0;

// 若指定元素为空

if (o == null) {

// 从头部开始遍历

for (Node<E> x = first; x != null; x = x.next) {

if (x.item == null)

return index;

index++;

}

// 若指定元素不为空

} else {

for (Node<E> x = first; x != null; x = x.next) {

if (o.equals(x.item))

return index;

index++;

}

}

return -1;

}



// 返回指定元素在LinkedList中最后一次出现的位置,找不到则返回-1

// 与上面方法类似,就是从尾节点开始找

public int lastIndexOf(Object o) {

int index = size;

if (o == null) {

// 从尾部开始遍历

for (Node<E> x = last; x != null; x = x.prev) {

index--;

if (x.item == null)

return index;

}

} else {

for (Node<E> x = last; x != null; x = x.prev) {

index--;

if (o.equals(x.item))

return index;

}

}

return -1;

}



// Queue operations.

// 队列操作



// 出队,返回头节点,如果头节点为空则返回null,这个操作不会删除元素

public E peek() {

final Node<E> f = first;

return (f == null) ? null : f.item;

}



// 调用getFirst()方法完成出队,返回头节点的值,如果头节点为空则抛出异常NoSuchElementException

public E element() {

return getFirst();

}



// 出队,返回头节点,如果头节点为空则返回null,这个操作会删除元素

public E poll() {

final Node<E> f = first;

return (f == null) ? null : unlinkFirst(f);

}



// 调用removeFirst()方法完成出队,返回头节点的值,如果头结点为空,则抛出异常NoSuchElementException

public E remove() {

return removeFirst();

}



// 入队,调用add()方法在尾部添加新的元素

public boolean offer(E e) {

return add(e);

}



// Deque operations

// 双向队列操作



// 入队,调用addFirst()方法在头部添加新的元素

public boolean offerFirst(E e) {

addFirst(e);

return true;

}



// 入队,调用addLast()方法在尾部添加新的元素

public boolean offerLast(E e) {

addLast(e);

return true;

}



// 出队(从头部),如果头节点为空则返回null,这个操作不会删除元素

public E peekFirst() {

final Node<E> f = first;

return (f == null) ? null : f.item;

}



// 出队(从尾部),如果尾节点为空则返回null,这个操作不会删除元素

public E peekLast() {

final Node<E> l = last;

return (l == null) ? null : l.item;

}



// 出队(从头部),如果头节点为空则返回null,这个操作会删除元素

public E pollFirst() {

final Node<E> f = first;

return (f == null) ? null : unlinkFirst(f);

}



// 出队(从尾部),如果尾节点为空则返回null,这个操作会删除元素

public E pollLast() {

final Node<E> l = last;

return (l == null) ? null : unlinkLast(l);

}



// 入栈(从头部)

public void push(E e) {

addFirst(e);

}



// 出栈,弹出栈顶元素,栈顶元素会被删除

public E pop() {

// 删除头节点并返回头节点元素

return removeFirst();

}



// 删除第一次出现(顺序)的指定元素o

public boolean removeFirstOccurrence(Object o) {

return remove(o);

}



// 删除最后一次出现(逆序)的指定元素o

public boolean removeLastOccurrence(Object o) {

if (o == null) {

// 从尾部开始遍历

for (Node<E> x = last; x != null; x = x.prev) {

if (x.item == null) {

unlink(x);

return true;

}

}

} else {

for (Node<E> x = last; x != null; x = x.prev) {

if (o.equals(x.item)) {

unlink(x);

return true;

}

}

}

return false;

}



// 返回list-iterator迭代器,index为开始迭代位置

public ListIterator<E> listIterator(int index) {

// 检查Index是否合法

checkPositionIndex(index);

return new ListItr(index);

}



// ListItr实现了ListIterator接口

private class ListItr implements ListIterator<E> {

// 上一次操作返回的节点,默认为null

private Node<E> lastReturned = null;

private Node<E> next;

// 用来记录next的索引

private int nextIndex;

// 保存当前modCount,确保fail-fast机制

private int expectedModCount = modCount;



// 从指定index开始迭代

ListItr(int index) {

// assert isPositionIndex(index);

// 迭代到尾部返回null,否则返回当前节点

next = (index == size) ? null : node(index);

nextIndex = index;

}



// 判断后面是否还有元素

public boolean hasNext() {

return nextIndex < size;

}



public E next() {

// 检查链表结构是否被外部修改,即modCount是否与expectedModCount相等

checkForComodification();

if (!hasNext())

throw new NoSuchElementException();



// 使用lastReturned记录next元素

lastReturned = next;

// next指向下一个元素

next = next.next;

// nextIndex右移

nextIndex++;

// 返回当前元素

return lastReturned.item;

}



// 判断前面是否还有元素

public boolean hasPrevious() {

return nextIndex > 0;

}



public E previous() {

// 检查链表结构是否被外部修改

checkForComodification();

if (!hasPrevious())

throw new NoSuchElementException();



// next指向前一个节点,并赋给lastReturned

lastReturned = next = (next == null) ? last : next.prev;

// next索引也同步自减

nextIndex--;

// 返回当前值

return lastReturned.item;

}



// 返回next指向节点索引

public int nextIndex() {

return nextIndex;

}



// 返回next前一个节点索引

public int previousIndex() {

return nextIndex - 1;

}





// 删除最近一次操作(next或previous)返回的节点(lastReturned),该方法不能连续调用两次

public void remove() {

// 检查链表结构是否被外部修改

checkForComodification();

if (lastReturned == null)

throw new IllegalStateException();

// 获取lastReturned的下一个节点

Node<E> lastNext = lastReturned.next;

// 删除lastReturned

unlink(lastReturned);

// 如果next与lastReturned相等,即上一次是previous操作

if (next == lastReturned)

/*

* 因为是previous操作,next与lastReturned指向的是同一元素,删除了

* lastReturned指向的元素就是删除next指向的元素,所以在删除后next需指向下一个节点

*

* 至于为什么nextIndex不需减一,看下面图就明白了,其中lastReturned与

* next都指向了索引为1的节点,因此将删除索引为1的节点,由于删除的节点也是

* next指向的节点,删除后后面的节点的逻辑索引号都要减一,因此删除后next指向

* 的2节点索引号会变成1,这与nextIndex是相等的,所以不必减一了

*

* lastReturned next

* ↓ ↓

* ----------+----------+---------+---------+----------

* | Head | 0 | 1(del) | 2 | 3 |

* ----------+----------+---------+---------+----------

*/

next = lastNext;

// 上一次是next操作

else

// nextIndex左移

/*

* 由于删除的是lastReturned指向的节点,走该分支的条件是上次是进行了next操作,

* 所以此情况下next指向的元素根本就没有被删除,而是删除的它前面节点,又由

* 于删除了一个元素,next指向的元素的索引编号就会前移一个,所以这里需要减一,

* 因与上面不同的,next所指的物理位置没有发生变化,但他所指向的节点的逻辑编号

* 发生了变化,从2变成了1,参考下图

*

* lastReturned next

* ↓ ↓

* ----------+----------+---------+---------+----------

* | Head | 0 | 1(del) | 2 | 3 |

* ----------+----------+---------+---------+----------

*/

nextIndex--;

// lastReturned重新置为null

lastReturned = null;

// 链表结构被修改,expectedModCount++

expectedModCount++;

}



// 将最近一次操作返回的lastReturned值设为e

public void set(E e) {

if (lastReturned == null)

throw new IllegalStateException();

checkForComodification();

lastReturned.item = e;

}



public void add(E e) {

checkForComodification();

// lastReturned重新置为null

lastReturned = null;

// 如果是尾部,直接将e设为尾节点

if (next == null)

linkLast(e);

// 否则在next指向节点前插入节点

else

linkBefore(e, next);

// nextIndex右移

nextIndex++;

expectedModCount++;

}



// 对每一个元素进行操作

public void forEachRemaining(Consumer<? super E> action) {

Objects.requireNonNull(action);

while (modCount == expectedModCount && nextIndex < size) {

action.accept(next.item);

lastReturned = next;

next = next.next;

nextIndex++;

}

checkForComodification();

}



// 保证fail-fast机制

final void checkForComodification() {

if (modCount != expectedModCount)

throw new ConcurrentModificationException();

}

}



// 节点的数据结构,包含前后节点指针与节点元素

private static class Node<E> {

E item;

Node<E> next;

Node<E> prev;



Node(Node<E> prev, E element, Node<E> next) {

this.item = element;

this.next = next;

this.prev = prev;

}

}



// 返回DescendingIterator迭代器(逆序迭代)

public Iterator<E> descendingIterator() {

return new DescendingIterator();

}



// DescendingIterator实现了Iterator接口,实际上是对ListItr进行了封装

private class DescendingIterator implements Iterator<E> {

// 获得从尾部开始的ListItr

private final ListItr itr = new ListItr(size());

public boolean hasNext() {

return itr.hasPrevious();

}

public E next() {

return itr.previous();

}

public void remove() {

itr.remove();

}

}



// 调用父类的clone()方法初始化链表的clone

// super.clone()方法并不会重新生成first和last以外的节点,故还需要下面的clone()方法

@SuppressWarnings("unchecked")

private LinkedList<E> superClone() {

try {

return (LinkedList<E>) super.clone();

} catch (CloneNotSupportedException e) {

throw new InternalError(e);

}

}



// 返回LinkedList的浅克隆

// 注意,Node是深拷贝(会重新生成Node),但是item是浅拷贝的(指向同一引用地址),因此改变clone后链表的元素,对应的原链表元素也会改变,所以作者原注释为shallow copy

public Object clone() {

LinkedList<E> clone = superClone();



// 重置clone对象初始状态

clone.first = clone.last = null;

clone.size = 0;

clone.modCount = 0;



// Initialize clone with our elements

for (Node<E> x = first; x != null; x = x.next)

clone.add(x.item);



return clone;

}



// 转化为数组,该数组是新生成的不是而不是对这个list的引用

public Object[] toArray() {

Object[] result = new Object[size];

int i = 0;

for (Node<E> x = first; x != null; x = x.next)

result[i++] = x.item;

return result;

}



// 转化为数组(泛型方法),有参

@SuppressWarnings("unchecked")

public <T> T[] toArray(T[] a) {

// 如果a的长度小于集合的长度

if (a.length < size)

// 通过反射创建一个和集合同样大小的数组

a = (T[])java.lang.reflect.Array.newInstance(

a.getClass().getComponentType(), size);

int i = 0;

Object[] result = a;

// 遍历集合,将所有元素添加到该数组中

for (Node<E> x = first; x != null; x = x.next)

result[i++] = x.item;



// 如果数组的元素的个数大于集合中元素的个数,则a[size]置为null

if (a.length > size)

a[size] = null;



return a;

}



private static final long serialVersionUID = 876323262645176354L;



// 将LinkedList写入流中(序列化)

private void writeObject(java.io.ObjectOutputStream s)

throws java.io.IOException {

// Write out any hidden serialization magic

s.defaultWriteObject();



// 写入元素数量

s.writeInt(size);



// 按顺序写入所有元素

for (Node<E> x = first; x != null; x = x.next)

s.writeObject(x.item);

}



// 从流中读取LinkedList(反序列化)

@SuppressWarnings("unchecked")

private void readObject(java.io.ObjectInputStream s)

throws java.io.IOException, ClassNotFoundException {

// Read in any hidden serialization magic

s.defaultReadObject();



// 读取元素数量

int size = s.readInt();



// 按顺序读入所有元素

for (int i = 0; i < size; i++)

linkLast((E)s.readObject());

}



/**

* Creates a <em><a href="Spliterator.html#binding">late-binding</a></em>

* and <em>fail-fast</em> {@link Spliterator} over the elements in this

* list.

*

* <p>The {@code Spliterator} reports {@link Spliterator#SIZED} and

* {@link Spliterator#ORDERED}. Overriding implementations should document

* the reporting of additional characteristic values.

*

* @implNote

* The {@code Spliterator} additionally reports {@link Spliterator#SUBSIZED}

* and implements {@code trySplit} to permit limited parallelism..

*

* @return a {@code Spliterator} over the elements in this list

* @since 1.8

*/

@Override

public Spliterator<E> spliterator() {

return new LLSpliterator<E>(this, -1, 0);

}



// JDK8中新增加的LLSpliterator,是一个为了实现并行遍历元素而设计的可分割迭代器

static final class LLSpliterator<E> implements Spliterator<E> {

static final int BATCH_UNIT = 1 << 10; // batch array size increment

static final int MAX_BATCH = 1 << 25; // max batch array size;

final LinkedList<E> list; // null OK unless traversed

Node<E> current; // current node; null until initialized

int est; // size estimate; -1 until first needed

int expectedModCount; // initialized when est set

int batch; // batch size for splits



LLSpliterator(LinkedList<E> list, int est, int expectedModCount) {

this.list = list;

this.est = est;

this.expectedModCount = expectedModCount;

}



final int getEst() {

int s; // force initialization

final LinkedList<E> lst;

if ((s = est) < 0) {

if ((lst = list) == null)

s = est = 0;

else {

expectedModCount = lst.modCount;

current = lst.first;

s = est = lst.size;

}

}

return s;

}



public long estimateSize() { return (long) getEst(); }



public Spliterator<E> trySplit() {

Node<E> p;

int s = getEst();

if (s > 1 && (p = current) != null) {

int n = batch + BATCH_UNIT;

if (n > s)

n = s;

if (n > MAX_BATCH)

n = MAX_BATCH;

Object[] a = new Object[n];

int j = 0;

do { a[j++] = p.item; } while ((p = p.next) != null && j < n);

current = p;

batch = j;

est = s - j;

return Spliterators.spliterator(a, 0, j, Spliterator.ORDERED);

}

return null;

}



public void forEachRemaining(Consumer<? super E> action) {

Node<E> p; int n;

if (action == null) throw new NullPointerException();

if ((n = getEst()) > 0 && (p = current) != null) {

current = null;

est = 0;

do {

E e = p.item;

p = p.next;

action.accept(e);

} while (p != null && --n > 0);

}

if (list.modCount != expectedModCount)

throw new ConcurrentModificationException();

}



public boolean tryAdvance(Consumer<? super E> action) {

Node<E> p;

if (action == null) throw new NullPointerException();

if (getEst() > 0 && (p = current) != null) {

--est;

E e = p.item;

current = p.next;

action.accept(e);

if (list.modCount != expectedModCount)

throw new ConcurrentModificationException();

return true;

}

return false;

}



public int characteristics() {

return Spliterator.ORDERED | Spliterator.SIZED | Spliterator.SUBSIZED;

}

}



}
  • 本文作者: Marticles
  • 版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处!