/usr/share/doc/libcommons-pool-java/api/org/apache/commons/pool/impl/GenericKeyedObjectPool.html is in libcommons-pool-java-doc 1.6-3.
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 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>GenericKeyedObjectPool (Apache Commons Object Pooling Package)</title>
<meta name="date" content="2016-07-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GenericKeyedObjectPool (Apache Commons Object Pooling Package)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/pool/impl/GenericKeyedObjectPool.html" target="_top">Frames</a></li>
<li><a href="GenericKeyedObjectPool.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: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </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">org.apache.commons.pool.impl</div>
<h2 title="Class GenericKeyedObjectPool" class="title">Class GenericKeyedObjectPool<K,V></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">org.apache.commons.pool.BaseKeyedObjectPool</a><K,V></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.pool.impl.GenericKeyedObjectPool<K,V></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the type of keys in this pool</dd>
<dd><code>V</code> - the type of objects held in this pool</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><K,V></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">GenericKeyedObjectPool<K,V></span>
extends <a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><K,V>
implements <a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><K,V></pre>
<div class="block">A configurable <code>KeyedObjectPool</code> implementation.
<p>
When coupled with the appropriate <a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>KeyedPoolableObjectFactory</code></a>,
<code>GenericKeyedObjectPool</code> provides robust pooling functionality for
keyed objects. A <code>GenericKeyedObjectPool</code> can be viewed as a map
of pools, keyed on the (unique) key values provided to the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#preparePool-K-boolean-"><code>preparePool</code></a>, <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#addObject-K-"><code>addObject</code></a> or
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> methods. Each time a new key value is
provided to one of these methods, a new pool is created under the given key
to be managed by the containing <code>GenericKeyedObjectPool.</code>
</p>
<p>A <code>GenericKeyedObjectPool</code> provides a number of configurable
parameters:</p>
<ul>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>maxActive</code></a> controls the maximum number of objects
(per key) that can allocated by the pool (checked out to client threads,
or idle in the pool) at one time. When non-positive, there is no limit
to the number of objects per key. When <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>maxActive</code></a> is
reached, the keyed pool is said to be exhausted. The default setting for
this parameter is 8.
</li>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-"><code>maxTotal</code></a> sets a global limit on the number of objects
that can be in circulation (active or idle) within the combined set of
pools. When non-positive, there is no limit to the total number of
objects in circulation. When <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-"><code>maxTotal</code></a> is exceeded,
all keyed pools are exhausted. When <code>maxTotal</code> is set to a
positive value and <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> is invoked
when at the limit with no idle instances available, an attempt is made to
create room by clearing the oldest 15% of the elements from the keyed
pools. The default setting for this parameter is -1 (no limit).
</li>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>maxIdle</code></a> controls the maximum number of objects that can
sit idle in the pool (per key) at any time. When negative, there
is no limit to the number of objects that may be idle per key. The
default setting for this parameter is 8.
</li>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>whenExhaustedAction</code></a> specifies the
behavior of the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> method when a keyed
pool is exhausted:
<ul>
<li>
When <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>whenExhaustedAction</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL"><code>WHEN_EXHAUSTED_FAIL</code></a>, <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> will throw
a <a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util"><code>NoSuchElementException</code></a>
</li>
<li>
When <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>whenExhaustedAction</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a>, <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> will create a new
object and return it (essentially making <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>maxActive</code></a>
meaningless.)
</li>
<li>
When <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>whenExhaustedAction</code></a>
is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>, <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> will block
(invoke <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang"><code>wait</code></a> until a new or idle object is available.
If a positive <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>maxWait</code></a>
value is supplied, the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> will block for at
most that many milliseconds, after which a <a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util"><code>NoSuchElementException</code></a>
will be thrown. If <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>maxWait</code></a> is non-positive,
the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> method will block indefinitely.
</li>
</ul>
The default <code>whenExhaustedAction</code> setting is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>.
</li>
<li>
When <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>testOnBorrow</code></a> is set, the pool will
attempt to validate each object before it is returned from the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> method. (Using the provided factory's
<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#validateObject-K-V-"><code>validateObject</code></a> method.)
Objects that fail to validate will be dropped from the pool, and a
different object will be borrowed. The default setting for this parameter
is <code>false.</code>
</li>
<li>
When <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>testOnReturn</code></a> is set, the pool will
attempt to validate each object before it is returned to the pool in the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject</code></a> method. (Using the provided factory's
<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#validateObject-K-V-"><code>validateObject</code></a>
method.) Objects that fail to validate will be dropped from the pool.
The default setting for this parameter is <code>false.</code>
</li>
</ul>
<p>
Optionally, one may configure the pool to examine and possibly evict objects
as they sit idle in the pool and to ensure that a minimum number of idle
objects is maintained for each key. This is performed by an
"idle object eviction" thread, which runs asynchronously. Caution should be
used when configuring this optional feature. Eviction runs contend with client
threads for access to objects in the pool, so if they run too frequently
performance issues may result. The idle object eviction thread may be
configured using the following attributes:
<ul>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>timeBetweenEvictionRunsMillis</code></a>
indicates how long the eviction thread should sleep before "runs" of examining
idle objects. When non-positive, no eviction thread will be launched. The
default setting for this parameter is -1 (i.e., by default, idle object
eviction is disabled).
</li>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-"><code>minEvictableIdleTimeMillis</code></a>
specifies the minimum amount of time that an object may sit idle in the
pool before it is eligible for eviction due to idle time. When
non-positive, no object will be dropped from the pool due to idle time
alone. This setting has no effect unless
<code>timeBetweenEvictionRunsMillis > 0.</code> The default setting
for this parameter is 30 minutes.
</li>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-"><code>testWhileIdle</code></a> indicates whether or not idle
objects should be validated using the factory's
<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#validateObject-K-V-"><code>validateObject</code></a> method
during idle object eviction runs. Objects that fail to validate will be
dropped from the pool. This setting has no effect unless
<code>timeBetweenEvictionRunsMillis > 0.</code> The default setting
for this parameter is <code>false.</code>
</li>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinIdle-int-"><code>minIdle</code></a> sets a target value for the minimum number of
idle objects (per key) that should always be available. If this parameter
is set to a positive number and
<code>timeBetweenEvictionRunsMillis > 0,</code> each time the idle object
eviction thread runs, it will try to create enough idle instances so that
there will be <code>minIdle</code> idle instances available under each
key. This parameter is also used by <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#preparePool-K-boolean-"><code>preparePool</code></a>
if <code>true</code> is provided as that method's
<code>populateImmediately</code> parameter. The default setting for this
parameter is 0.
</li>
</ul>
<p>
The pools can be configured to behave as LIFO queues with respect to idle
objects - always returning the most recently used object from the pool,
or as FIFO queues, where borrowObject always returns the oldest object
in the idle object pool.
<ul>
<li>
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setLifo-boolean-"><code><i>Lifo</i></code></a>
determines whether or not the pools return idle objects in
last-in-first-out order. The default setting for this parameter is
<code>true.</code>
</li>
</ul>
<p>
GenericKeyedObjectPool is not usable without a <a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>KeyedPoolableObjectFactory</code></a>. A
non-<code>null</code> factory must be provided either as a constructor argument
or via a call to <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setFactory-org.apache.commons.pool.KeyedPoolableObjectFactory-"><code>setFactory</code></a> before the pool is used.
</p>
<p>
Implementation note: To prevent possible deadlocks, care has been taken to
ensure that no call to a factory method will occur within a synchronization
block. See POOL-125 and DBCP-44 for more information.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.0</dd>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Revision: 1222396 $ $Date: 2011-12-22 14:02:25 -0500 (Thu, 22 Dec 2011) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Rodney Waldhoff, Dirk Verbeeck, Sandy McArthur</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericObjectPool.html" title="class in org.apache.commons.pool.impl"><code>GenericObjectPool</code></a></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="memberSummary" 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"> </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 </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl">GenericKeyedObjectPool.Config</a></span></code>
<div class="block">A simple "struct" encapsulating the
configuration information for a <code>GenericKeyedObjectPool</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_LIFO">DEFAULT_LIFO</a></span></code>
<div class="block">The default LIFO status.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_MAX_ACTIVE">DEFAULT_MAX_ACTIVE</a></span></code>
<div class="block">The default cap on the total number of active instances (per key)
from the pool.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_MAX_IDLE">DEFAULT_MAX_IDLE</a></span></code>
<div class="block">The default cap on the number of idle instances (per key) in the pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_MAX_TOTAL">DEFAULT_MAX_TOTAL</a></span></code>
<div class="block">The default cap on the the overall maximum number of objects that can
exist at one time.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_MAX_WAIT">DEFAULT_MAX_WAIT</a></span></code>
<div class="block">The default maximum amount of time (in milliseconds) the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method should block before throwing
an exception when the pool is exhausted and the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getWhenExhaustedAction--"><code>"when exhausted" action</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS">DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS</a></span></code>
<div class="block">The default value for <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinEvictableIdleTimeMillis--"><code>getMinEvictableIdleTimeMillis()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_MIN_IDLE">DEFAULT_MIN_IDLE</a></span></code>
<div class="block">The default minimum level of idle objects in the pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_NUM_TESTS_PER_EVICTION_RUN">DEFAULT_NUM_TESTS_PER_EVICTION_RUN</a></span></code>
<div class="block">The default number of objects to examine per run in the
idle object evictor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_TEST_ON_BORROW">DEFAULT_TEST_ON_BORROW</a></span></code>
<div class="block">The default "test on borrow" value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_TEST_ON_RETURN">DEFAULT_TEST_ON_RETURN</a></span></code>
<div class="block">The default "test on return" value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_TEST_WHILE_IDLE">DEFAULT_TEST_WHILE_IDLE</a></span></code>
<div class="block">The default "test while idle" value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS">DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS</a></span></code>
<div class="block">The default "time between eviction runs" value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_WHEN_EXHAUSTED_ACTION">DEFAULT_WHEN_EXHAUSTED_ACTION</a></span></code>
<div class="block">The default "when exhausted action" for the pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK">WHEN_EXHAUSTED_BLOCK</a></span></code>
<div class="block">A "when exhausted action" type indicating that when the pool
is exhausted (i.e., the maximum number
of active objects has been reached), the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method should block until a new object is available, or the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>maximum wait time</code></a> has been reached.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL">WHEN_EXHAUSTED_FAIL</a></span></code>
<div class="block">A "when exhausted action" type indicating that when the pool is
exhausted (i.e., the maximum number of active objects has
been reached), the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method should fail, throwing a <a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util"><code>NoSuchElementException</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW">WHEN_EXHAUSTED_GROW</a></span></code>
<div class="block">A "when exhausted action" type indicating that when the pool is
exhausted (i.e., the maximum number
of active objects has been reached), the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method should simply create a new object anyway.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool--">GenericKeyedObjectPool</a></span>()</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> with no factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-org.apache.commons.pool.impl.GenericKeyedObjectPool.Config-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl">GenericKeyedObjectPool.Config</a> config)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-boolean-boolean-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
boolean testOnBorrow,
boolean testOnReturn)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-boolean-boolean-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
boolean testOnBorrow,
boolean testOnReturn)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-boolean-boolean-long-int-long-boolean-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-int-boolean-boolean-long-int-long-boolean-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int maxTotal,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-int-int-boolean-boolean-long-int-long-boolean-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int maxTotal,
int minIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-int-int-boolean-boolean-long-int-long-boolean-boolean-">GenericKeyedObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int maxTotal,
int minIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle,
boolean lifo)</code>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#addObject-K-">addObject</a></span>(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key)</code>
<div class="block">Create an object using the <a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#makeObject-K-"><code>factory</code></a>,
passivate it, and then place it in the idle object pool.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-">borrowObject</a></span>(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key)</code>
<div class="block">Borrows an object from the keyed pool associated with the given key.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#clear--">clear</a></span>()</code>
<div class="block">Clears any objects sitting idle in the pool by removing them from the
idle instance pool and then invoking the configured PoolableObjectFactory's
<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#destroyObject-K-V-"><code>KeyedPoolableObjectFactory.destroyObject(Object, Object)</code></a> method on
each idle instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#clear-K-">clear</a></span>(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key)</code>
<div class="block">Clears the specified pool, removing all pooled instances corresponding to the given <code>key</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#clearOldest--">clearOldest</a></span>()</code>
<div class="block">Clears oldest 15% of objects in pool.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#close--">close</a></span>()</code>
<div class="block">Closes the keyed object pool.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#evict--">evict</a></span>()</code>
<div class="block">Perform <code>numTests</code> idle object eviction tests, evicting
examined objects that meet the criteria for eviction.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getLifo--">getLifo</a></span>()</code>
<div class="block">Whether or not the idle object pools act as LIFO queues.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxActive--">getMaxActive</a></span>()</code>
<div class="block">Returns the cap on the number of object instances allocated by the pool
(checked out or idle), per key.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxIdle--">getMaxIdle</a></span>()</code>
<div class="block">Returns the cap on the number of "idle" instances per key.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxTotal--">getMaxTotal</a></span>()</code>
<div class="block">Returns the overall maximum number of objects (across pools) that can
exist at one time.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--">getMaxWait</a></span>()</code>
<div class="block">Returns the maximum amount of time (in milliseconds) the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method should block before throwing
an exception when the pool is exhausted and the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>"when exhausted" action</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinEvictableIdleTimeMillis--">getMinEvictableIdleTimeMillis</a></span>()</code>
<div class="block">Returns the minimum amount of time an object may sit idle in the pool
before it is eligible for eviction by the idle object evictor
(if any).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinIdle--">getMinIdle</a></span>()</code>
<div class="block">Returns the minimum number of idle objects to maintain in each of the keyed
pools.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumActive--">getNumActive</a></span>()</code>
<div class="block">Returns the total number of instances current borrowed from this pool but not yet returned.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumActive-java.lang.Object-">getNumActive</a></span>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key)</code>
<div class="block">Returns the number of instances currently borrowed from but not yet returned
to the pool corresponding to the given <code>key</code>.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumIdle--">getNumIdle</a></span>()</code>
<div class="block">Returns the total number of instances currently idle in this pool.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumIdle-java.lang.Object-">getNumIdle</a></span>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key)</code>
<div class="block">Returns the number of instances corresponding to the given <code>key</code> currently idle in this pool.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumTestsPerEvictionRun--">getNumTestsPerEvictionRun</a></span>()</code>
<div class="block">Returns the max number of objects to examine during each run of the
idle object evictor thread (if any).</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnBorrow--">getTestOnBorrow</a></span>()</code>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnReturn--">getTestOnReturn</a></span>()</code>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned to the pool within the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestWhileIdle--">getTestWhileIdle</a></span>()</code>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
by the idle object evictor (if any).</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTimeBetweenEvictionRunsMillis--">getTimeBetweenEvictionRunsMillis</a></span>()</code>
<div class="block">Returns the number of milliseconds to sleep between runs of the
idle object evictor thread.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getWhenExhaustedAction--">getWhenExhaustedAction</a></span>()</code>
<div class="block">Returns the action to take when the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached).</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#invalidateObject-K-V-">invalidateObject</a></span>(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a> obj)</code>
<div class="block">Invalidates an object from the pool.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#preparePool-K-boolean-">preparePool</a></span>(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key,
boolean populateImmediately)</code>
<div class="block">Registers a key for pool control.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-">returnObject</a></span>(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a> obj)</code>
<div class="block">Returns an object to a keyed pool.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setConfig-org.apache.commons.pool.impl.GenericKeyedObjectPool.Config-">setConfig</a></span>(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl">GenericKeyedObjectPool.Config</a> conf)</code>
<div class="block">Sets the configuration.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setLifo-boolean-">setLifo</a></span>(boolean lifo)</code>
<div class="block">Sets the LIFO property of the pools.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-">setMaxActive</a></span>(int maxActive)</code>
<div class="block">Sets the cap on the number of object instances managed by the pool per key.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-">setMaxIdle</a></span>(int maxIdle)</code>
<div class="block">Sets the cap on the number of "idle" instances in the pool.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-">setMaxTotal</a></span>(int maxTotal)</code>
<div class="block">Sets the cap on the total number of instances from all pools combined.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-">setMaxWait</a></span>(long maxWait)</code>
<div class="block">Sets the maximum amount of time (in milliseconds) the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method should block before throwing
an exception when the pool is exhausted and the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>"when exhausted" action</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-">setMinEvictableIdleTimeMillis</a></span>(long minEvictableIdleTimeMillis)</code>
<div class="block">Sets the minimum amount of time an object may sit idle in the pool
before it is eligible for eviction by the idle object evictor
(if any).</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinIdle-int-">setMinIdle</a></span>(int poolSize)</code>
<div class="block">Sets the minimum number of idle objects to maintain in each of the keyed
pools.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-">setNumTestsPerEvictionRun</a></span>(int numTestsPerEvictionRun)</code>
<div class="block">Sets the max number of objects to examine during each run of the
idle object evictor thread (if any).</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-">setTestOnBorrow</a></span>(boolean testOnBorrow)</code>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-">setTestOnReturn</a></span>(boolean testOnReturn)</code>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned to the pool within the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-">setTestWhileIdle</a></span>(boolean testWhileIdle)</code>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
by the idle object evictor (if any).</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-">setTimeBetweenEvictionRunsMillis</a></span>(long timeBetweenEvictionRunsMillis)</code>
<div class="block">Sets the number of milliseconds to sleep between runs of the
idle object evictor thread.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-">setWhenExhaustedAction</a></span>(byte whenExhaustedAction)</code>
<div class="block">Sets the action to take when the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_LIFO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_LIFO</h4>
<pre>public static final boolean DEFAULT_LIFO</pre>
<div class="block">The default LIFO status. True means that borrowObject returns the
most recently used ("last in") idle object in a pool (if there are
idle instances available). False means that pools behave as FIFO
queues - objects are taken from idle object pools in the order that
they are returned.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setLifo-boolean-"><code>setLifo(boolean)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_LIFO">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MAX_ACTIVE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MAX_ACTIVE</h4>
<pre>public static final int DEFAULT_MAX_ACTIVE</pre>
<div class="block">The default cap on the total number of active instances (per key)
from the pool.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxActive--"><code>getMaxActive()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_MAX_ACTIVE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MAX_IDLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MAX_IDLE</h4>
<pre>public static final int DEFAULT_MAX_IDLE</pre>
<div class="block">The default cap on the number of idle instances (per key) in the pool.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxIdle--"><code>getMaxIdle()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_MAX_IDLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MAX_TOTAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MAX_TOTAL</h4>
<pre>public static final int DEFAULT_MAX_TOTAL</pre>
<div class="block">The default cap on the the overall maximum number of objects that can
exist at one time.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxTotal--"><code>getMaxTotal()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-"><code>setMaxTotal(int)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_MAX_TOTAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MAX_WAIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MAX_WAIT</h4>
<pre>public static final long DEFAULT_MAX_WAIT</pre>
<div class="block">The default maximum amount of time (in milliseconds) the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method should block before throwing
an exception when the pool is exhausted and the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getWhenExhaustedAction--"><code>"when exhausted" action</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>getMaxWait()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_MAX_WAIT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS</h4>
<pre>public static final long DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS</pre>
<div class="block">The default value for <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinEvictableIdleTimeMillis--"><code>getMinEvictableIdleTimeMillis()</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinEvictableIdleTimeMillis--"><code>getMinEvictableIdleTimeMillis()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-"><code>setMinEvictableIdleTimeMillis(long)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MIN_IDLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MIN_IDLE</h4>
<pre>public static final int DEFAULT_MIN_IDLE</pre>
<div class="block">The default minimum level of idle objects in the pool.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinIdle-int-"><code>setMinIdle(int)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinIdle--"><code>getMinIdle()</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_MIN_IDLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_NUM_TESTS_PER_EVICTION_RUN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_NUM_TESTS_PER_EVICTION_RUN</h4>
<pre>public static final int DEFAULT_NUM_TESTS_PER_EVICTION_RUN</pre>
<div class="block">The default number of objects to examine per run in the
idle object evictor.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumTestsPerEvictionRun--"><code>getNumTestsPerEvictionRun()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-"><code>setNumTestsPerEvictionRun(int)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTimeBetweenEvictionRunsMillis--"><code>getTimeBetweenEvictionRunsMillis()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_NUM_TESTS_PER_EVICTION_RUN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TEST_ON_BORROW">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TEST_ON_BORROW</h4>
<pre>public static final boolean DEFAULT_TEST_ON_BORROW</pre>
<div class="block">The default "test on borrow" value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnBorrow--"><code>getTestOnBorrow()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_TEST_ON_BORROW">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TEST_ON_RETURN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TEST_ON_RETURN</h4>
<pre>public static final boolean DEFAULT_TEST_ON_RETURN</pre>
<div class="block">The default "test on return" value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnReturn--"><code>getTestOnReturn()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_TEST_ON_RETURN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TEST_WHILE_IDLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TEST_WHILE_IDLE</h4>
<pre>public static final boolean DEFAULT_TEST_WHILE_IDLE</pre>
<div class="block">The default "test while idle" value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestWhileIdle--"><code>getTestWhileIdle()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-"><code>setTestWhileIdle(boolean)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTimeBetweenEvictionRunsMillis--"><code>getTimeBetweenEvictionRunsMillis()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_TEST_WHILE_IDLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS</h4>
<pre>public static final long DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS</pre>
<div class="block">The default "time between eviction runs" value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTimeBetweenEvictionRunsMillis--"><code>getTimeBetweenEvictionRunsMillis()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_WHEN_EXHAUSTED_ACTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_WHEN_EXHAUSTED_ACTION</h4>
<pre>public static final byte DEFAULT_WHEN_EXHAUSTED_ACTION</pre>
<div class="block">The default "when exhausted action" for the pool.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL"><code>WHEN_EXHAUSTED_FAIL</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.DEFAULT_WHEN_EXHAUSTED_ACTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WHEN_EXHAUSTED_BLOCK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WHEN_EXHAUSTED_BLOCK</h4>
<pre>public static final byte WHEN_EXHAUSTED_BLOCK</pre>
<div class="block">A "when exhausted action" type indicating that when the pool
is exhausted (i.e., the maximum number
of active objects has been reached), the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method should block until a new object is available, or the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>maximum wait time</code></a> has been reached.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL"><code>WHEN_EXHAUSTED_FAIL</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>getMaxWait()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.WHEN_EXHAUSTED_BLOCK">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WHEN_EXHAUSTED_FAIL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WHEN_EXHAUSTED_FAIL</h4>
<pre>public static final byte WHEN_EXHAUSTED_FAIL</pre>
<div class="block">A "when exhausted action" type indicating that when the pool is
exhausted (i.e., the maximum number of active objects has
been reached), the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method should fail, throwing a <a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util"><code>NoSuchElementException</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.WHEN_EXHAUSTED_FAIL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WHEN_EXHAUSTED_GROW">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WHEN_EXHAUSTED_GROW</h4>
<pre>public static final byte WHEN_EXHAUSTED_GROW</pre>
<div class="block">A "when exhausted action" type indicating that when the pool is
exhausted (i.e., the maximum number
of active objects has been reached), the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method should simply create a new object anyway.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL"><code>WHEN_EXHAUSTED_FAIL</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>,
<a href="../../../../../constant-values.html#org.apache.commons.pool.impl.GenericKeyedObjectPool.WHEN_EXHAUSTED_GROW">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GenericKeyedObjectPool--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool()</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> with no factory.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-"><code>GenericKeyedObjectPool(KeyedPoolableObjectFactory)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setFactory-org.apache.commons.pool.KeyedPoolableObjectFactory-"><code>setFactory(KeyedPoolableObjectFactory)</code></a></dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy
objects if not <code>null</code></dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-org.apache.commons.pool.impl.GenericKeyedObjectPool.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl">GenericKeyedObjectPool.Config</a> config)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>config</code> - a non-<code>null</code> <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl"><code>GenericKeyedObjectPool.Config</code></a> describing the configuration</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed from me at one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed from me at one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>)</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
boolean testOnBorrow,
boolean testOnReturn)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed from me at one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>testOnBorrow</code> - whether or not to validate objects before they are returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a>)</dd>
<dd><code>testOnReturn</code> - whether or not to validate objects after they are returned to the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a>)</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed from me at one time
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>)</dd>
<dd><code>maxIdle</code> - the maximum number of idle objects in my pool (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>)</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
boolean testOnBorrow,
boolean testOnReturn)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed from me at one time
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>getMaxWait()</code></a>)</dd>
<dd><code>maxIdle</code> - the maximum number of idle objects in my pool (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>)</dd>
<dd><code>testOnBorrow</code> - whether or not to validate objects before they are returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a>)</dd>
<dd><code>testOnReturn</code> - whether or not to validate objects after they are returned to the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a>)</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-boolean-boolean-long-int-long-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed from me at one time
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>)</dd>
<dd><code>maxIdle</code> - the maximum number of idle objects in my pool (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>)</dd>
<dd><code>testOnBorrow</code> - whether or not to validate objects before they are returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a>)</dd>
<dd><code>testOnReturn</code> - whether or not to validate objects after they are returned to the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a>)</dd>
<dd><code>timeBetweenEvictionRunsMillis</code> - the amount of time (in milliseconds) to sleep between examining idle
objects for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a>)</dd>
<dd><code>numTestsPerEvictionRun</code> - the number of idle objects to examine per run within the idle object eviction
thread (if any) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-"><code>setNumTestsPerEvictionRun(int)</code></a>)</dd>
<dd><code>minEvictableIdleTimeMillis</code> - the minimum number of milliseconds an object can sit idle in the pool before
it is eligible for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-"><code>setMinEvictableIdleTimeMillis(long)</code></a>)</dd>
<dd><code>testWhileIdle</code> - whether or not to validate objects in the idle object eviction thread, if any
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-"><code>setTestWhileIdle(boolean)</code></a>)</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-int-boolean-boolean-long-int-long-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int maxTotal,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed from me at one time
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>)</dd>
<dd><code>maxIdle</code> - the maximum number of idle objects in my pool (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>)</dd>
<dd><code>maxTotal</code> - the maximum number of objects that can exists at one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-"><code>setMaxTotal(int)</code></a>)</dd>
<dd><code>testOnBorrow</code> - whether or not to validate objects before they are returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a>)</dd>
<dd><code>testOnReturn</code> - whether or not to validate objects after they are returned to the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a>)</dd>
<dd><code>timeBetweenEvictionRunsMillis</code> - the amount of time (in milliseconds) to sleep between examining idle
objects for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a>)</dd>
<dd><code>numTestsPerEvictionRun</code> - the number of idle objects to examine per run within the idle object eviction
thread (if any) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-"><code>setNumTestsPerEvictionRun(int)</code></a>)</dd>
<dd><code>minEvictableIdleTimeMillis</code> - the minimum number of milliseconds an object can sit idle in the pool
before it is eligible for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-"><code>setMinEvictableIdleTimeMillis(long)</code></a>)</dd>
<dd><code>testWhileIdle</code> - whether or not to validate objects in the idle object eviction thread, if any
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-"><code>setTestWhileIdle(boolean)</code></a>)</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-int-int-boolean-boolean-long-int-long-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int maxTotal,
int minIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed at one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>)</dd>
<dd><code>maxIdle</code> - the maximum number of idle objects in my pool (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>)</dd>
<dd><code>maxTotal</code> - the maximum number of objects that can exists at one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-"><code>setMaxTotal(int)</code></a>)</dd>
<dd><code>minIdle</code> - the minimum number of idle objects to have in the pool at any one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinIdle-int-"><code>setMinIdle(int)</code></a>)</dd>
<dd><code>testOnBorrow</code> - whether or not to validate objects before they are returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a>)</dd>
<dd><code>testOnReturn</code> - whether or not to validate objects after they are returned to the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a>)</dd>
<dd><code>timeBetweenEvictionRunsMillis</code> - the amount of time (in milliseconds) to sleep between examining idle
objects
for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a>)</dd>
<dd><code>numTestsPerEvictionRun</code> - the number of idle objects to examine per run within the idle object eviction
thread (if any) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-"><code>setNumTestsPerEvictionRun(int)</code></a>)</dd>
<dd><code>minEvictableIdleTimeMillis</code> - the minimum number of milliseconds an object can sit idle in the pool before
it is eligible for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-"><code>setMinEvictableIdleTimeMillis(long)</code></a>)</dd>
<dd><code>testWhileIdle</code> - whether or not to validate objects in the idle object eviction thread, if any
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-"><code>setTestWhileIdle(boolean)</code></a>)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.3</dd>
</dl>
</li>
</ul>
<a name="GenericKeyedObjectPool-org.apache.commons.pool.KeyedPoolableObjectFactory-int-byte-long-int-int-int-boolean-boolean-long-int-long-boolean-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GenericKeyedObjectPool</h4>
<pre>public GenericKeyedObjectPool(<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>> factory,
int maxActive,
byte whenExhaustedAction,
long maxWait,
int maxIdle,
int maxTotal,
int minIdle,
boolean testOnBorrow,
boolean testOnReturn,
long timeBetweenEvictionRunsMillis,
int numTestsPerEvictionRun,
long minEvictableIdleTimeMillis,
boolean testWhileIdle,
boolean lifo)</pre>
<div class="block">Create a new <code>GenericKeyedObjectPool</code> using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the <code>KeyedPoolableObjectFactory</code> to use to create, validate, and destroy objects
if not <code>null</code></dd>
<dd><code>maxActive</code> - the maximum number of objects that can be borrowed at one time
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a>)</dd>
<dd><code>whenExhaustedAction</code> - the action to take when the pool is exhausted (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>)</dd>
<dd><code>maxWait</code> - the maximum amount of time to wait for an idle object when the pool is exhausted and
<code>whenExhaustedAction</code> is <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a> (otherwise ignored) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>)</dd>
<dd><code>maxIdle</code> - the maximum number of idle objects in my pool (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>)</dd>
<dd><code>maxTotal</code> - the maximum number of objects that can exists at one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-"><code>setMaxTotal(int)</code></a>)</dd>
<dd><code>minIdle</code> - the minimum number of idle objects to have in the pool at any one time (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinIdle-int-"><code>setMinIdle(int)</code></a>)</dd>
<dd><code>testOnBorrow</code> - whether or not to validate objects before they are returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a>)</dd>
<dd><code>testOnReturn</code> - whether or not to validate objects after they are returned to the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>
method (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a>)</dd>
<dd><code>timeBetweenEvictionRunsMillis</code> - the amount of time (in milliseconds) to sleep between examining idle
objects for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a>)</dd>
<dd><code>numTestsPerEvictionRun</code> - the number of idle objects to examine per run within the idle object eviction
thread (if any) (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-"><code>setNumTestsPerEvictionRun(int)</code></a>)</dd>
<dd><code>minEvictableIdleTimeMillis</code> - the minimum number of milliseconds an object can sit idle in the pool before
it is eligible for eviction (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-"><code>setMinEvictableIdleTimeMillis(long)</code></a>)</dd>
<dd><code>testWhileIdle</code> - whether or not to validate objects in the idle object eviction thread, if any
(see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-"><code>setTestWhileIdle(boolean)</code></a>)</dd>
<dd><code>lifo</code> - whether or not the pools behave as LIFO (last in first out) queues (see <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setLifo-boolean-"><code>setLifo(boolean)</code></a>)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.4</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="addObject-java.lang.Object-">
<!-- -->
</a><a name="addObject-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addObject</h4>
<pre>public void addObject(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Create an object using the <a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#makeObject-K-"><code>factory</code></a>,
passivate it, and then place it in the idle object pool.
<code>addObject</code> is useful for "pre-loading" a pool with idle objects.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#addObject-K-">addObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#addObject-K-">addObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key a new instance should be added to</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#makeObject-K-"><code>KeyedPoolableObjectFactory.makeObject(K)</code></a> fails.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - when no <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setFactory-org.apache.commons.pool.KeyedPoolableObjectFactory-"><code>factory</code></a> has been set or after <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#close--"><code>close()</code></a> has been
called on this pool.</dd>
</dl>
</li>
</ul>
<a name="borrowObject-java.lang.Object-">
<!-- -->
</a><a name="borrowObject-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>borrowObject</h4>
<pre>public <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a> borrowObject(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Borrows an object from the keyed pool associated with the given key.</p>
<p>If there is an idle instance available in the pool associated with the given key, then
either the most-recently returned (if <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getLifo--"><code>lifo</code></a> == true) or "oldest" (lifo == false)
instance sitting idle in the pool will be activated and returned. If activation fails, or
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnBorrow--"><code>testOnBorrow</code></a> is set to true and validation fails, the instance is destroyed and the
next available instance is examined. This continues until either a valid instance is returned or there
are no more idle instances available.</p>
<p>If there are no idle instances available in the pool associated with the given key, behavior
depends on the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxActive--"><code>maxActive</code></a>, <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxTotal--"><code>maxTotal</code></a>, and (if applicable)
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getWhenExhaustedAction--"><code>whenExhaustedAction</code></a> and <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>maxWait</code></a> properties. If the
number of instances checked out from the pool under the given key is less than <code>maxActive</code> and
the total number of instances in circulation (under all keys) is less than <code>maxTotal</code>, a new instance
is created, activated and (if applicable) validated and returned to the caller.</p>
<p>If the associated keyed pool is exhausted (no available idle instances and no capacity to create new ones),
this method will either block (<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>), throw a <code>NoSuchElementException</code>
(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL"><code>WHEN_EXHAUSTED_FAIL</code></a>), or grow (<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a> - ignoring maxActive, maxTotal properties).
The length of time that this method will block when <code>whenExhaustedAction == WHEN_EXHAUSTED_BLOCK</code>
is determined by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>maxWait</code></a> property.</p>
<p>When the pool is exhausted, multiple calling threads may be simultaneously blocked waiting for instances
to become available. As of pool 1.5, a "fairness" algorithm has been implemented to ensure that threads receive
available instances in request arrival order.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#borrowObject-K-">borrowObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#borrowObject-K-">borrowObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - pool key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>object instance from the keyed pool</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - if a keyed object instance cannot be returned.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#close--"><code>close</code></a> has been called on this pool</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#makeObject-K-"><code>makeObject</code></a> throws an exception</dd>
</dl>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">Clears any objects sitting idle in the pool by removing them from the
idle instance pool and then invoking the configured PoolableObjectFactory's
<a href="../../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#destroyObject-K-V-"><code>KeyedPoolableObjectFactory.destroyObject(Object, Object)</code></a> method on
each idle instance.
<p> Implementation notes:
<ul><li>This method does not destroy or effect in any way instances that are
checked out when it is invoked.</li>
<li>Invoking this method does not prevent objects being
returned to the idle instance pool, even during its execution. It locks
the pool only during instance removal. Additional instances may be returned
while removed items are being destroyed.</li>
<li>Exceptions encountered destroying idle instances are swallowed.</li></ul></p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#clear--">clear</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#clear--">clear</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
</dl>
</li>
</ul>
<a name="clear-java.lang.Object-">
<!-- -->
</a><a name="clear-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key)</pre>
<div class="block">Clears the specified pool, removing all pooled instances corresponding to the given <code>key</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#clear-K-">clear</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#clear-K-">clear</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to clear</dd>
</dl>
</li>
</ul>
<a name="clearOldest--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearOldest</h4>
<pre>public void clearOldest()</pre>
<div class="block">Clears oldest 15% of objects in pool. The method sorts the
objects into a TreeMap and then iterates the first 15% for removal.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.3</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Closes the keyed object pool. Once the pool is closed, <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(Object)</code></a>
will fail with IllegalStateException, but <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(Object, Object)</code></a> and
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#invalidateObject-K-V-"><code>invalidateObject(Object, Object)</code></a> will continue to work, with returned objects
destroyed on return.</p>
<p>Destroys idle instances in the pool by invoking <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#clear--"><code>clear()</code></a>.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#close--">close</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#close--">close</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="evict--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evict</h4>
<pre>public void evict()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Perform <code>numTests</code> idle object eviction tests, evicting
examined objects that meet the criteria for eviction. If
<code>testWhileIdle</code> is true, examined objects are validated
when visited (and removed if invalid); otherwise only objects that
have been idle for more than <code>minEvicableIdletimeMillis</code>
are removed.</p>
<p>Successive activations of this method examine objects in keyed pools
in sequence, cycling through the keys and examining objects in
oldest-to-youngest order within the keyed pools.</p></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when there is a problem evicting idle objects.</dd>
</dl>
</li>
</ul>
<a name="getLifo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLifo</h4>
<pre>public boolean getLifo()</pre>
<div class="block">Whether or not the idle object pools act as LIFO queues. True means
that borrowObject returns the most recently used ("last in") idle object
in a pool (if there are idle instances available). False means that
the pools behave as FIFO queues - objects are taken from idle object
pools in the order that they are returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the pools are configured to act as LIFO queues</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a name="getMaxActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxActive</h4>
<pre>public int getMaxActive()</pre>
<div class="block">Returns the cap on the number of object instances allocated by the pool
(checked out or idle), per key.
A negative value indicates no limit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the cap on the number of active instances per key.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxActive-int-"><code>setMaxActive(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="getMaxIdle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxIdle</h4>
<pre>public int getMaxIdle()</pre>
<div class="block">Returns the cap on the number of "idle" instances per key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of "idle" instances that can be held
in a given keyed pool.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="getMaxTotal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxTotal</h4>
<pre>public int getMaxTotal()</pre>
<div class="block">Returns the overall maximum number of objects (across pools) that can
exist at one time. A negative value indicates no limit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of instances in circulation at one time.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxTotal-int-"><code>setMaxTotal(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="getMaxWait--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxWait</h4>
<pre>public long getMaxWait()</pre>
<div class="block">Returns the maximum amount of time (in milliseconds) the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method should block before throwing
an exception when the pool is exhausted and the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>"when exhausted" action</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>.
When less than or equal to 0, the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method
may block indefinitely.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of milliseconds borrowObject will block.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMaxWait-long-"><code>setMaxWait(long)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a></dd>
</dl>
</li>
</ul>
<a name="getMinEvictableIdleTimeMillis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinEvictableIdleTimeMillis</h4>
<pre>public long getMinEvictableIdleTimeMillis()</pre>
<div class="block">Returns the minimum amount of time an object may sit idle in the pool
before it is eligible for eviction by the idle object evictor
(if any).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minimum amount of time an object may sit idle in the pool before it is eligible for eviction.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setMinEvictableIdleTimeMillis-long-"><code>setMinEvictableIdleTimeMillis(long)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="getMinIdle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinIdle</h4>
<pre>public int getMinIdle()</pre>
<div class="block">Returns the minimum number of idle objects to maintain in each of the keyed
pools. This setting has no effect unless
<code>timeBetweenEvictionRunsMillis > 0</code> and attempts to ensure
that each pool has the required minimum number of instances are only
made during idle object eviction runs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minimum size of the each keyed pool</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="getNumActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumActive</h4>
<pre>public int getNumActive()</pre>
<div class="block">Returns the total number of instances current borrowed from this pool but not yet returned.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#getNumActive--">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#getNumActive--">getNumActive</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of instances currently borrowed from this pool</dd>
</dl>
</li>
</ul>
<a name="getNumActive-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumActive</h4>
<pre>public int getNumActive(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key)</pre>
<div class="block">Returns the number of instances currently borrowed from but not yet returned
to the pool corresponding to the given <code>key</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#getNumActive-K-">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#getNumActive-K-">getNumActive</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances corresponding to the given <code>key</code> currently borrowed in this pool</dd>
</dl>
</li>
</ul>
<a name="getNumIdle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumIdle</h4>
<pre>public int getNumIdle()</pre>
<div class="block">Returns the total number of instances currently idle in this pool.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#getNumIdle--">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#getNumIdle--">getNumIdle</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total number of instances currently idle in this pool</dd>
</dl>
</li>
</ul>
<a name="getNumIdle-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumIdle</h4>
<pre>public int getNumIdle(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key)</pre>
<div class="block">Returns the number of instances corresponding to the given <code>key</code> currently idle in this pool.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#getNumIdle-K-">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#getNumIdle-K-">getNumIdle</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key to query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances corresponding to the given <code>key</code> currently idle in this pool</dd>
</dl>
</li>
</ul>
<a name="getNumTestsPerEvictionRun--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumTestsPerEvictionRun</h4>
<pre>public int getNumTestsPerEvictionRun()</pre>
<div class="block">Returns the max number of objects to examine during each run of the
idle object evictor thread (if any).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of objects to examine each eviction run.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-"><code>setNumTestsPerEvictionRun(int)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="getTestOnBorrow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTestOnBorrow</h4>
<pre>public boolean getTestOnBorrow()</pre>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method. If the object fails to validate,
it will be dropped from the pool, and we will attempt
to borrow another.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if objects are validated before being borrowed.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnBorrow-boolean-"><code>setTestOnBorrow(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getTestOnReturn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTestOnReturn</h4>
<pre>public boolean getTestOnReturn()</pre>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned to the pool within the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> when objects will be validated before being returned.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestOnReturn-boolean-"><code>setTestOnReturn(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getTestWhileIdle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTestWhileIdle</h4>
<pre>public boolean getTestWhileIdle()</pre>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
by the idle object evictor (if any). If an object
fails to validate, it will be dropped from the pool.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> when objects are validated when borrowed.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTestWhileIdle-boolean-"><code>setTestWhileIdle(boolean)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="getTimeBetweenEvictionRunsMillis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeBetweenEvictionRunsMillis</h4>
<pre>public long getTimeBetweenEvictionRunsMillis()</pre>
<div class="block">Returns the number of milliseconds to sleep between runs of the
idle object evictor thread.
When non-positive, no idle object evictor thread will be
run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>milliseconds to sleep between evictor runs.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="getWhenExhaustedAction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWhenExhaustedAction</h4>
<pre>public byte getWhenExhaustedAction()</pre>
<div class="block">Returns the action to take when the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>one of <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL"><code>WHEN_EXHAUSTED_FAIL</code></a> or <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a></dd>
</dl>
</li>
</ul>
<a name="invalidateObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="invalidateObject-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidateObject</h4>
<pre>public void invalidateObject(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a> obj)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Invalidates an object from the pool.</p>
<p>By contract, <code>obj</code> <strong>must</strong> have been obtained
using <a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> using a <code>key</code> that is
equivalent to the one used to borrow the <code>Object</code> in the first place.</p>
<p>This method should be used when an object that has been borrowed
is determined (due to an exception or other problem) to be invalid.</p>
<p>Activation of this method decrements the active count associated with the given keyed pool
and attempts to destroy <code>obj.</code></p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#invalidateObject-K-V-">invalidateObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#invalidateObject-K-V-">invalidateObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - pool key</dd>
<dd><code>obj</code> - instance to invalidate</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an exception occurs destroying the object</dd>
</dl>
</li>
</ul>
<a name="preparePool-java.lang.Object-boolean-">
<!-- -->
</a><a name="preparePool-K-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preparePool</h4>
<pre>public void preparePool(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key,
boolean populateImmediately)</pre>
<div class="block">Registers a key for pool control.
If <code>populateImmediately</code> is <code>true</code> and
<code>minIdle > 0,</code> the pool under the given key will be
populated immediately with <code>minIdle</code> idle instances.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - - The key to register for pool control.</dd>
<dd><code>populateImmediately</code> - - If this is <code>true</code>, the pool
will be populated immediately.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.3</dd>
</dl>
</li>
</ul>
<a name="returnObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="returnObject-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>returnObject</h4>
<pre>public void returnObject(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a> key,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a> obj)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Returns an object to a keyed pool.</p>
<p>For the pool to function correctly, the object instance <strong>must</strong> have been borrowed
from the pool (under the same key) and not yet returned. Repeated <code>returnObject</code> calls on
the same object/key pair (with no <code>borrowObject</code> calls in between) will result in multiple
references to the object in the idle instance pool.</p>
<p>If <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxIdle--"><code>maxIdle</code></a> is set to a positive value and the number of idle instances under the given
key has reached this value, the returning instance is destroyed.</p>
<p>If <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnReturn--"><code>testOnReturn</code></a> == true, the returning instance is validated before being returned
to the idle instance pool under the given key. In this case, if validation fails, the instance is destroyed.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html#returnObject-K-V-">returnObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html#returnObject-K-V-">returnObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool">BaseKeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html" title="type parameter in GenericKeyedObjectPool">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - pool key</dd>
<dd><code>obj</code> - instance to return to the keyed pool</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="setConfig-org.apache.commons.pool.impl.GenericKeyedObjectPool.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfig</h4>
<pre>public void setConfig(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl">GenericKeyedObjectPool.Config</a> conf)</pre>
<div class="block">Sets the configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - the new configuration to use.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl"><code>GenericKeyedObjectPool.Config</code></a></dd>
</dl>
</li>
</ul>
<a name="setLifo-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLifo</h4>
<pre>public void setLifo(boolean lifo)</pre>
<div class="block">Sets the LIFO property of the pools. True means that borrowObject returns
the most recently used ("last in") idle object in a pool (if there are
idle instances available). False means that the pools behave as FIFO
queues - objects are taken from idle object pools in the order that
they are returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lifo</code> - the new value for the lifo property</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a name="setMaxActive-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxActive</h4>
<pre>public void setMaxActive(int maxActive)</pre>
<div class="block">Sets the cap on the number of object instances managed by the pool per key.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxActive</code> - The cap on the number of object instances per key.
Use a negative value for no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxActive--"><code>getMaxActive()</code></a></dd>
</dl>
</li>
</ul>
<a name="setMaxIdle-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxIdle</h4>
<pre>public void setMaxIdle(int maxIdle)</pre>
<div class="block">Sets the cap on the number of "idle" instances in the pool.
If maxIdle is set too low on heavily loaded systems it is possible you
will see objects being destroyed and almost immediately new objects
being created. This is a result of the active threads momentarily
returning objects faster than they are requesting them them, causing the
number of idle objects to rise above maxIdle. The best value for maxIdle
for heavily loaded system will vary but the default is a good starting
point.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxIdle</code> - the maximum number of "idle" instances that can be held
in a given keyed pool. Use a negative value for no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxIdle--"><code>getMaxIdle()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#DEFAULT_MAX_IDLE"><code>DEFAULT_MAX_IDLE</code></a></dd>
</dl>
</li>
</ul>
<a name="setMaxTotal-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxTotal</h4>
<pre>public void setMaxTotal(int maxTotal)</pre>
<div class="block">Sets the cap on the total number of instances from all pools combined.
When <code>maxTotal</code> is set to a
positive value and <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject</code></a> is invoked
when at the limit with no idle instances available, an attempt is made to
create room by clearing the oldest 15% of the elements from the keyed
pools.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxTotal</code> - The cap on the total number of instances across pools.
Use a negative value for no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxTotal--"><code>getMaxTotal()</code></a></dd>
</dl>
</li>
</ul>
<a name="setMaxWait-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxWait</h4>
<pre>public void setMaxWait(long maxWait)</pre>
<div class="block">Sets the maximum amount of time (in milliseconds) the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method should block before throwing
an exception when the pool is exhausted and the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>"when exhausted" action</code></a> is
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>.
When less than or equal to 0, the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method
may block indefinitely.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxWait</code> - the maximum number of milliseconds borrowObject will block or negative for indefinitely.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMaxWait--"><code>getMaxWait()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setWhenExhaustedAction-byte-"><code>setWhenExhaustedAction(byte)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a></dd>
</dl>
</li>
</ul>
<a name="setMinEvictableIdleTimeMillis-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinEvictableIdleTimeMillis</h4>
<pre>public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)</pre>
<div class="block">Sets the minimum amount of time an object may sit idle in the pool
before it is eligible for eviction by the idle object evictor
(if any).
When non-positive, no objects will be evicted from the pool
due to idle time alone.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>minEvictableIdleTimeMillis</code> - minimum amount of time an object may sit idle in the pool before
it is eligible for eviction.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinEvictableIdleTimeMillis--"><code>getMinEvictableIdleTimeMillis()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="setMinIdle-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinIdle</h4>
<pre>public void setMinIdle(int poolSize)</pre>
<div class="block">Sets the minimum number of idle objects to maintain in each of the keyed
pools. This setting has no effect unless
<code>timeBetweenEvictionRunsMillis > 0</code> and attempts to ensure
that each pool has the required minimum number of instances are only
made during idle object eviction runs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>poolSize</code> - - The minimum size of the each keyed pool</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getMinIdle--"><code>getMinIdle()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="setNumTestsPerEvictionRun-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumTestsPerEvictionRun</h4>
<pre>public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)</pre>
<div class="block">Sets the max number of objects to examine during each run of the
idle object evictor thread (if any).
<p>
When a negative value is supplied,
<code>ceil(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumIdle--"><code>getNumIdle()</code></a>)/abs(<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getNumTestsPerEvictionRun--"><code>getNumTestsPerEvictionRun()</code></a>)</code>
tests will be run. I.e., when the value is <code>-n</code>, roughly one <code>n</code>th of the
idle objects will be tested per run. When the value is positive, the number of tests
actually performed in each run will be the minimum of this value and the number of instances
idle in the pools.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numTestsPerEvictionRun</code> - number of objects to examine each eviction run.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setNumTestsPerEvictionRun-int-"><code>setNumTestsPerEvictionRun(int)</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="setTestOnBorrow-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTestOnBorrow</h4>
<pre>public void setTestOnBorrow(boolean testOnBorrow)</pre>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned by the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a>
method. If the object fails to validate,
it will be dropped from the pool, and we will attempt
to borrow another.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>testOnBorrow</code> - whether object should be validated before being returned by borrowObject.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnBorrow--"><code>getTestOnBorrow()</code></a></dd>
</dl>
</li>
</ul>
<a name="setTestOnReturn-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTestOnReturn</h4>
<pre>public void setTestOnReturn(boolean testOnReturn)</pre>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
before being returned to the pool within the
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#returnObject-K-V-"><code>returnObject(K, V)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>testOnReturn</code> - <code>true</code> so objects will be validated before being returned.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestOnReturn--"><code>getTestOnReturn()</code></a></dd>
</dl>
</li>
</ul>
<a name="setTestWhileIdle-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTestWhileIdle</h4>
<pre>public void setTestWhileIdle(boolean testWhileIdle)</pre>
<div class="block">When <code>true</code>, objects will be
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject-T-"><code>validated</code></a>
by the idle object evictor (if any). If an object
fails to validate, it will be dropped from the pool.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>testWhileIdle</code> - <code>true</code> so objects are validated when borrowed.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTestWhileIdle--"><code>getTestWhileIdle()</code></a>,
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="setTimeBetweenEvictionRunsMillis-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeBetweenEvictionRunsMillis</h4>
<pre>public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)</pre>
<div class="block">Sets the number of milliseconds to sleep between runs of the
idle object evictor thread.
When non-positive, no idle object evictor thread will be
run.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeBetweenEvictionRunsMillis</code> - milliseconds to sleep between evictor runs.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getTimeBetweenEvictionRunsMillis--"><code>getTimeBetweenEvictionRunsMillis()</code></a></dd>
</dl>
</li>
</ul>
<a name="setWhenExhaustedAction-byte-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setWhenExhaustedAction</h4>
<pre>public void setWhenExhaustedAction(byte whenExhaustedAction)</pre>
<div class="block">Sets the action to take when the <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#borrowObject-K-"><code>borrowObject(K)</code></a> method
is invoked when the pool is exhausted (the maximum number
of "active" objects has been reached).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>whenExhaustedAction</code> - the action code, which must be one of
<a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_BLOCK"><code>WHEN_EXHAUSTED_BLOCK</code></a>, <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_FAIL"><code>WHEN_EXHAUSTED_FAIL</code></a>,
or <a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#WHEN_EXHAUSTED_GROW"><code>WHEN_EXHAUSTED_GROW</code></a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.html#getWhenExhaustedAction--"><code>getWhenExhaustedAction()</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/commons/pool/impl/GenericKeyedObjectPool.Config.html" title="class in org.apache.commons.pool.impl"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/pool/impl/GenericKeyedObjectPool.html" target="_top">Frames</a></li>
<li><a href="GenericKeyedObjectPool.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: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><small>Copyright © 2001-2012 Apache Software Foundation. Documenation generated July 7 2016</small>.</small></p>
</body>
</html>
|