This file is indexed.

/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html is in libbackport-util-concurrent-java-doc 3.1-3build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri May 18 11:21:08 UTC 2012 -->
<title>ThreadPoolExecutor</title>
<meta name="date" content="2012-05-18">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="ThreadPoolExecutor";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.AbortPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html" target="_top">Frames</a></li>
<li><a href="ThreadPoolExecutor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.emory.mathcs.backport.java.util.concurrent</div>
<h2 title="Class ThreadPoolExecutor" class="title">Class ThreadPoolExecutor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">edu.emory.mathcs.backport.java.util.concurrent.AbstractExecutorService</a></li>
<li>
<ul class="inheritance">
<li>edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Executor</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ExecutorService</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ScheduledThreadPoolExecutor.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ScheduledThreadPoolExecutor</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ThreadPoolExecutor</span>
extends <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">AbstractExecutorService</a></pre>
<div class="block">An <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>ExecutorService</code></a> that executes each submitted task using
 one of possibly several pooled threads, normally configured
 using <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>Executors</code></a> factory methods.

 <p>Thread pools address two different problems: they usually
 provide improved performance when executing large numbers of
 asynchronous tasks, due to reduced per-task invocation overhead,
 and they provide a means of bounding and managing the resources,
 including threads, consumed when executing a collection of tasks.
 Each <code>ThreadPoolExecutor</code> also maintains some basic
 statistics, such as the number of completed tasks.

 <p>To be useful across a wide range of contexts, this class
 provides many adjustable parameters and extensibility
 hooks. However, programmers are urged to use the more convenient
 <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>Executors</code></a> factory methods <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html#newCachedThreadPool()"><code>Executors.newCachedThreadPool()</code></a> (unbounded thread pool, with
 automatic thread reclamation), <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html#newFixedThreadPool(int)"><code>Executors.newFixedThreadPool(int)</code></a>
 (fixed size thread pool) and <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html#newSingleThreadExecutor()"><code>Executors.newSingleThreadExecutor()</code></a> (single background thread), that
 preconfigure settings for the most common usage
 scenarios. Otherwise, use the following guide when manually
 configuring and tuning this class:

 <dl>

 <dt>Core and maximum pool sizes</dt>

 <dd>A <code>ThreadPoolExecutor</code> will automatically adjust the
 pool size (see <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getPoolSize()"><code>getPoolSize()</code></a>)
 according to the bounds set by
 corePoolSize (see <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getCorePoolSize()"><code>getCorePoolSize()</code></a>) and
 maximumPoolSize (see <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getMaximumPoolSize()"><code>getMaximumPoolSize()</code></a>).

 When a new task is submitted in method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#execute(java.lang.Runnable)"><code>execute(java.lang.Runnable)</code></a>, and fewer
 than corePoolSize threads are running, a new thread is created to
 handle the request, even if other worker threads are idle.  If
 there are more than corePoolSize but less than maximumPoolSize
 threads running, a new thread will be created only if the queue is
 full.  By setting corePoolSize and maximumPoolSize the same, you
 create a fixed-size thread pool. By setting maximumPoolSize to an
 essentially unbounded value such as <code>Integer.MAX_VALUE</code>, you
 allow the pool to accommodate an arbitrary number of concurrent
 tasks. Most typically, core and maximum pool sizes are set only
 upon construction, but they may also be changed dynamically using
 <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setCorePoolSize(int)"><code>setCorePoolSize(int)</code></a> and <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setMaximumPoolSize(int)"><code>setMaximumPoolSize(int)</code></a>. </dd>

 <dt>On-demand construction</dt>

 <dd> By default, even core threads are initially created and
 started only when new tasks arrive, but this can be overridden
 dynamically using method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#prestartCoreThread()"><code>prestartCoreThread()</code></a> or <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#prestartAllCoreThreads()"><code>prestartAllCoreThreads()</code></a>.  You probably want to prestart threads if
 you construct the pool with a non-empty queue. </dd>

 <dt>Creating new threads</dt>

 <dd>New threads are created using a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>ThreadFactory</code></a>.  If not
 otherwise specified, a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html#defaultThreadFactory()"><code>Executors.defaultThreadFactory()</code></a> is
 used, that creates threads to all be in the same <code>ThreadGroup</code> and with the same <code>NORM_PRIORITY</code> priority and
 non-daemon status. By supplying a different ThreadFactory, you can
 alter the thread's name, thread group, priority, daemon status,
 etc. If a <code>ThreadFactory</code> fails to create a thread when asked
 by returning null from <code>newThread</code>, the executor will
 continue, but might not be able to execute any tasks. Threads
 should possess the "modifyThread" <code>RuntimePermission</code>. If
 worker threads or other threads using the pool do not possess this
 permission, service may be degraded: configuration changes may not
 take effect in a timely manner, and a shutdown pool may remain in a
 state in which termination is possible but not completed.</dd>

 <dt>Keep-alive times</dt>

 <dd>If the pool currently has more than corePoolSize threads,
 excess threads will be terminated if they have been idle for more
 than the keepAliveTime (see <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getKeepAliveTime(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)"><code>getKeepAliveTime(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)</code></a>). This
 provides a means of reducing resource consumption when the pool is
 not being actively used. If the pool becomes more active later, new
 threads will be constructed. This parameter can also be changed
 dynamically using method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setKeepAliveTime(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)"><code>setKeepAliveTime(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)</code></a>. Using a value
 of <code>Long.MAX_VALUE</code> <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html#NANOSECONDS"><code>TimeUnit.NANOSECONDS</code></a> effectively
 disables idle threads from ever terminating prior to shut down. By
 default, the keep-alive policy applies only when there are more
 than corePoolSizeThreads. But method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#allowCoreThreadTimeOut(boolean)"><code>allowCoreThreadTimeOut(boolean)</code></a> can be used to apply this
 time-out policy to core threads as well, so long as the
 keepAliveTime value is non-zero. </dd>

 <dt>Queuing</dt>

 <dd>Any <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>BlockingQueue</code></a> may be used to transfer and hold
 submitted tasks.  The use of this queue interacts with pool sizing:

 <ul>

 <li> If fewer than corePoolSize threads are running, the Executor
 always prefers adding a new thread
 rather than queuing.</li>

 <li> If corePoolSize or more threads are running, the Executor
 always prefers queuing a request rather than adding a new
 thread.</li>

 <li> If a request cannot be queued, a new thread is created unless
 this would exceed maximumPoolSize, in which case, the task will be
 rejected.</li>

 </ul>

 There are three general strategies for queuing:
 <ol>

 <li> <em> Direct handoffs.</em> A good default choice for a work
 queue is a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/SynchronousQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>SynchronousQueue</code></a> that hands off tasks to threads
 without otherwise holding them. Here, an attempt to queue a task
 will fail if no threads are immediately available to run it, so a
 new thread will be constructed. This policy avoids lockups when
 handling sets of requests that might have internal dependencies.
 Direct handoffs generally require unbounded maximumPoolSizes to
 avoid rejection of new submitted tasks. This in turn admits the
 possibility of unbounded thread growth when commands continue to
 arrive on average faster than they can be processed.  </li>

 <li><em> Unbounded queues.</em> Using an unbounded queue (for
 example a <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/LinkedBlockingQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>LinkedBlockingQueue</code></a> without a predefined
 capacity) will cause new tasks to wait in the queue when all
 corePoolSize threads are busy. Thus, no more than corePoolSize
 threads will ever be created. (And the value of the maximumPoolSize
 therefore doesn't have any effect.)  This may be appropriate when
 each task is completely independent of others, so tasks cannot
 affect each others execution; for example, in a web page server.
 While this style of queuing can be useful in smoothing out
 transient bursts of requests, it admits the possibility of
 unbounded work queue growth when commands continue to arrive on
 average faster than they can be processed.  </li>

 <li><em>Bounded queues.</em> A bounded queue (for example, an
 <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ArrayBlockingQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>ArrayBlockingQueue</code></a>) helps prevent resource exhaustion when
 used with finite maximumPoolSizes, but can be more difficult to
 tune and control.  Queue sizes and maximum pool sizes may be traded
 off for each other: Using large queues and small pools minimizes
 CPU usage, OS resources, and context-switching overhead, but can
 lead to artificially low throughput.  If tasks frequently block (for
 example if they are I/O bound), a system may be able to schedule
 time for more threads than you otherwise allow. Use of small queues
 generally requires larger pool sizes, which keeps CPUs busier but
 may encounter unacceptable scheduling overhead, which also
 decreases throughput.  </li>

 </ol>

 </dd>

 <dt>Rejected tasks</dt>

 <dd> New tasks submitted in method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#execute(java.lang.Runnable)"><code>execute(java.lang.Runnable)</code></a> will be
 <em>rejected</em> when the Executor has been shut down, and also
 when the Executor uses finite bounds for both maximum threads and
 work queue capacity, and is saturated.  In either case, the <code>execute</code> method invokes the <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html#rejectedExecution(java.lang.Runnable, edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor)"><code>RejectedExecutionHandler.rejectedExecution(java.lang.Runnable, edu.emory.mathcs.backport.java.util.concurrent.ThreadPoolExecutor)</code></a> method of its <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>RejectedExecutionHandler</code></a>.  Four predefined handler policies are
 provided:

 <ol>

 <li> In the default <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.AbortPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>ThreadPoolExecutor.AbortPolicy</code></a>, the
 handler throws a runtime <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>RejectedExecutionException</code></a> upon
 rejection. </li>

 <li> In <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.CallerRunsPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>ThreadPoolExecutor.CallerRunsPolicy</code></a>, the thread
 that invokes <code>execute</code> itself runs the task. This provides a
 simple feedback control mechanism that will slow down the rate that
 new tasks are submitted. </li>

 <li> In <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.DiscardPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>ThreadPoolExecutor.DiscardPolicy</code></a>, a task that
 cannot be executed is simply dropped.  </li>

 <li>In <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.DiscardOldestPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>ThreadPoolExecutor.DiscardOldestPolicy</code></a>, if the
 executor is not shut down, the task at the head of the work queue
 is dropped, and then execution is retried (which can fail again,
 causing this to be repeated.) </li>

 </ol>

 It is possible to define and use other kinds of <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>RejectedExecutionHandler</code></a> classes. Doing so requires some care
 especially when policies are designed to work only under particular
 capacity or queuing policies. </dd>

 <dt>Hook methods</dt>

 <dd>This class provides <code>protected</code> overridable <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#beforeExecute(java.lang.Thread, java.lang.Runnable)"><code>beforeExecute(java.lang.Thread, java.lang.Runnable)</code></a> and <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#afterExecute(java.lang.Runnable, java.lang.Throwable)"><code>afterExecute(java.lang.Runnable, java.lang.Throwable)</code></a> methods that are called
 before and after execution of each task.  These can be used to
 manipulate the execution environment; for example, reinitializing
 ThreadLocals, gathering statistics, or adding log
 entries. Additionally, method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#terminated()"><code>terminated()</code></a> can be overridden
 to perform any special processing that needs to be done once the
 Executor has fully terminated.

 <p>If hook or callback methods throw exceptions, internal worker
 threads may in turn fail and abruptly terminate.</dd>

 <dt>Queue maintenance</dt>

 <dd> Method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getQueue()"><code>getQueue()</code></a> allows access to the work queue for
 purposes of monitoring and debugging.  Use of this method for any
 other purpose is strongly discouraged.  Two supplied methods,
 <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#remove(java.lang.Runnable)"><code>remove(java.lang.Runnable)</code></a> and <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#purge()"><code>purge()</code></a> are available to assist in
 storage reclamation when large numbers of queued tasks become
 cancelled.</dd>

 <dt>Finalization</dt>

 <dd> A pool that is no longer referenced in a program <em>AND</em>
 has no remaining threads will be <code>shutdown</code> automatically. If
 you would like to ensure that unreferenced pools are reclaimed even
 if users forget to call <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#shutdown()"><code>shutdown()</code></a>, then you must arrange
 that unused threads eventually die, by setting appropriate
 keep-alive times, using a lower bound of zero core threads and/or
 setting <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#allowCoreThreadTimeOut(boolean)"><code>allowCoreThreadTimeOut(boolean)</code></a>.  </dd>

 </dl>

 <p> <b>Extension example</b>. Most extensions of this class
 override one or more of the protected hook methods. For example,
 here is a subclass that adds a simple pause/resume feature:

  <pre> <code>class PausableThreadPoolExecutor extends ThreadPoolExecutor {
   private boolean isPaused;
   private ReentrantLock pauseLock = new ReentrantLock();
   private Condition unpaused = pauseLock.newCondition();

   public PausableThreadPoolExecutor(...) { super(...); }

   protected void beforeExecute(Thread t, Runnable r) {
     super.beforeExecute(t, r);
     pauseLock.lock();
     try {
       while (isPaused) unpaused.await();
     } catch (InterruptedException ie) {
       t.interrupt();
     } finally {
       pauseLock.unlock();
     }
   }

   public void pause() {
     pauseLock.lock();
     try {
       isPaused = true;
     } finally {
       pauseLock.unlock();
     }
   }

   public void resume() {
     pauseLock.lock();
     try {
       isPaused = false;
       unpaused.signalAll();
     } finally {
       pauseLock.unlock();
     }
   }
 }</code></pre></div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>1.5</dd>
<dt><span class="strong">Author:</span></dt>
  <dd>Doug Lea</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.AbortPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ThreadPoolExecutor.AbortPolicy</a></strong></code>
<div class="block">A handler for rejected tasks that throws a
 <code>RejectedExecutionException</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.CallerRunsPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ThreadPoolExecutor.CallerRunsPolicy</a></strong></code>
<div class="block">A handler for rejected tasks that runs the rejected task
 directly in the calling thread of the <code>execute</code> method,
 unless the executor has been shut down, in which case the task
 is discarded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.DiscardOldestPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ThreadPoolExecutor.DiscardOldestPolicy</a></strong></code>
<div class="block">A handler for rejected tasks that discards the oldest unhandled
 request and then retries <code>execute</code>, unless the executor
 is shut down, in which case the task is discarded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.DiscardPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">ThreadPoolExecutor.DiscardPolicy</a></strong></code>
<div class="block">A handler for rejected tasks that silently discards the
 rejected task.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue)">ThreadPoolExecutor</a></strong>(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue)</code>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters and default thread factory and rejected execution handler.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)">ThreadPoolExecutor</a></strong>(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a>&nbsp;handler)</code>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters and default thread factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory)">ThreadPoolExecutor</a></strong>(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a>&nbsp;threadFactory)</code>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters and default rejected execution handler.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory, edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)">ThreadPoolExecutor</a></strong>(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a>&nbsp;threadFactory,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a>&nbsp;handler)</code>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#afterExecute(java.lang.Runnable, java.lang.Throwable)">afterExecute</a></strong>(java.lang.Runnable&nbsp;r,
            java.lang.Throwable&nbsp;t)</code>
<div class="block">Method invoked upon completion of execution of the given Runnable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#allowCoreThreadTimeOut(boolean)">allowCoreThreadTimeOut</a></strong>(boolean&nbsp;value)</code>
<div class="block">Sets the policy governing whether core threads may time out and
 terminate if no tasks arrive within the keep-alive time, being
 replaced if needed when new tasks arrive.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#allowsCoreThreadTimeOut()">allowsCoreThreadTimeOut</a></strong>()</code>
<div class="block">Returns true if this pool allows core threads to time out and
 terminate if no tasks arrive within the keepAlive time, being
 replaced if needed when new tasks arrive.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#awaitTermination(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">awaitTermination</a></strong>(long&nbsp;timeout,
                <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Blocks until all tasks have completed execution after a shutdown
 request, or the timeout occurs, or the current thread is
 interrupted, whichever happens first.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#beforeExecute(java.lang.Thread, java.lang.Runnable)">beforeExecute</a></strong>(java.lang.Thread&nbsp;t,
             java.lang.Runnable&nbsp;r)</code>
<div class="block">Method invoked prior to executing the given Runnable in the
 given thread.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#execute(java.lang.Runnable)">execute</a></strong>(java.lang.Runnable&nbsp;command)</code>
<div class="block">Executes the given task sometime in the future.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#finalize()">finalize</a></strong>()</code>
<div class="block">Invokes <code>shutdown</code> when this executor is no longer
 referenced and it has no threads.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getActiveCount()">getActiveCount</a></strong>()</code>
<div class="block">Returns the approximate number of threads that are actively
 executing tasks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getCompletedTaskCount()">getCompletedTaskCount</a></strong>()</code>
<div class="block">Returns the approximate total number of tasks that have
 completed execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getCorePoolSize()">getCorePoolSize</a></strong>()</code>
<div class="block">Returns the core number of threads.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getKeepAliveTime(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">getKeepAliveTime</a></strong>(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Returns the thread keep-alive time, which is the amount of time
 that threads in excess of the core pool size may remain
 idle before being terminated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getLargestPoolSize()">getLargestPoolSize</a></strong>()</code>
<div class="block">Returns the largest number of threads that have ever
 simultaneously been in the pool.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getMaximumPoolSize()">getMaximumPoolSize</a></strong>()</code>
<div class="block">Returns the maximum allowed number of threads.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getPoolSize()">getPoolSize</a></strong>()</code>
<div class="block">Returns the current number of threads in the pool.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getQueue()">getQueue</a></strong>()</code>
<div class="block">Returns the task queue used by this executor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getRejectedExecutionHandler()">getRejectedExecutionHandler</a></strong>()</code>
<div class="block">Returns the current handler for unexecutable tasks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getTaskCount()">getTaskCount</a></strong>()</code>
<div class="block">Returns the approximate total number of tasks that have ever been
 scheduled for execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getThreadFactory()">getThreadFactory</a></strong>()</code>
<div class="block">Returns the thread factory used to create new threads.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#isShutdown()">isShutdown</a></strong>()</code>
<div class="block">Returns <tt>true</tt> if this executor has been shut down.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#isTerminated()">isTerminated</a></strong>()</code>
<div class="block">Returns <tt>true</tt> if all tasks have completed following shut down.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#isTerminating()">isTerminating</a></strong>()</code>
<div class="block">Returns true if this executor is in the process of terminating
 after <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#shutdown()"><code>shutdown()</code></a> or <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#shutdownNow()"><code>shutdownNow()</code></a> but has not
 completely terminated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#prestartAllCoreThreads()">prestartAllCoreThreads</a></strong>()</code>
<div class="block">Starts all core threads, causing them to idly wait for work.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#prestartCoreThread()">prestartCoreThread</a></strong>()</code>
<div class="block">Starts a core thread, causing it to idly wait for work.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#purge()">purge</a></strong>()</code>
<div class="block">Tries to remove from the work queue all <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>Future</code></a>
 tasks that have been cancelled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#remove(java.lang.Runnable)">remove</a></strong>(java.lang.Runnable&nbsp;task)</code>
<div class="block">Removes this task from the executor's internal queue if it is
 present, thus causing it not to be run if it has not already
 started.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setCorePoolSize(int)">setCorePoolSize</a></strong>(int&nbsp;corePoolSize)</code>
<div class="block">Sets the core number of threads.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setKeepAliveTime(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">setKeepAliveTime</a></strong>(long&nbsp;time,
                <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Sets the time limit for which threads may remain idle before
 being terminated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setMaximumPoolSize(int)">setMaximumPoolSize</a></strong>(int&nbsp;maximumPoolSize)</code>
<div class="block">Sets the maximum allowed number of threads.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setRejectedExecutionHandler(edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)">setRejectedExecutionHandler</a></strong>(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a>&nbsp;handler)</code>
<div class="block">Sets a new handler for unexecutable tasks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setThreadFactory(edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory)">setThreadFactory</a></strong>(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a>&nbsp;threadFactory)</code>
<div class="block">Sets the thread factory used to create new threads.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#shutdown()">shutdown</a></strong>()</code>
<div class="block">Initiates an orderly shutdown in which previously submitted
 tasks are executed, but no new tasks will be accepted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#shutdownNow()">shutdownNow</a></strong>()</code>
<div class="block">Attempts to stop all actively executing tasks, halts the
 processing of waiting tasks, and returns a list of the tasks
 that were awaiting execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#terminated()">terminated</a></strong>()</code>
<div class="block">Method invoked when the Executor has terminated.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_edu.emory.mathcs.backport.java.util.concurrent.AbstractExecutorService">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;edu.emory.mathcs.backport.java.util.concurrent.<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">AbstractExecutorService</a></h3>
<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#invokeAll(java.util.Collection)">invokeAll</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#invokeAll(java.util.Collection, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">invokeAll</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#invokeAny(java.util.Collection)">invokeAny</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#invokeAny(java.util.Collection, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">invokeAny</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#newTaskFor(edu.emory.mathcs.backport.java.util.concurrent.Callable)">newTaskFor</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#newTaskFor(java.lang.Runnable, java.lang.Object)">newTaskFor</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#submit(edu.emory.mathcs.backport.java.util.concurrent.Callable)">submit</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#submit(java.lang.Runnable)">submit</a>, <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/AbstractExecutorService.html#submit(java.lang.Runnable, java.lang.Object)">submit</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ThreadPoolExecutor</h4>
<pre>public&nbsp;ThreadPoolExecutor(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue)</pre>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters and default thread factory and rejected execution handler.
 It may be more convenient to use one of the <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>Executors</code></a> factory
 methods instead of this general purpose constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>corePoolSize</code> - the number of threads to keep in the pool, even
        if they are idle, unless <code>allowCoreThreadTimeOut</code> is set</dd><dd><code>maximumPoolSize</code> - the maximum number of threads to allow in the
        pool</dd><dd><code>keepAliveTime</code> - when the number of threads is greater than
        the core, this is the maximum time that excess idle threads
        will wait for new tasks before terminating.</dd><dd><code>unit</code> - the time unit for the <code>keepAliveTime</code> argument</dd><dd><code>workQueue</code> - the queue to use for holding tasks before they are
        executed.  This queue will hold only the <code>Runnable</code>
        tasks submitted by the <code>execute</code> method.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if one of the following holds:<br>
         <code>corePoolSize &lt; 0</code><br>
         <code>keepAliveTime &lt; 0</code><br>
         <code>maximumPoolSize &lt;= 0</code><br>
         <code>maximumPoolSize &lt; corePoolSize</code></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>workQueue</code> is null</dd></dl>
</li>
</ul>
<a name="ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ThreadPoolExecutor</h4>
<pre>public&nbsp;ThreadPoolExecutor(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a>&nbsp;threadFactory)</pre>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters and default rejected execution handler.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>corePoolSize</code> - the number of threads to keep in the pool, even
        if they are idle, unless <code>allowCoreThreadTimeOut</code> is set</dd><dd><code>maximumPoolSize</code> - the maximum number of threads to allow in the
        pool</dd><dd><code>keepAliveTime</code> - when the number of threads is greater than
        the core, this is the maximum time that excess idle threads
        will wait for new tasks before terminating.</dd><dd><code>unit</code> - the time unit for the <code>keepAliveTime</code> argument</dd><dd><code>workQueue</code> - the queue to use for holding tasks before they are
        executed.  This queue will hold only the <code>Runnable</code>
        tasks submitted by the <code>execute</code> method.</dd><dd><code>threadFactory</code> - the factory to use when the executor
        creates a new thread</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if one of the following holds:<br>
         <code>corePoolSize &lt; 0</code><br>
         <code>keepAliveTime &lt; 0</code><br>
         <code>maximumPoolSize &lt;= 0</code><br>
         <code>maximumPoolSize &lt; corePoolSize</code></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>workQueue</code>
         or <code>threadFactory</code> is null</dd></dl>
</li>
</ul>
<a name="ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ThreadPoolExecutor</h4>
<pre>public&nbsp;ThreadPoolExecutor(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a>&nbsp;handler)</pre>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters and default thread factory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>corePoolSize</code> - the number of threads to keep in the pool, even
        if they are idle, unless <code>allowCoreThreadTimeOut</code> is set</dd><dd><code>maximumPoolSize</code> - the maximum number of threads to allow in the
        pool</dd><dd><code>keepAliveTime</code> - when the number of threads is greater than
        the core, this is the maximum time that excess idle threads
        will wait for new tasks before terminating.</dd><dd><code>unit</code> - the time unit for the <code>keepAliveTime</code> argument</dd><dd><code>workQueue</code> - the queue to use for holding tasks before they are
        executed.  This queue will hold only the <code>Runnable</code>
        tasks submitted by the <code>execute</code> method.</dd><dd><code>handler</code> - the handler to use when execution is blocked
        because the thread bounds and queue capacities are reached</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if one of the following holds:<br>
         <code>corePoolSize &lt; 0</code><br>
         <code>keepAliveTime &lt; 0</code><br>
         <code>maximumPoolSize &lt;= 0</code><br>
         <code>maximumPoolSize &lt; corePoolSize</code></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>workQueue</code>
         or <code>handler</code> is null</dd></dl>
</li>
</ul>
<a name="ThreadPoolExecutor(int, int, long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue, edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory, edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ThreadPoolExecutor</h4>
<pre>public&nbsp;ThreadPoolExecutor(int&nbsp;corePoolSize,
                  int&nbsp;maximumPoolSize,
                  long&nbsp;keepAliveTime,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;workQueue,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a>&nbsp;threadFactory,
                  <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a>&nbsp;handler)</pre>
<div class="block">Creates a new <code>ThreadPoolExecutor</code> with the given initial
 parameters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>corePoolSize</code> - the number of threads to keep in the pool, even
        if they are idle, unless <code>allowCoreThreadTimeOut</code> is set</dd><dd><code>maximumPoolSize</code> - the maximum number of threads to allow in the
        pool</dd><dd><code>keepAliveTime</code> - when the number of threads is greater than
        the core, this is the maximum time that excess idle threads
        will wait for new tasks before terminating.</dd><dd><code>unit</code> - the time unit for the <code>keepAliveTime</code> argument</dd><dd><code>workQueue</code> - the queue to use for holding tasks before they are
        executed.  This queue will hold only the <code>Runnable</code>
        tasks submitted by the <code>execute</code> method.</dd><dd><code>threadFactory</code> - the factory to use when the executor
        creates a new thread</dd><dd><code>handler</code> - the handler to use when execution is blocked
        because the thread bounds and queue capacities are reached</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if one of the following holds:<br>
         <code>corePoolSize &lt; 0</code><br>
         <code>keepAliveTime &lt; 0</code><br>
         <code>maximumPoolSize &lt;= 0</code><br>
         <code>maximumPoolSize &lt; corePoolSize</code></dd>
<dd><code>java.lang.NullPointerException</code> - if <code>workQueue</code>
         or <code>threadFactory</code> or <code>handler</code> is null</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="execute(java.lang.Runnable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;execute(java.lang.Runnable&nbsp;command)</pre>
<div class="block">Executes the given task sometime in the future.  The task
 may execute in a new thread or in an existing pooled thread.

 If the task cannot be submitted for execution, either because this
 executor has been shutdown or because its capacity has been reached,
 the task is handled by the current <code>RejectedExecutionHandler</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - the task to execute</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionException.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionException</a></code> - at discretion of
         <code>RejectedExecutionHandler</code>, if the task
         cannot be accepted for execution</dd>
<dd><code>java.lang.NullPointerException</code> - if <code>command</code> is null</dd></dl>
</li>
</ul>
<a name="shutdown()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdown</h4>
<pre>public&nbsp;void&nbsp;shutdown()</pre>
<div class="block">Initiates an orderly shutdown in which previously submitted
 tasks are executed, but no new tasks will be accepted.
 Invocation has no additional effect if already shut down.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - if a security manager exists and
         shutting down this ExecutorService may manipulate
         threads that the caller is not permitted to modify
         because it does not hold <code>RuntimePermission</code><tt>("modifyThread")</tt>,
         or the security manager's <tt>checkAccess</tt> method
         denies access.</dd></dl>
</li>
</ul>
<a name="shutdownNow()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdownNow</h4>
<pre>public&nbsp;java.util.List&nbsp;shutdownNow()</pre>
<div class="block">Attempts to stop all actively executing tasks, halts the
 processing of waiting tasks, and returns a list of the tasks
 that were awaiting execution. These tasks are drained (removed)
 from the task queue upon return from this method.

 <p>There are no guarantees beyond best-effort attempts to stop
 processing actively executing tasks.  This implementation
 cancels tasks via <code>Thread.interrupt()</code>, so any task that
 fails to respond to interrupts may never terminate.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>list of tasks that never commenced execution</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.SecurityException</code> - if a security manager exists and
         shutting down this ExecutorService may manipulate
         threads that the caller is not permitted to modify
         because it does not hold <code>RuntimePermission</code><tt>("modifyThread")</tt>,
         or the security manager's <tt>checkAccess</tt> method
         denies access.</dd></dl>
</li>
</ul>
<a name="isShutdown()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShutdown</h4>
<pre>public&nbsp;boolean&nbsp;isShutdown()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorService.html#isShutdown()">ExecutorService</a></code></strong></div>
<div class="block">Returns <tt>true</tt> if this executor has been shut down.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this executor has been shut down</dd></dl>
</li>
</ul>
<a name="isTerminating()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTerminating</h4>
<pre>public&nbsp;boolean&nbsp;isTerminating()</pre>
<div class="block">Returns true if this executor is in the process of terminating
 after <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#shutdown()"><code>shutdown()</code></a> or <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#shutdownNow()"><code>shutdownNow()</code></a> but has not
 completely terminated.  This method may be useful for
 debugging. A return of <code>true</code> reported a sufficient
 period after shutdown may indicate that submitted tasks have
 ignored or suppressed interruption, causing this executor not
 to properly terminate.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if terminating but not yet terminated</dd></dl>
</li>
</ul>
<a name="isTerminated()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTerminated</h4>
<pre>public&nbsp;boolean&nbsp;isTerminated()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorService.html#isTerminated()">ExecutorService</a></code></strong></div>
<div class="block">Returns <tt>true</tt> if all tasks have completed following shut down.
 Note that <tt>isTerminated</tt> is never <tt>true</tt> unless
 either <tt>shutdown</tt> or <tt>shutdownNow</tt> was called first.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if all tasks have completed following shut down</dd></dl>
</li>
</ul>
<a name="awaitTermination(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awaitTermination</h4>
<pre>public&nbsp;boolean&nbsp;awaitTermination(long&nbsp;timeout,
                       <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)
                         throws java.lang.InterruptedException</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorService.html#awaitTermination(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">ExecutorService</a></code></strong></div>
<div class="block">Blocks until all tasks have completed execution after a shutdown
 request, or the timeout occurs, or the current thread is
 interrupted, whichever happens first.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - the maximum time to wait</dd><dd><code>unit</code> - the time unit of the timeout argument</dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this executor terminated and
         <tt>false</tt> if the timeout elapsed before termination</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if interrupted while waiting</dd></dl>
</li>
</ul>
<a name="finalize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finalize</h4>
<pre>protected&nbsp;void&nbsp;finalize()</pre>
<div class="block">Invokes <code>shutdown</code> when this executor is no longer
 referenced and it has no threads.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>finalize</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="setThreadFactory(edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThreadFactory</h4>
<pre>public&nbsp;void&nbsp;setThreadFactory(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a>&nbsp;threadFactory)</pre>
<div class="block">Sets the thread factory used to create new threads.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>threadFactory</code> - the new thread factory</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if threadFactory is null</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getThreadFactory()"><code>getThreadFactory()</code></a></dd></dl>
</li>
</ul>
<a name="getThreadFactory()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreadFactory</h4>
<pre>public&nbsp;<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">ThreadFactory</a>&nbsp;getThreadFactory()</pre>
<div class="block">Returns the thread factory used to create new threads.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current thread factory</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setThreadFactory(edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory)"><code>setThreadFactory(edu.emory.mathcs.backport.java.util.concurrent.ThreadFactory)</code></a></dd></dl>
</li>
</ul>
<a name="setRejectedExecutionHandler(edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRejectedExecutionHandler</h4>
<pre>public&nbsp;void&nbsp;setRejectedExecutionHandler(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a>&nbsp;handler)</pre>
<div class="block">Sets a new handler for unexecutable tasks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - the new handler</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if handler is null</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getRejectedExecutionHandler()"><code>getRejectedExecutionHandler()</code></a></dd></dl>
</li>
</ul>
<a name="getRejectedExecutionHandler()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRejectedExecutionHandler</h4>
<pre>public&nbsp;<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/RejectedExecutionHandler.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">RejectedExecutionHandler</a>&nbsp;getRejectedExecutionHandler()</pre>
<div class="block">Returns the current handler for unexecutable tasks.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current handler</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setRejectedExecutionHandler(edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)"><code>setRejectedExecutionHandler(edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionHandler)</code></a></dd></dl>
</li>
</ul>
<a name="setCorePoolSize(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCorePoolSize</h4>
<pre>public&nbsp;void&nbsp;setCorePoolSize(int&nbsp;corePoolSize)</pre>
<div class="block">Sets the core number of threads.  This overrides any value set
 in the constructor.  If the new value is smaller than the
 current value, excess existing threads will be terminated when
 they next become idle.  If larger, new threads will, if needed,
 be started to execute any queued tasks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>corePoolSize</code> - the new core size</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>corePoolSize &lt; 0</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getCorePoolSize()"><code>getCorePoolSize()</code></a></dd></dl>
</li>
</ul>
<a name="getCorePoolSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCorePoolSize</h4>
<pre>public&nbsp;int&nbsp;getCorePoolSize()</pre>
<div class="block">Returns the core number of threads.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the core number of threads</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setCorePoolSize(int)"><code>setCorePoolSize(int)</code></a></dd></dl>
</li>
</ul>
<a name="prestartCoreThread()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prestartCoreThread</h4>
<pre>public&nbsp;boolean&nbsp;prestartCoreThread()</pre>
<div class="block">Starts a core thread, causing it to idly wait for work. This
 overrides the default policy of starting core threads only when
 new tasks are executed. This method will return <code>false</code>
 if all core threads have already been started.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if a thread was started</dd></dl>
</li>
</ul>
<a name="prestartAllCoreThreads()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prestartAllCoreThreads</h4>
<pre>public&nbsp;int&nbsp;prestartAllCoreThreads()</pre>
<div class="block">Starts all core threads, causing them to idly wait for work. This
 overrides the default policy of starting core threads only when
 new tasks are executed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of threads started</dd></dl>
</li>
</ul>
<a name="allowsCoreThreadTimeOut()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowsCoreThreadTimeOut</h4>
<pre>public&nbsp;boolean&nbsp;allowsCoreThreadTimeOut()</pre>
<div class="block">Returns true if this pool allows core threads to time out and
 terminate if no tasks arrive within the keepAlive time, being
 replaced if needed when new tasks arrive. When true, the same
 keep-alive policy applying to non-core threads applies also to
 core threads. When false (the default), core threads are never
 terminated due to lack of incoming tasks.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if core threads are allowed to time out,
         else <code>false</code></dd><dt><span class="strong">Since:</span></dt>
  <dd>1.6</dd></dl>
</li>
</ul>
<a name="allowCoreThreadTimeOut(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowCoreThreadTimeOut</h4>
<pre>public&nbsp;void&nbsp;allowCoreThreadTimeOut(boolean&nbsp;value)</pre>
<div class="block">Sets the policy governing whether core threads may time out and
 terminate if no tasks arrive within the keep-alive time, being
 replaced if needed when new tasks arrive. When false, core
 threads are never terminated due to lack of incoming
 tasks. When true, the same keep-alive policy applying to
 non-core threads applies also to core threads. To avoid
 continual thread replacement, the keep-alive time must be
 greater than zero when setting <code>true</code>. This method
 should in general be called before the pool is actively used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - <code>true</code> if should time out, else <code>false</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if value is <code>true</code>
         and the current keep-alive time is not greater than zero</dd><dt><span class="strong">Since:</span></dt>
  <dd>1.6</dd></dl>
</li>
</ul>
<a name="setMaximumPoolSize(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaximumPoolSize</h4>
<pre>public&nbsp;void&nbsp;setMaximumPoolSize(int&nbsp;maximumPoolSize)</pre>
<div class="block">Sets the maximum allowed number of threads. This overrides any
 value set in the constructor. If the new value is smaller than
 the current value, excess existing threads will be
 terminated when they next become idle.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maximumPoolSize</code> - the new maximum</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the new maximum is
         less than or equal to zero, or
         less than the <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getCorePoolSize()">core pool size</a></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getMaximumPoolSize()"><code>getMaximumPoolSize()</code></a></dd></dl>
</li>
</ul>
<a name="getMaximumPoolSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumPoolSize</h4>
<pre>public&nbsp;int&nbsp;getMaximumPoolSize()</pre>
<div class="block">Returns the maximum allowed number of threads.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the maximum allowed number of threads</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setMaximumPoolSize(int)"><code>setMaximumPoolSize(int)</code></a></dd></dl>
</li>
</ul>
<a name="setKeepAliveTime(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeepAliveTime</h4>
<pre>public&nbsp;void&nbsp;setKeepAliveTime(long&nbsp;time,
                    <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>
<div class="block">Sets the time limit for which threads may remain idle before
 being terminated.  If there are more than the core number of
 threads currently in the pool, after waiting this amount of
 time without processing a task, excess threads will be
 terminated.  This overrides any value set in the constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - the time to wait.  A time value of zero will cause
        excess threads to terminate immediately after executing tasks.</dd><dd><code>unit</code> - the time unit of the <code>time</code> argument</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>time</code> less than zero or
         if <code>time</code> is zero and <code>allowsCoreThreadTimeOut</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#getKeepAliveTime(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)"><code>getKeepAliveTime(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)</code></a></dd></dl>
</li>
</ul>
<a name="getKeepAliveTime(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeepAliveTime</h4>
<pre>public&nbsp;long&nbsp;getKeepAliveTime(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>
<div class="block">Returns the thread keep-alive time, which is the amount of time
 that threads in excess of the core pool size may remain
 idle before being terminated.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>unit</code> - the desired time unit of the result</dd>
<dt><span class="strong">Returns:</span></dt><dd>the time limit</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#setKeepAliveTime(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)"><code>setKeepAliveTime(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)</code></a></dd></dl>
</li>
</ul>
<a name="getQueue()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueue</h4>
<pre>public&nbsp;<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a>&nbsp;getQueue()</pre>
<div class="block">Returns the task queue used by this executor. Access to the
 task queue is intended primarily for debugging and monitoring.
 This queue may be in active use.  Retrieving the task queue
 does not prevent queued tasks from executing.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the task queue</dd></dl>
</li>
</ul>
<a name="remove(java.lang.Runnable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;boolean&nbsp;remove(java.lang.Runnable&nbsp;task)</pre>
<div class="block">Removes this task from the executor's internal queue if it is
 present, thus causing it not to be run if it has not already
 started.

 <p> This method may be useful as one part of a cancellation
 scheme.  It may fail to remove tasks that have been converted
 into other forms before being placed on the internal queue. For
 example, a task entered using <code>submit</code> might be
 converted into a form that maintains <code>Future</code> status.
 However, in such cases, method <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html#purge()"><code>purge()</code></a> may be used to
 remove those Futures that have been cancelled.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - the task to remove</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the task was removed</dd></dl>
</li>
</ul>
<a name="purge()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>purge</h4>
<pre>public&nbsp;void&nbsp;purge()</pre>
<div class="block">Tries to remove from the work queue all <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>Future</code></a>
 tasks that have been cancelled. This method can be useful as a
 storage reclamation operation, that has no other impact on
 functionality. Cancelled tasks are never executed, but may
 accumulate in work queues until worker threads can actively
 remove them. Invoking this method instead tries to remove them now.
 However, this method may fail to remove tasks in
 the presence of interference by other threads.</div>
</li>
</ul>
<a name="getPoolSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPoolSize</h4>
<pre>public&nbsp;int&nbsp;getPoolSize()</pre>
<div class="block">Returns the current number of threads in the pool.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of threads</dd></dl>
</li>
</ul>
<a name="getActiveCount()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveCount</h4>
<pre>public&nbsp;int&nbsp;getActiveCount()</pre>
<div class="block">Returns the approximate number of threads that are actively
 executing tasks.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of threads</dd></dl>
</li>
</ul>
<a name="getLargestPoolSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLargestPoolSize</h4>
<pre>public&nbsp;int&nbsp;getLargestPoolSize()</pre>
<div class="block">Returns the largest number of threads that have ever
 simultaneously been in the pool.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of threads</dd></dl>
</li>
</ul>
<a name="getTaskCount()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTaskCount</h4>
<pre>public&nbsp;long&nbsp;getTaskCount()</pre>
<div class="block">Returns the approximate total number of tasks that have ever been
 scheduled for execution. Because the states of tasks and
 threads may change dynamically during computation, the returned
 value is only an approximation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of tasks</dd></dl>
</li>
</ul>
<a name="getCompletedTaskCount()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletedTaskCount</h4>
<pre>public&nbsp;long&nbsp;getCompletedTaskCount()</pre>
<div class="block">Returns the approximate total number of tasks that have
 completed execution. Because the states of tasks and threads
 may change dynamically during computation, the returned value
 is only an approximation, but one that does not ever decrease
 across successive calls.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of tasks</dd></dl>
</li>
</ul>
<a name="beforeExecute(java.lang.Thread, java.lang.Runnable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeExecute</h4>
<pre>protected&nbsp;void&nbsp;beforeExecute(java.lang.Thread&nbsp;t,
                 java.lang.Runnable&nbsp;r)</pre>
<div class="block">Method invoked prior to executing the given Runnable in the
 given thread.  This method is invoked by thread <code>t</code> that
 will execute task <code>r</code>, and may be used to re-initialize
 ThreadLocals, or to perform logging.

 <p>This implementation does nothing, but may be customized in
 subclasses. Note: To properly nest multiple overridings, subclasses
 should generally invoke <code>super.beforeExecute</code> at the end of
 this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - the thread that will run task <code>r</code></dd><dd><code>r</code> - the task that will be executed</dd></dl>
</li>
</ul>
<a name="afterExecute(java.lang.Runnable, java.lang.Throwable)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterExecute</h4>
<pre>protected&nbsp;void&nbsp;afterExecute(java.lang.Runnable&nbsp;r,
                java.lang.Throwable&nbsp;t)</pre>
<div class="block">Method invoked upon completion of execution of the given Runnable.
 This method is invoked by the thread that executed the task. If
 non-null, the Throwable is the uncaught <code>RuntimeException</code>
 or <code>Error</code> that caused execution to terminate abruptly.

 <p>This implementation does nothing, but may be customized in
 subclasses. Note: To properly nest multiple overridings, subclasses
 should generally invoke <code>super.afterExecute</code> at the
 beginning of this method.

 <p><b>Note:</b> When actions are enclosed in tasks (such as
 <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/FutureTask.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>FutureTask</code></a>) either explicitly or via methods such as
 <code>submit</code>, these task objects catch and maintain
 computational exceptions, and so they do not cause abrupt
 termination, and the internal exceptions are <em>not</em>
 passed to this method. If you would like to trap both kinds of
 failures in this method, you can further probe for such cases,
 as in this sample subclass that prints either the direct cause
 or the underlying exception if a task has been aborted:

  <pre> <code>class ExtendedExecutor extends ThreadPoolExecutor {
   // ...
   protected void afterExecute(Runnable r, Throwable t) {
     super.afterExecute(r, t);
     if (t == null &amp;&amp; r instanceof Future&lt;?&gt;) {
       try {
         Object result = ((Future&lt;?&gt;) r).get();
       } catch (CancellationException ce) {
           t = ce;
       } catch (ExecutionException ee) {
           t = ee.getCause();
       } catch (InterruptedException ie) {
           Thread.currentThread().interrupt(); // ignore/reset
       }
     }
     if (t != null)
       System.out.println(t);
   }
 }</code></pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>r</code> - the runnable that has completed</dd><dd><code>t</code> - the exception that caused termination, or null if
 execution completed normally</dd></dl>
</li>
</ul>
<a name="terminated()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>terminated</h4>
<pre>protected&nbsp;void&nbsp;terminated()</pre>
<div class="block">Method invoked when the Executor has terminated.  Default
 implementation does nothing. Note: To properly nest multiple
 overridings, subclasses should generally invoke
 <code>super.terminated</code> within this method.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadFactory.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.AbortPolicy.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/ThreadPoolExecutor.html" target="_top">Frames</a></li>
<li><a href="ThreadPoolExecutor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>