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 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523
|
<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!-- Generated by the JDiff Javadoc doclet -->
<!-- (http://www.jdiff.org) -->
<!-- on Tue May 19 17:01:55 PDT 2009 -->
<api
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:noNamespaceSchemaLocation='api.xsd'
name="2.0"
jdversion="1.1.1">
<!-- Command line arguments = -doclet jdiff.JDiff -docletpath /Applications/bin/jdiff-1.1.1/jdiff.jar:/Applications/bin/jdiff-1.1.1/xerces.jar -d /Users/jessewilson/Guice/guice-everything/api-diffs -classpath /usr/share/ant/lib/ant-launcher.jar:/usr/share/ant/lib/ant-jai.jar:/usr/share/ant/lib/ant-jmf.jar:/usr/share/ant/lib/ant-junit.jar:/usr/share/ant/lib/ant-nodeps.jar:/usr/share/ant/lib/ant-swing.jar:/usr/share/ant/lib/ant-testutil.jar:/usr/share/ant/lib/ant-trax.jar:/usr/share/ant/lib/ant.jar:/usr/share/ant/lib/junit.jar:/usr/share/ant/lib/xercesImpl.jar:/usr/share/ant/lib/xml-apis.jar -sourcepath /Users/jessewilson/Guice/google-guice/src:/Users/jessewilson/Guice/google-guice/extensions/jmx/src:/Users/jessewilson/Guice/google-guice/extensions/jndi/src:/Users/jessewilson/Guice/google-guice/extensions/assistedinject/src:/Users/jessewilson/Guice/google-guice/extensions/multibindings/src:/Users/jessewilson/Guice/google-guice/extensions/throwingproviders/src:/Users/jessewilson/Guice/google-guice/servlet/src:/Users/jessewilson/Guice/google-guice/spring/src:/Users/jessewilson/Guice/google-guice/struts2/plugin/src -apiname 2.0 -baseURI http://www.w3.org -apidir /Users/jessewilson/Guice/guice-everything/api-diffs -source 1.5 -->
<package name="com.google.inject">
<!-- start class com.google.inject.AbstractModule -->
<class name="AbstractModule" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Module"/>
<constructor name="AbstractModule"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="configure"
abstract="false" native="false" synchronized="true"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="builder" type="com.google.inject.Binder"/>
</method>
<method name="configure"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Configures a {@link Binder} via the exposed methods.]]>
</doc>
</method>
<method name="binder" return="com.google.inject.Binder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Gets direct access to the underlying {@code Binder}.]]>
</doc>
</method>
<method name="bindScope"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="scopeAnnotation" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<param name="scope" type="com.google.inject.Scope"/>
<doc>
<![CDATA[@see Binder#bindScope(Class, Scope)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[@see Binder#bind(Key)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[@see Binder#bind(TypeLiteral)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="clazz" type="java.lang.Class<T>"/>
<doc>
<![CDATA[@see Binder#bind(Class)]]>
</doc>
</method>
<method name="bindConstant" return="com.google.inject.binder.AnnotatedConstantBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[@see Binder#bindConstant()]]>
</doc>
</method>
<method name="install"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="module" type="com.google.inject.Module"/>
<doc>
<![CDATA[@see Binder#install(Module)]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="message" type="java.lang.String"/>
<param name="arguments" type="java.lang.Object[]"/>
<doc>
<![CDATA[@see Binder#addError(String, Object[])]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="t" type="java.lang.Throwable"/>
<doc>
<![CDATA[@see Binder#addError(Throwable)]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="message" type="com.google.inject.spi.Message"/>
<doc>
<![CDATA[@see Binder#addError(Message)
@since 2.0]]>
</doc>
</method>
<method name="requestInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="instance" type="java.lang.Object"/>
<doc>
<![CDATA[@see Binder#requestInjection(Object)
@since 2.0]]>
</doc>
</method>
<method name="requestStaticInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="types" type="java.lang.Class[]"/>
<doc>
<![CDATA[@see Binder#requestStaticInjection(Class[])]]>
</doc>
</method>
<method name="bindInterceptor"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="classMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.Class<?>>"/>
<param name="methodMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.reflect.Method>"/>
<param name="interceptors" type="org.aopalliance.intercept.MethodInterceptor[]"/>
<doc>
<![CDATA[@see Binder#bindInterceptor(com.google.inject.matcher.Matcher,
com.google.inject.matcher.Matcher,
org.aopalliance.intercept.MethodInterceptor[])]]>
</doc>
</method>
<method name="requireBinding"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<?>"/>
<doc>
<![CDATA[Adds a dependency from this module to {@code key}. When the injector is
created, Guice will report an error if {@code key} cannot be injected.
Note that this requirement may be satisfied by implicit binding, such as
a public no-arguments constructor.
@since 2.0]]>
</doc>
</method>
<method name="requireBinding"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Adds a dependency from this module to {@code type}. When the injector is
created, Guice will report an error if {@code type} cannot be injected.
Note that this requirement may be satisfied by implicit binding, such as
a public no-arguments constructor.
@since 2.0]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[@see Binder#getProvider(Key)
@since 2.0]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[@see Binder#getProvider(Class)
@since 2.0]]>
</doc>
</method>
<method name="convertToTypes"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="typeMatcher" type="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"/>
<param name="converter" type="com.google.inject.spi.TypeConverter"/>
<doc>
<![CDATA[@see Binder#convertToTypes
@since 2.0]]>
</doc>
</method>
<method name="currentStage" return="com.google.inject.Stage"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[@see Binder#currentStage()
@since 2.0]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[@see Binder#getMembersInjector(Class)
@since 2.0]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[@see Binder#getMembersInjector(TypeLiteral)
@since 2.0]]>
</doc>
</method>
<method name="bindListener"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="typeMatcher" type="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"/>
<param name="listener" type="com.google.inject.spi.TypeListener"/>
<doc>
<![CDATA[@see Binder#bindListener(com.google.inject.matcher.Matcher,
com.google.inject.spi.TypeListener)
@since 2.0]]>
</doc>
</method>
<doc>
<![CDATA[A support class for {@link Module}s which reduces repetition and results in
a more readable configuration. Simply extend this class, implement {@link
#configure()}, and call the inherited methods which mirror those found in
{@link Binder}. For example:
<pre>
public class MyModule extends AbstractModule {
protected void configure() {
bind(Service.class).to(ServiceImpl.class).in(Singleton.class);
bind(CreditCardPaymentService.class);
bind(PaymentService.class).to(CreditCardPaymentService.class);
bindConstant().annotatedWith(Names.named("port")).to(8080);
}
}
</pre>
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.AbstractModule -->
<!-- start interface com.google.inject.Binder -->
<interface name="Binder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="bindInterceptor"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="classMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.Class<?>>"/>
<param name="methodMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.reflect.Method>"/>
<param name="interceptors" type="org.aopalliance.intercept.MethodInterceptor[]"/>
<doc>
<![CDATA[Binds method interceptor[s] to methods matched by class and method matchers. A method is
eligible for interception if:
<ul>
<li>Guice created the instance the method is on</li>
<li>Neither the enclosing type nor the method is final</li>
<li>And the method is package-private, protected, or public</li>
</ul>
@param classMatcher matches classes the interceptor should apply to. For
example: {@code only(Runnable.class)}.
@param methodMatcher matches methods the interceptor should apply to. For
example: {@code annotatedWith(Transactional.class)}.
@param interceptors to bind]]>
</doc>
</method>
<method name="bindScope"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<param name="scope" type="com.google.inject.Scope"/>
<doc>
<![CDATA[Binds a scope to an annotation.]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[See the EDSL examples at {@link Binder}.]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[See the EDSL examples at {@link Binder}.]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[See the EDSL examples at {@link Binder}.]]>
</doc>
</method>
<method name="bindConstant" return="com.google.inject.binder.AnnotatedConstantBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[See the EDSL examples at {@link Binder}.]]>
</doc>
</method>
<method name="requestInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<param name="instance" type="T"/>
<doc>
<![CDATA[Upon successful creation, the {@link Injector} will inject instance fields
and methods of the given object.
@param type of instance
@param instance for which members will be injected
@since 2.0]]>
</doc>
</method>
<method name="requestInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="instance" type="java.lang.Object"/>
<doc>
<![CDATA[Upon successful creation, the {@link Injector} will inject instance fields
and methods of the given object.
@param instance for which members will be injected
@since 2.0]]>
</doc>
</method>
<method name="requestStaticInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="types" type="java.lang.Class[]"/>
<doc>
<![CDATA[Upon successful creation, the {@link Injector} will inject static fields
and methods in the given classes.
@param types for which static members will be injected]]>
</doc>
</method>
<method name="install"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="module" type="com.google.inject.Module"/>
<doc>
<![CDATA[Uses the given module to configure more bindings.]]>
</doc>
</method>
<method name="currentStage" return="com.google.inject.Stage"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the current stage.]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="message" type="java.lang.String"/>
<param name="arguments" type="java.lang.Object[]"/>
<doc>
<![CDATA[Records an error message which will be presented to the user at a later
time. Unlike throwing an exception, this enable us to continue
configuring the Injector and discover more errors. Uses {@link
String#format(String, Object[])} to insert the arguments into the
message.]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="t" type="java.lang.Throwable"/>
<doc>
<![CDATA[Records an exception, the full details of which will be logged, and the
message of which will be presented to the user at a later
time. If your Module calls something that you worry may fail, you should
catch the exception and pass it into this.]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="message" type="com.google.inject.spi.Message"/>
<doc>
<![CDATA[Records an error message to be presented to the user at a later time.
@since 2.0]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Returns the provider used to obtain instances for the given injection key.
The returned will not be valid until the {@link Injector} has been
created. The provider will throw an {@code IllegalStateException} if you
try to use it beforehand.
@since 2.0]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the provider used to obtain instances for the given injection type.
The returned provider will not be valid until the {@link Injector} has been
created. The provider will throw an {@code IllegalStateException} if you
try to use it beforehand.
@since 2.0]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Returns the members injector used to inject dependencies into methods and fields on instances
of the given type {@code T}. The returned members injector will not be valid until the main
{@link Injector} has been created. The members injector will throw an {@code
IllegalStateException} if you try to use it beforehand.
@param typeLiteral type to get members injector for
@since 2.0]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the members injector used to inject dependencies into methods and fields on instances
of the given type {@code T}. The returned members injector will not be valid until the main
{@link Injector} has been created. The members injector will throw an {@code
IllegalStateException} if you try to use it beforehand.
@param type type to get members injector for
@since 2.0]]>
</doc>
</method>
<method name="convertToTypes"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeMatcher" type="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"/>
<param name="converter" type="com.google.inject.spi.TypeConverter"/>
<doc>
<![CDATA[Binds a type converter. The injector will use the given converter to
convert string constants to matching types as needed.
@param typeMatcher matches types the converter can handle
@param converter converts values
@since 2.0]]>
</doc>
</method>
<method name="bindListener"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeMatcher" type="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"/>
<param name="listener" type="com.google.inject.spi.TypeListener"/>
<doc>
<![CDATA[Registers a listener for injectable types. Guice will notify the listener when it encounters
injectable types matched by the given type matcher.
@param typeMatcher that matches injectable types the listener should be notified of
@param listener for injectable types matched by typeMatcher
@since 2.0]]>
</doc>
</method>
<method name="withSource" return="com.google.inject.Binder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="source" type="java.lang.Object"/>
<doc>
<![CDATA[Returns a binder that uses {@code source} as the reference location for
configuration errors. This is typically a {@link StackTraceElement}
for {@code .java} source but it could any binding source, such as the
path to a {@code .properties} file.
@param source any object representing the source location and has a
concise {@link Object#toString() toString()} value
@return a binder that shares its configuration with this binder
@since 2.0]]>
</doc>
</method>
<method name="skipSources" return="com.google.inject.Binder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="classesToSkip" type="java.lang.Class[]"/>
<doc>
<![CDATA[Returns a binder that skips {@code classesToSkip} when identify the
calling code. The caller's {@link StackTraceElement} is used to locate
the source of configuration errors.
@param classesToSkip library classes that create bindings on behalf of
their clients.
@return a binder that shares its configuration with this binder.
@since 2.0]]>
</doc>
</method>
<method name="newPrivateBinder" return="com.google.inject.PrivateBinder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Creates a new private child environment for bindings and other configuration. The returned
binder can be used to add and configuration information in this environment. See {@link
PrivateModule} for details.
@return a binder that inherits configuration from this binder. Only exposed configuration on
the returned binder will be visible to this binder.
@since 2.0]]>
</doc>
</method>
<doc>
<![CDATA[Collects configuration information (primarily <i>bindings</i>) which will be
used to create an {@link Injector}. Guice provides this object to your
application's {@link Module} implementors so they may each contribute
their own bindings and other registrations.
<h3>The Guice Binding EDSL</h3>
Guice uses an <i>embedded domain-specific language</i>, or EDSL, to help you
create bindings simply and readably. This approach is great for overall
usability, but it does come with a small cost: <b>it is difficult to
learn how to use the Binding EDSL by reading
method-level javadocs</b>. Instead, you should consult the series of
examples below. To save space, these examples omit the opening
{@code binder}, just as you will if your module extends
{@link AbstractModule}.
<pre>
bind(ServiceImpl.class);</pre>
This statement does essentially nothing; it "binds the {@code ServiceImpl}
class to itself" and does not change Guice's default behavior. You may still
want to use this if you prefer your {@link Module} class to serve as an
explicit <i>manifest</i> for the services it provides. Also, in rare cases,
Guice may be unable to validate a binding at injector creation time unless it
is given explicitly.
<pre>
bind(Service.class).to(ServiceImpl.class);</pre>
Specifies that a request for a {@code Service} instance with no binding
annotations should be treated as if it were a request for a
{@code ServiceImpl} instance. This <i>overrides</i> the function of any
{@link ImplementedBy @ImplementedBy} or {@link ProvidedBy @ProvidedBy}
annotations found on {@code Service}, since Guice will have already
"moved on" to {@code ServiceImpl} before it reaches the point when it starts
looking for these annotations.
<pre>
bind(Service.class).toProvider(ServiceProvider.class);</pre>
In this example, {@code ServiceProvider} must extend or implement
{@code Provider<Service>}. This binding specifies that Guice should resolve
an unannotated injection request for {@code Service} by first resolving an
instance of {@code ServiceProvider} in the regular way, then calling
{@link Provider#get get()} on the resulting Provider instance to obtain the
{@code Service} instance.
<p>The {@link Provider} you use here does not have to be a "factory"; that
is, a provider which always <i>creates</i> each instance it provides.
However, this is generally a good practice to follow. You can then use
Guice's concept of {@link Scope scopes} to guide when creation should happen
-- "letting Guice work for you".
<pre>
bind(Service.class).annotatedWith(Red.class).to(ServiceImpl.class);</pre>
Like the previous example, but only applies to injection requests that use
the binding annotation {@code @Red}. If your module also includes bindings
for particular <i>values</i> of the {@code @Red} annotation (see below),
then this binding will serve as a "catch-all" for any values of {@code @Red}
that have no exact match in the bindings.
<pre>
bind(ServiceImpl.class).in(Singleton.class);
// or, alternatively
bind(ServiceImpl.class).in(Scopes.SINGLETON);</pre>
Either of these statements places the {@code ServiceImpl} class into
singleton scope. Guice will create only one instance of {@code ServiceImpl}
and will reuse it for all injection requests of this type. Note that it is
still possible to bind another instance of {@code ServiceImpl} if the second
binding is qualified by an annotation as in the previous example. Guice is
not overly concerned with <i>preventing</i> you from creating multiple
instances of your "singletons", only with <i>enabling</i> your application to
share only one instance if that's all you tell Guice you need.
<p><b>Note:</b> a scope specified in this way <i>overrides</i> any scope that
was specified with an annotation on the {@code ServiceImpl} class.
<p>Besides {@link Singleton}/{@link Scopes#SINGLETON}, there are
servlet-specific scopes available in
{@code com.google.inject.servlet.ServletScopes}, and your Modules can
contribute their own custom scopes for use here as well.
<pre>
bind(new TypeLiteral<PaymentService<CreditCard>>() {})
.to(CreditCardPaymentService.class);</pre>
This admittedly odd construct is the way to bind a parameterized type. It
tells Guice how to honor an injection request for an element of type
{@code PaymentService<CreditCard>}. The class
{@code CreditCardPaymentService} must implement the
{@code PaymentService<CreditCard>} interface. Guice cannot currently bind or
inject a generic type, such as {@code Set<E>}; all type parameters must be
fully specified.
<pre>
bind(Service.class).toInstance(new ServiceImpl());
// or, alternatively
bind(Service.class).toInstance(SomeLegacyRegistry.getService());</pre>
In this example, your module itself, <i>not Guice</i>, takes responsibility
for obtaining a {@code ServiceImpl} instance, then asks Guice to always use
this single instance to fulfill all {@code Service} injection requests. When
the {@link Injector} is created, it will automatically perform field
and method injection for this instance, but any injectable constructor on
{@code ServiceImpl} is simply ignored. Note that using this approach results
in "eager loading" behavior that you can't control.
<pre>
bindConstant().annotatedWith(ServerHost.class).to(args[0]);</pre>
Sets up a constant binding. Constant injections must always be annotated.
When a constant binding's value is a string, it is eligile for conversion to
all primitive types, to {@link Enum#valueOf(Class, String) all enums}, and to
{@link Class#forName class literals}. Conversions for other types can be
configured using {@link #convertToTypes(Matcher, TypeConverter)
convertToTypes()}.
<pre>
{@literal @}Color("red") Color red; // A member variable (field)
. . .
red = MyModule.class.getDeclaredField("red").getAnnotation(Color.class);
bind(Service.class).annotatedWith(red).to(RedService.class);</pre>
If your binding annotation has parameters you can apply different bindings to
different specific values of your annotation. Getting your hands on the
right instance of the annotation is a bit of a pain -- one approach, shown
above, is to apply a prototype annotation to a field in your module class, so
that you can read this annotation instance and give it to Guice.
<pre>
bind(Service.class)
.annotatedWith(Names.named("blue"))
.to(BlueService.class);</pre>
Differentiating by names is a common enough use case that we provided a
standard annotation, {@link com.google.inject.name.Named @Named}. Because of
Guice's library support, binding by name is quite easier than in the
arbitrary binding annotation case we just saw. However, remember that these
names will live in a single flat namespace with all the other names used in
your application.
<p>The above list of examples is far from exhaustive. If you can think of
how the concepts of one example might coexist with the concepts from another,
you can most likely weave the two together. If the two concepts make no
sense with each other, you most likely won't be able to do it. In a few
cases Guice will let something bogus slip by, and will then inform you of
the problems at runtime, as soon as you try to create your Injector.
<p>The other methods of Binder such as {@link #bindScope},
{@link #bindInterceptor}, {@link #install}, {@link #requestStaticInjection},
{@link #addError} and {@link #currentStage} are not part of the Binding EDSL;
you can learn how to use these in the usual way, from the method
documentation.
@author crazybob@google.com (Bob Lee)
@author jessewilson@google.com (Jesse Wilson)
@author kevinb@google.com (Kevin Bourrillion)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Binder -->
<!-- start interface com.google.inject.Binding -->
<interface name="Binding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<method name="getKey" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the key for this binding.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the scoped provider guice uses to fulfill requests for this
binding.
@throws UnsupportedOperationException when invoked on a {@link Binding}
created via {@link com.google.inject.spi.Elements#getElements}. This
method is only supported on {@link Binding}s returned from an injector.]]>
</doc>
</method>
<method name="acceptTargetVisitor" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.BindingTargetVisitor<? super T, V>"/>
<doc>
<![CDATA[Accepts a target visitor. Invokes the visitor method specific to this binding's target.
@param visitor to call back on
@since 2.0]]>
</doc>
</method>
<method name="acceptScopingVisitor" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.BindingScopingVisitor<V>"/>
<doc>
<![CDATA[Accepts a scoping visitor. Invokes the visitor method specific to this binding's scoping.
@param visitor to call back on
@since 2.0]]>
</doc>
</method>
<doc>
<![CDATA[A mapping from a key (type and optional annotation) to the strategy for getting instances of the
type. This interface is part of the introspection API and is intended primarily for use by
tools.
<p>Bindings are created in several ways:
<ul>
<li>Explicitly in a module, via {@code bind()} and {@code bindConstant()}
statements:
<pre>
bind(Service.class).annotatedWith(Red.class).to(ServiceImpl.class);
bindConstant().annotatedWith(ServerHost.class).to(args[0]);</pre></li>
<li>Implicitly by the Injector by following a type's {@link ImplementedBy
pointer} {@link ProvidedBy annotations} or by using its {@link Inject annotated} or
default constructor.</li>
<li>By converting a bound instance to a different type.</li>
<li>For {@link Provider providers}, by delegating to the binding for the provided type.</li>
</ul>
<p>They exist on both modules and on injectors, and their behaviour is different for each:
<ul>
<li><strong>Module bindings</strong> are incomplete and cannot be used to provide instances.
This is because the applicable scopes and interceptors may not be known until an injector
is created. From a tool's perspective, module bindings are like the injector's source
code. They can be inspected or rewritten, but this analysis must be done statically.</li>
<li><strong>Injector bindings</strong> are complete and valid and can be used to provide
instances. From a tools' perspective, injector bindings are like reflection for an
injector. They have full runtime information, including the complete graph of injections
necessary to satisfy a binding.</li>
</ul>
@param <T> the bound type. The injected is always assignable to this type.
@author crazybob@google.com (Bob Lee)
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Binding -->
<!-- start class com.google.inject.BindingAnnotation -->
<class name="BindingAnnotation" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates annotations which are used for binding. Only one such annotation
may apply to a single injection point. You must also annotate binder
annotations with {@code @Retention(RUNTIME)}. For example:
<pre>
{@code @}Retention(RUNTIME)
{@code @}Target({ FIELD, PARAMETER, METHOD })
{@code @}BindingAnnotation
public {@code @}interface Transactional {}
</pre>
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.BindingAnnotation -->
<!-- start class com.google.inject.ConfigurationException -->
<class name="ConfigurationException" extends="java.lang.RuntimeException"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<constructor name="ConfigurationException" type="java.lang.Iterable<com.google.inject.spi.Message>"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Creates a ConfigurationException containing {@code messages}.]]>
</doc>
</constructor>
<method name="withPartialValue" return="com.google.inject.ConfigurationException"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="partialValue" type="java.lang.Object"/>
<doc>
<![CDATA[Returns a copy of this configuration exception with the specified partial value.]]>
</doc>
</method>
<method name="getErrorMessages" return="java.util.Collection<com.google.inject.spi.Message>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns messages for the errors that caused this exception.]]>
</doc>
</method>
<method name="getPartialValue" return="E"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a value that was only partially computed due to this exception. The caller can use
this while collecting additional configuration problems.
@return the partial value, or {@code null} if none was set. The type of the partial value is
specified by the throwing method.]]>
</doc>
</method>
<method name="getMessage" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Thrown when a programming error such as a misplaced annotation, illegal binding, or unsupported
scope is found. Clients should catch this exception, log it, and stop execution.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.ConfigurationException -->
<!-- start class com.google.inject.CreationException -->
<class name="CreationException" extends="java.lang.RuntimeException"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="CreationException" type="java.util.Collection<com.google.inject.spi.Message>"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Creates a CreationException containing {@code messages}.]]>
</doc>
</constructor>
<method name="getErrorMessages" return="java.util.Collection<com.google.inject.spi.Message>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns messages for the errors that caused this exception.]]>
</doc>
</method>
<method name="getMessage" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Thrown when errors occur while creating a {@link Injector}. Includes a list of encountered
errors. Clients should catch this exception, log it, and stop execution.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.CreationException -->
<!-- start class com.google.inject.Exposed -->
<class name="Exposed" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Acccompanies a {@literal @}{@link com.google.inject.Provides Provides} method annotation in a
private module to indicate that the provided binding is exposed.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.Exposed -->
<!-- start class com.google.inject.Guice -->
<class name="Guice" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Creates an injector for the given set of modules.
@throws CreationException if one or more errors occur during Injector
construction]]>
</doc>
</method>
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[Creates an injector for the given set of modules.
@throws CreationException if one or more errors occur during Injector
creation]]>
</doc>
</method>
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stage" type="com.google.inject.Stage"/>
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Creates an injector for the given set of modules, in a given development
stage.
@throws CreationException if one or more errors occur during Injector
creation]]>
</doc>
</method>
<method name="createInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stage" type="com.google.inject.Stage"/>
<param name="modules" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[Creates an injector for the given set of modules, in a given development
stage.
@throws CreationException if one or more errors occur during Injector
construction]]>
</doc>
</method>
<doc>
<![CDATA[The entry point to the Guice framework. Creates {@link Injector}s from
{@link Module}s.
<p>Guice supports a model of development that draws clear boundaries between
APIs, Implementations of these APIs, Modules which configure these
implementations, and finally Applications which consist of a collection of
Modules. It is the Application, which typically defines your {@code main()}
method, that bootstraps the Guice Injector using the {@code Guice} class, as
in this example:
<pre>
public class FooApplication {
public static void main(String[] args) {
Injector injector = Guice.createInjector(
new ModuleA(),
new ModuleB(),
. . .
new FooApplicationFlagsModule(args)
);
// Now just bootstrap the application and you're done
FooStarter starter = injector.getInstance(FooStarter.class);
starter.runApplication();
}
}
</pre>]]>
</doc>
</class>
<!-- end class com.google.inject.Guice -->
<!-- start class com.google.inject.ImplementedBy -->
<class name="ImplementedBy" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[A pointer to the default implementation of a type.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.ImplementedBy -->
<!-- start class com.google.inject.Inject -->
<class name="Inject" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates members of your implementation class (constructors, methods
and fields) into which the {@link Injector} should inject values.
The Injector fulfills injection requests for:
<ul>
<li>Every instance it constructs. The class being constructed must have
exactly one of its constructors marked with {@code @Inject} or must have a
constructor taking no parameters. The Injector then proceeds to perform
method and field injections.
<li>Pre-constructed instances passed to {@link Injector#injectMembers},
{@link com.google.inject.binder.LinkedBindingBuilder#toInstance(Object)} and
{@link com.google.inject.binder.LinkedBindingBuilder#toProvider(Provider)}.
In this case all constructors are, of course, ignored.
<li>Static fields and methods of classes which any {@link Module} has
specifically requested static injection for, using
{@link Binder#requestStaticInjection}.
</ul>
In all cases, a member can be injected regardless of its Java access
specifier (private, default, protected, public).
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.Inject -->
<!-- start interface com.google.inject.Injector -->
<interface name="Injector" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="injectMembers"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="instance" type="java.lang.Object"/>
<doc>
<![CDATA[Injects dependencies into the fields and methods of {@code instance}. Ignores the presence or
absence of an injectable constructor.
<p>Whenever Guice creates an instance, it performs this injection automatically (after first
performing constructor injection), so if you're able to let Guice create all your objects for
you, you'll never need to use this method.
@param instance to inject members on
@see Binder#getMembersInjector(Class) for a preferred alternative that supports checks before
run time]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Returns the members injector used to inject dependencies into methods and fields on instances
of the given type {@code T}.
@param typeLiteral type to get members injector for
@see Binder#getMembersInjector(TypeLiteral) for an alternative that offers up front error
detection
@since 2.0]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the members injector used to inject dependencies into methods and fields on instances
of the given type {@code T}. When feasible, use {@link Binder#getMembersInjector(TypeLiteral)}
instead to get increased up front error detection.
@param type type to get members injector for
@see Binder#getMembersInjector(Class) for an alternative that offers up front error
detection
@since 2.0]]>
</doc>
</method>
<method name="getBindings" return="java.util.Map<com.google.inject.Key<?>, com.google.inject.Binding<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns all explicit bindings.
<p>The returned map does not include bindings inherited from a {@link #getParent() parent
injector}, should one exist. The returned map is guaranteed to iterate (for example, with
its {@link java.util.Map#entrySet()} iterator) in the order of insertion. In other words,
the order in which bindings appear in user Modules.
<p>This method is part of the Guice SPI and is intended for use by tools and extensions.]]>
</doc>
</method>
<method name="getBinding" return="com.google.inject.Binding<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Returns the binding for the given injection key. This will be an explicit bindings if the key
was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will
be created if necessary.
<p>This method is part of the Guice SPI and is intended for use by tools and extensions.
@throws ConfigurationException if this injector cannot find or create the binding.]]>
</doc>
</method>
<method name="getBinding" return="com.google.inject.Binding<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the binding for the given type. This will be an explicit bindings if the injection key
was bound explicitly by a module, or an implicit binding otherwise. The implicit binding will
be created if necessary.
<p>This method is part of the Guice SPI and is intended for use by tools and extensions.
@throws ConfigurationException if this injector cannot find or create the binding.
@since 2.0]]>
</doc>
</method>
<method name="findBindingsByType" return="java.util.List<com.google.inject.Binding<T>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Returns all explicit bindings for {@code type}.
<p>This method is part of the Guice SPI and is intended for use by tools and extensions.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Returns the provider used to obtain instances for the given injection key. When feasible, avoid
using this method, in favor of having Guice inject your dependencies ahead of time.
@throws ConfigurationException if this injector cannot find or create the provider.
@see Binder#getProvider(Key) for an alternative that offers up front error detection]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the provider used to obtain instances for the given type. When feasible, avoid
using this method, in favor of having Guice inject your dependencies ahead of time.
@throws ConfigurationException if this injector cannot find or create the provider.
@see Binder#getProvider(Class) for an alternative that offers up front error detection]]>
</doc>
</method>
<method name="getInstance" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Returns the appropriate instance for the given injection key; equivalent to {@code
getProvider(key).get()}. When feasible, avoid using this method, in favor of having Guice
inject your dependencies ahead of time.
@throws ConfigurationException if this injector cannot find or create the provider.
@throws ProvisionException if there was a runtime failure while providing an instance.]]>
</doc>
</method>
<method name="getInstance" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the appropriate instance for the given injection type; equivalent to {@code
getProvider(type).get()}. When feasible, avoid using this method, in favor of having Guice
inject your dependencies ahead of time.
@throws ConfigurationException if this injector cannot find or create the provider.
@throws ProvisionException if there was a runtime failure while providing an instance.]]>
</doc>
</method>
<method name="getParent" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns this injector's parent, or {@code null} if this is a top-level injector.
@since 2.0]]>
</doc>
</method>
<method name="createChildInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[Returns a new injector that inherits all state from this injector. All bindings, scopes,
interceptors and type converters are inherited -- they are visible to the child injector.
Elements of the child injector are not visible to its parent.
<p>Just-in-time bindings created for child injectors will be created in an ancestor injector
whenever possible. This allows for scoped instances to be shared between injectors. Use
explicit bindings to prevent bindings from being shared with the parent injector.
<p>No key may be bound by both an injector and one of its ancestors. This includes just-in-time
bindings. The lone exception is the key for {@code Injector.class}, which is bound by each
injector to itself.
@since 2.0]]>
</doc>
</method>
<method name="createChildInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Returns a new injector that inherits all state from this injector. All bindings, scopes,
interceptors and type converters are inherited -- they are visible to the child injector.
Elements of the child injector are not visible to its parent.
<p>Just-in-time bindings created for child injectors will be created in an ancestor injector
whenever possible. This allows for scoped instances to be shared between injectors. Use
explicit bindings to prevent bindings from being shared with the parent injector.
<p>No key may be bound by both an injector and one of its ancestors. This includes just-in-time
bindings. The lone exception is the key for {@code Injector.class}, which is bound by each
injector to itself.
@since 2.0]]>
</doc>
</method>
<doc>
<![CDATA[Builds the graphs of objects that make up your application. The injector tracks the dependencies
for each type and uses bindings to inject them. This is the core of Guice, although you rarely
interact with it directly. This "behind-the-scenes" operation is what distinguishes dependency
injection from its cousin, the service locator pattern.
<p>Contains several default bindings:
<ul>
<li>This {@link Injector} instance itself
<li>A {@code Provider<T>} for each binding of type {@code T}
<li>The {@link java.util.logging.Logger} for the class being injected
<li>The {@link Stage} in which the Injector was created
</ul>
Injectors are created using the facade class {@link Guice}.
<p>An injector can also {@link #injectMembers(Object) inject the dependencies} of
already-constructed instances. This can be used to interoperate with objects created by other
frameworks or services.
<p>Injectors can be {@link #createChildInjector(Iterable) hierarchical}. Child injectors inherit
the configuration of their parent injectors, but the converse does not hold.
<p>The injector's {@link #getBindings() internal bindings} are available for introspection. This
enables tools and extensions to operate on an injector reflectively.
@author crazybob@google.com (Bob Lee)
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Injector -->
<!-- start class com.google.inject.Key -->
<class name="Key" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="Key" type="java.lang.Class<? extends java.lang.annotation.Annotation>"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new key. Derives the type from this class's type parameter.
<p>Clients create an empty anonymous subclass. Doing so embeds the type
parameter in the anonymous class's type hierarchy so we can reconstitute it
at runtime despite erasure.
<p>Example usage for a binding of type {@code Foo} annotated with
{@code @Bar}:
<p>{@code new Key<Foo>(Bar.class) {}}.]]>
</doc>
</constructor>
<constructor name="Key" type="java.lang.annotation.Annotation"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new key. Derives the type from this class's type parameter.
<p>Clients create an empty anonymous subclass. Doing so embeds the type
parameter in the anonymous class's type hierarchy so we can reconstitute it
at runtime despite erasure.
<p>Example usage for a binding of type {@code Foo} annotated with
{@code @Bar}:
<p>{@code new Key<Foo>(new Bar()) {}}.]]>
</doc>
</constructor>
<constructor name="Key"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new key. Derives the type from this class's type parameter.
<p>Clients create an empty anonymous subclass. Doing so embeds the type
parameter in the anonymous class's type hierarchy so we can reconstitute it
at runtime despite erasure.
<p>Example usage for a binding of type {@code Foo}:
<p>{@code new Key<Foo>() {}}.]]>
</doc>
</constructor>
<method name="getTypeLiteral" return="com.google.inject.TypeLiteral<T>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the key type.]]>
</doc>
</method>
<method name="getAnnotationType" return="java.lang.Class<? extends java.lang.annotation.Annotation>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the annotation type.]]>
</doc>
</method>
<method name="getAnnotation" return="java.lang.annotation.Annotation"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the annotation.]]>
</doc>
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Gets a key for an injection type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<?>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Gets a key for an injection type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<?>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.reflect.Type"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<?>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.reflect.Type"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Gets a key for an injection type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation type.]]>
</doc>
</method>
<method name="get" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Gets a key for an injection type and an annotation.]]>
</doc>
</method>
<doc>
<![CDATA[Binding key consisting of an injection type and an optional annotation.
Matches the type and annotation at a point of injection.
<p>For example, {@code Key.get(Service.class, Transactional.class)} will
match:
<pre>
{@literal @}Inject
public void setService({@literal @}Transactional Service service) {
...
}
</pre>
<p>{@code Key} supports generic types via subclassing just like {@link
TypeLiteral}.
<p>Keys do not differentiate between primitive types (int, char, etc.) and
their correpsonding wrapper types (Integer, Character, etc.). Primitive
types will be replaced with their wrapper types when keys are created.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.Key -->
<!-- start interface com.google.inject.MembersInjector -->
<interface name="MembersInjector" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="injectMembers"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="instance" type="T"/>
<doc>
<![CDATA[Injects dependencies into the fields and methods of {@code instance}. Ignores the presence or
absence of an injectable constructor.
<p>Whenever Guice creates an instance, it performs this injection automatically (after first
performing constructor injection), so if you're able to let Guice create all your objects for
you, you'll never need to use this method.
@param instance to inject members on. May be {@code null}.]]>
</doc>
</method>
<doc>
<![CDATA[Injects dependencies into the fields and methods on instances of type {@code T}. Ignores the
presence or absence of an injectable constructor.
@param <T> type to inject members of
@author crazybob@google.com (Bob Lee)
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.MembersInjector -->
<!-- start interface com.google.inject.Module -->
<interface name="Module" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="configure"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<doc>
<![CDATA[Contributes bindings and other configurations for this module to {@code binder}.
<p><strong>Do not invoke this method directly</strong> to install submodules. Instead use
{@link Binder#install(Module)}, which ensures that {@link Provides provider methods} are
discovered.]]>
</doc>
</method>
<doc>
<![CDATA[A module contributes configuration information, typically interface
bindings, which will be used to create an {@link Injector}. A Guice-based
application is ultimately composed of little more than a set of
{@code Module}s and some bootstrapping code.
<p>Your Module classes can use a more streamlined syntax by extending
{@link AbstractModule} rather than implementing this interface directly.
<p>In addition to the bindings configured via {@link #configure}, bindings
will be created for all methods annotated with {@literal @}{@link Provides}.
Use scope and binding annotations on these methods to configure the
bindings.]]>
</doc>
</interface>
<!-- end interface com.google.inject.Module -->
<!-- start class com.google.inject.OutOfScopeException -->
<class name="OutOfScopeException" extends="java.lang.RuntimeException"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<constructor name="OutOfScopeException" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="OutOfScopeException" type="java.lang.String, java.lang.Throwable"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="OutOfScopeException" type="java.lang.Throwable"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<doc>
<![CDATA[Thrown from {@link Provider#get} when an attempt is made to access a scoped
object while the scope in question is not currently active.
@author kevinb@google.com (Kevin Bourrillion)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.OutOfScopeException -->
<!-- start interface com.google.inject.PrivateBinder -->
<interface name="PrivateBinder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binder"/>
<method name="expose"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<?>"/>
<doc>
<![CDATA[Makes the binding for {@code key} available to the enclosing environment]]>
</doc>
</method>
<method name="expose" return="com.google.inject.binder.AnnotatedElementBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Makes a binding for {@code type} available to the enclosing environment. Use {@link
com.google.inject.binder.AnnotatedElementBuilder#annotatedWith(Class) annotatedWith()} to expose {@code type} with a
binding annotation.]]>
</doc>
</method>
<method name="expose" return="com.google.inject.binder.AnnotatedElementBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<?>"/>
<doc>
<![CDATA[Makes a binding for {@code type} available to the enclosing environment. Use {@link
AnnotatedElementBuilder#annotatedWith(Class) annotatedWith()} to expose {@code type} with a
binding annotation.]]>
</doc>
</method>
<method name="withSource" return="com.google.inject.PrivateBinder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="source" type="java.lang.Object"/>
</method>
<method name="skipSources" return="com.google.inject.PrivateBinder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="classesToSkip" type="java.lang.Class[]"/>
</method>
<doc>
<![CDATA[Returns a binder whose configuration information is hidden from its environment by default. See
{@link com.google.inject.PrivateModule PrivateModule} for details.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.PrivateBinder -->
<!-- start class com.google.inject.PrivateModule -->
<class name="PrivateModule" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Module"/>
<constructor name="PrivateModule"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="configure"
abstract="false" native="false" synchronized="true"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<method name="configure"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Creates bindings and other configurations private to this module. Use {@link #expose(Class)
expose()} to make the bindings in this module available externally.]]>
</doc>
</method>
<method name="expose"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Makes the binding for {@code key} available to other modules and the injector.]]>
</doc>
</method>
<method name="expose" return="com.google.inject.binder.AnnotatedElementBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Makes a binding for {@code type} available to other modules and the injector. Use {@link
AnnotatedElementBuilder#annotatedWith(Class) annotatedWith()} to expose {@code type} with a
binding annotation.]]>
</doc>
</method>
<method name="expose" return="com.google.inject.binder.AnnotatedElementBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<?>"/>
<doc>
<![CDATA[Makes a binding for {@code type} available to other modules and the injector. Use {@link
AnnotatedElementBuilder#annotatedWith(Class) annotatedWith()} to expose {@code type} with a
binding annotation.]]>
</doc>
</method>
<method name="binder" return="com.google.inject.PrivateBinder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the current binder.]]>
</doc>
</method>
<method name="bindScope"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="scopeAnnotation" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<param name="scope" type="com.google.inject.Scope"/>
<doc>
<![CDATA[@see Binder#bindScope(Class, Scope)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[@see Binder#bind(Key)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[@see Binder#bind(TypeLiteral)]]>
</doc>
</method>
<method name="bind" return="com.google.inject.binder.AnnotatedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="clazz" type="java.lang.Class<T>"/>
<doc>
<![CDATA[@see Binder#bind(Class)]]>
</doc>
</method>
<method name="bindConstant" return="com.google.inject.binder.AnnotatedConstantBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[@see Binder#bindConstant()]]>
</doc>
</method>
<method name="install"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="module" type="com.google.inject.Module"/>
<doc>
<![CDATA[@see Binder#install(Module)]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="message" type="java.lang.String"/>
<param name="arguments" type="java.lang.Object[]"/>
<doc>
<![CDATA[@see Binder#addError(String, Object[])]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="t" type="java.lang.Throwable"/>
<doc>
<![CDATA[@see Binder#addError(Throwable)]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="message" type="com.google.inject.spi.Message"/>
<doc>
<![CDATA[@see Binder#addError(Message)]]>
</doc>
</method>
<method name="requestInjection"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="instance" type="java.lang.Object"/>
<doc>
<![CDATA[@see Binder#requestInjection(Object)]]>
</doc>
</method>
<method name="requestStaticInjection"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="types" type="java.lang.Class[]"/>
<doc>
<![CDATA[@see Binder#requestStaticInjection(Class[])]]>
</doc>
</method>
<method name="bindInterceptor"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="classMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.Class<?>>"/>
<param name="methodMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.reflect.Method>"/>
<param name="interceptors" type="org.aopalliance.intercept.MethodInterceptor[]"/>
<doc>
<![CDATA[@see Binder#bindInterceptor(com.google.inject.matcher.Matcher, com.google.inject.matcher.Matcher, org.aopalliance.intercept.MethodInterceptor[])]]>
</doc>
</method>
<method name="requireBinding"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<?>"/>
<doc>
<![CDATA[Instructs Guice to require a binding to the given key.]]>
</doc>
</method>
<method name="requireBinding"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Instructs Guice to require a binding to the given type.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[@see Binder#getProvider(Key)]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[@see Binder#getProvider(Class)]]>
</doc>
</method>
<method name="convertToTypes"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="typeMatcher" type="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"/>
<param name="converter" type="com.google.inject.spi.TypeConverter"/>
<doc>
<![CDATA[@see Binder#convertToTypes(com.google.inject.matcher.Matcher, com.google.inject.spi.TypeConverter)]]>
</doc>
</method>
<method name="currentStage" return="com.google.inject.Stage"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[@see Binder#currentStage()]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[@see Binder#getMembersInjector(Class)]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[@see Binder#getMembersInjector(TypeLiteral)]]>
</doc>
</method>
<method name="bindListener"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="typeMatcher" type="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"/>
<param name="listener" type="com.google.inject.spi.TypeListener"/>
<doc>
<![CDATA[@see Binder#bindListener(com.google.inject.matcher.Matcher, com.google.inject.spi.TypeListener)]]>
</doc>
</method>
<doc>
<![CDATA[A module whose configuration information is hidden from its environment by default. Only bindings
that are explicitly exposed will be available to other modules and to the users of the injector.
This module may expose the bindings it creates and the bindings of the modules it installs.
<p>A private module can be nested within a regular module or within another private module using
{@link Binder#install install()}. Its bindings live in a new environment that inherits bindings,
type converters, scopes, and interceptors from the surrounding ("parent") environment. When you
nest multiple private modules, the result is a tree of environments where the injector's
environment is the root.
<p>Guice EDSL bindings can be exposed with {@link #expose(Class) expose()}. {@literal @}{@link
com.google.inject.Provides Provides} bindings can be exposed with the {@literal @}{@link
Exposed} annotation:
<pre>
public class FooBarBazModule extends PrivateModule {
protected void configure() {
bind(Foo.class).to(RealFoo.class);
expose(Foo.class);
install(new TransactionalBarModule());
expose(Bar.class).annotatedWith(Transactional.class);
bind(SomeImplementationDetail.class);
install(new MoreImplementationDetailsModule());
}
{@literal @}Provides {@literal @}Exposed
public Baz provideBaz() {
return new SuperBaz();
}
}
</pre>
<p>Private modules are implemented using {@link Injector#createChildInjector(Module[]) parent
injectors}. When it can satisfy their dependencies, just-in-time bindings will be created in the
root environment. Such bindings are shared among all environments in the tree.
<p>The scope of a binding is constrained to its environment. A singleton bound in a private
module will be unique to its environment. But a binding for the same type in a different private
module will yield a different instance.
<p>A shared binding that injects the {@code Injector} gets the root injector, which only has
access to bindings in the root environment. An explicit binding that injects the {@code Injector}
gets access to all bindings in the child environment.
<p>To promote a just-in-time binding to an explicit binding, bind it:
<pre>
bind(FooImpl.class);
</pre>
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.PrivateModule -->
<!-- start class com.google.inject.ProvidedBy -->
<class name="ProvidedBy" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[A pointer to the default provider type for a type.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.ProvidedBy -->
<!-- start interface com.google.inject.Provider -->
<interface name="Provider" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="get" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Provides an instance of {@code T}. Must never return {@code null}.
@throws OutOfScopeException when an attempt is made to access a scoped object while the scope
in question is not currently active
@throws ProvisionException if an instance cannot be provided. Such exceptions include messages
and throwables to describe why provision failed.]]>
</doc>
</method>
<doc>
<![CDATA[An object capable of providing instances of type {@code T}. Providers are used in numerous ways
by Guice:
<ul>
<li>When the default means for obtaining instances (an injectable or parameterless constructor)
is insufficient for a particular binding, the module can specify a custom {@code Provider}
instead, to control exactly how Guice creates or obtains instances for the binding.
<li>An implementation class may always choose to have a {@code Provider<T>} instance injected,
rather than having a {@code T} injected directly. This may give you access to multiple
instances, instances you wish to safely mutate and discard, instances which are out of scope
(e.g. using a {@code @RequestScoped} object from within a {@code @SessionScoped} object), or
instances that will be initialized lazily.
<li>A custom {@link Scope} is implemented as a decorator of {@code Provider<T>}, which decides
when to delegate to the backing provider and when to provide the instance some other way.
<li>The {@link Injector} offers access to the {@code Provider<T>} it uses to fulfill requests
for a given key, via the {@link Injector#getProvider} methods.
</ul>
@param <T> the type of object this provides
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Provider -->
<!-- start class com.google.inject.Provides -->
<class name="Provides" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates methods of a {@link Module} to create a provider method binding. The method's return
type is bound to it's returned value. Guice will pass dependencies to the method as parameters.
@author crazybob@google.com (Bob Lee)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.Provides -->
<!-- start class com.google.inject.ProvisionException -->
<class name="ProvisionException" extends="java.lang.RuntimeException"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<constructor name="ProvisionException" type="java.lang.Iterable<com.google.inject.spi.Message>"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Creates a ConfigurationException containing {@code messages}.]]>
</doc>
</constructor>
<constructor name="ProvisionException" type="java.lang.String, java.lang.Throwable"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="ProvisionException" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getErrorMessages" return="java.util.Collection<com.google.inject.spi.Message>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns messages for the errors that caused this exception.]]>
</doc>
</method>
<method name="getMessage" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Indicates that there was a runtime failure while providing an instance.
@author kevinb@google.com (Kevin Bourrillion)
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.ProvisionException -->
<!-- start interface com.google.inject.Scope -->
<interface name="Scope" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="scope" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<param name="unscoped" type="com.google.inject.Provider<T>"/>
<doc>
<![CDATA[Scopes a provider. The returned provider returns objects from this scope.
If an object does not exist in this scope, the provider can use the given
unscoped provider to retrieve one.
<p>Scope implementations are strongly encouraged to override
{@link Object#toString} in the returned provider and include the backing
provider's {@code toString()} output.
@param key binding key
@param unscoped locates an instance when one doesn't already exist in this
scope.
@return a new provider which only delegates to the given unscoped provider
when an instance of the requested object doesn't already exist in this
scope]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A short but useful description of this scope. For comparison, the standard
scopes that ship with guice use the descriptions
{@code "Scopes.SINGLETON"}, {@code "ServletScopes.SESSION"} and
{@code "ServletScopes.REQUEST"}.]]>
</doc>
</method>
<doc>
<![CDATA[A scope is a level of visibility that instances provided by Guice may have.
By default, an instance created by the {@link Injector} has <i>no scope</i>,
meaning it has no state from the framework's perspective -- the
{@code Injector} creates it, injects it once into the class that required it,
and then immediately forgets it. Associating a scope with a particular
binding allows the created instance to be "remembered" and possibly used
again for other injections.
<p>An example of a scope is {@link Scopes#SINGLETON}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.Scope -->
<!-- start class com.google.inject.ScopeAnnotation -->
<class name="ScopeAnnotation" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates annotations which are used for scoping. Only one such annotation
may apply to a single implementation class. You must also annotate scope
annotations with {@code @Retention(RUNTIME)}. For example:
<pre>
{@code @}Retention(RUNTIME)
{@code @}Target(TYPE)
{@code @}ScopeAnnotation
public {@code @}interface SessionScoped {}
</pre>
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.ScopeAnnotation -->
<!-- start class com.google.inject.Scopes -->
<class name="Scopes" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<field name="SINGLETON" type="com.google.inject.Scope"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[One instance per {@link Injector}. Also see {@code @}{@link Singleton}.]]>
</doc>
</field>
<field name="NO_SCOPE" type="com.google.inject.Scope"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[No scope; the same as not applying any scope at all. Each time the
Injector obtains an instance of an object with "no scope", it injects this
instance then immediately forgets it. When the next request for the same
binding arrives it will need to obtain the instance over again.
<p>This exists only in case a class has been annotated with a scope
annotation such as {@link Singleton @Singleton}, and you need to override
this to "no scope" in your binding.
@since 2.0]]>
</doc>
</field>
<doc>
<![CDATA[Built-in scope implementations.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.Scopes -->
<!-- start class com.google.inject.Singleton -->
<class name="Singleton" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Apply this to implementation classes when you want only one instance
(per {@link Injector}) to be reused for all injections for that binding.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.Singleton -->
<!-- start class com.google.inject.Stage -->
<class name="Stage" extends="java.lang.Enum<com.google.inject.Stage>"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="values" return="com.google.inject.Stage[]"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="valueOf" return="com.google.inject.Stage"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
</method>
<doc>
<![CDATA[The stage we're running in.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.Stage -->
<!-- start class com.google.inject.TypeLiteral -->
<class name="TypeLiteral" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="TypeLiteral"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs a new type literal. Derives represented class from type
parameter.
<p>Clients create an empty anonymous subclass. Doing so embeds the type
parameter in the anonymous class's type hierarchy so we can reconstitute it
at runtime despite erasure.]]>
</doc>
</constructor>
<method name="getRawType" return="java.lang.Class<? super T>"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the raw (non-generic) type for this type.
@since 2.0]]>
</doc>
</method>
<method name="getType" return="java.lang.reflect.Type"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets underlying {@code Type} instance.]]>
</doc>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
</method>
<method name="get" return="com.google.inject.TypeLiteral<?>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Gets type literal for the given {@code Type} instance.]]>
</doc>
</method>
<method name="get" return="com.google.inject.TypeLiteral<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Gets type literal for the given {@code Class} instance.]]>
</doc>
</method>
<method name="getSupertype" return="com.google.inject.TypeLiteral<?>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="supertype" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Returns the generic form of {@code supertype}. For example, if this is {@code
ArrayList<String>}, this returns {@code Iterable<String>} given the input {@code
Iterable.class}.
@param supertype a superclass of, or interface implemented by, this.
@since 2.0]]>
</doc>
</method>
<method name="getFieldType" return="com.google.inject.TypeLiteral<?>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="field" type="java.lang.reflect.Field"/>
<doc>
<![CDATA[Returns the resolved generic type of {@code field}.
@param field a field defined by this or any superclass.
@since 2.0]]>
</doc>
</method>
<method name="getParameterTypes" return="java.util.List<com.google.inject.TypeLiteral<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="methodOrConstructor" type="java.lang.reflect.Member"/>
<doc>
<![CDATA[Returns the resolved generic parameter types of {@code methodOrConstructor}.
@param methodOrConstructor a method or constructor defined by this or any supertype.
@since 2.0]]>
</doc>
</method>
<method name="getExceptionTypes" return="java.util.List<com.google.inject.TypeLiteral<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="methodOrConstructor" type="java.lang.reflect.Member"/>
<doc>
<![CDATA[Returns the resolved generic exception types thrown by {@code constructor}.
@param methodOrConstructor a method or constructor defined by this or any supertype.
@since 2.0]]>
</doc>
</method>
<method name="getReturnType" return="com.google.inject.TypeLiteral<?>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="method" type="java.lang.reflect.Method"/>
<doc>
<![CDATA[Returns the resolved generic return type of {@code method}.
@param method a method defined by this or any supertype.
@since 2.0]]>
</doc>
</method>
<doc>
<![CDATA[Represents a generic type {@code T}. Java doesn't yet provide a way to
represent generic types, so this class does. Forces clients to create a
subclass of this class which enables retrieval the type information even at
runtime.
<p>For example, to create a type literal for {@code List<String>}, you can
create an empty anonymous inner class:
<p>
{@code TypeLiteral<List<String>> list = new TypeLiteral<List<String>>() {};}
<p>This syntax cannot be used to create type literals that have wildcard
parameters, such as {@code Class<?>} or {@code List<? extends CharSequence>}.
Such type literals must be constructed programatically, either by {@link
Method#getGenericReturnType extracting types from members} or by using the
{@link Types} factory class.
<p>Along with modeling generic types, this class can resolve type parameters.
For example, to figure out what type {@code keySet()} returns on a {@code
Map<Integer, String>}, use this code:<pre> {@code
TypeLiteral<Map<Integer, String>> mapType
= new TypeLiteral<Map<Integer, String>>() {};
TypeLiteral<?> keySetType
= mapType.getReturnType(Map.class.getMethod("keySet"));
System.out.println(keySetType); // prints "Set<Integer>"}</pre>
@author crazybob@google.com (Bob Lee)
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</class>
<!-- end class com.google.inject.TypeLiteral -->
</package>
<package name="com.google.inject.assistedinject">
<!-- start class com.google.inject.assistedinject.Assisted -->
<class name="Assisted" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates an injected parameter or field whose value comes from an argument to a factory method.
@author jmourits@google.com (Jerome Mourits)
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</class>
<!-- end class com.google.inject.assistedinject.Assisted -->
<!-- start class com.google.inject.assistedinject.AssistedInject -->
<class name="AssistedInject" abstract="true"
static="false" final="false" visibility="public"
deprecated="{@link FactoryProvider} now works better with the standard {@literal @Inject}
annotation. When using that annotation, parameters are matched by name and type rather than
by position. In addition, values that use the standard {@literal @Inject} constructor
annotation are eligible for method interception.">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[<p>Constructors annotated with {@code @AssistedInject} indicate that they can be instantiated by
the {@link FactoryProvider}. Each constructor must exactly match one corresponding factory method
within the factory interface.
<p>Constructor parameters must be either supplied by the factory interface and marked with
<code>@Assisted</code>, or they must be injectable.
@deprecated {@link FactoryProvider} now works better with the standard {@literal @Inject}
annotation. When using that annotation, parameters are matched by name and type rather than
by position. In addition, values that use the standard {@literal @Inject} constructor
annotation are eligible for method interception.
@author jmourits@google.com (Jerome Mourits)
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</class>
<!-- end class com.google.inject.assistedinject.AssistedInject -->
<!-- start class com.google.inject.assistedinject.FactoryProvider -->
<class name="FactoryProvider" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Provider<F>"/>
<implements name="com.google.inject.spi.HasDependencies"/>
<method name="newFactory" return="com.google.inject.Provider<F>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="factoryType" type="java.lang.Class<F>"/>
<param name="implementationType" type="java.lang.Class<?>"/>
</method>
<method name="newFactory" return="com.google.inject.Provider<F>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="factoryType" type="com.google.inject.TypeLiteral<F>"/>
<param name="implementationType" type="com.google.inject.TypeLiteral<?>"/>
</method>
<method name="getDependencies" return="java.util.Set<com.google.inject.spi.Dependency<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="get" return="F"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Provides a factory that combines the caller's arguments with injector-supplied values to
construct objects.
<h3>Defining a factory</h3>
Create an interface whose methods return the constructed type, or any of its supertypes. The
method's parameters are the arguments required to build the constructed type.
<pre>public interface PaymentFactory {
Payment create(Date startDate, Money amount);
}</pre>
You can name your factory methods whatever you like, such as <i>create</i>, <i>createPayment</i>
or <i>newPayment</i>.
<h3>Creating a type that accepts factory parameters</h3>
{@code constructedType} is a concrete class with an {@literal @}{@link Inject}-annotated
constructor. In addition to injector-supplied parameters, the constructor should have
parameters that match each of the factory method's parameters. Each factory-supplied parameter
requires an {@literal @}{@link Assisted} annotation. This serves to document that the parameter
is not bound by your application's modules.
<pre>public class RealPayment implements Payment {
{@literal @}Inject
public RealPayment(
CreditService creditService,
AuthService authService,
<strong>{@literal @}Assisted Date startDate</strong>,
<strong>{@literal @}Assisted Money amount</strong>) {
...
}
}</pre>
Any parameter that permits a null value should also be annotated {@code @Nullable}.
<h3>Configuring factories</h3>
In your {@link com.google.inject.Module module}, bind the factory interface to the returned
factory:
<pre>bind(PaymentFactory.class).toProvider(
FactoryProvider.newFactory(PaymentFactory.class, RealPayment.class));</pre>
As a side-effect of this binding, Guice will inject the factory to initialize it for use. The
factory cannot be used until the injector has been initialized.
<h3>Using the factory</h3>
Inject your factory into your application classes. When you use the factory, your arguments
will be combined with values from the injector to construct an instance.
<pre>public class PaymentAction {
{@literal @}Inject private PaymentFactory paymentFactory;
public void doPayment(Money amount) {
Payment payment = paymentFactory.create(new Date(), amount);
payment.apply();
}
}</pre>
<h3>Making parameter types distinct</h3>
The types of the factory method's parameters must be distinct. To use multiple parameters of
the same type, use a named {@literal @}{@link Assisted} annotation to disambiguate the
parameters. The names must be applied to the factory method's parameters:
<pre>public interface PaymentFactory {
Payment create(
<strong>{@literal @}Assisted("startDate")</strong> Date startDate,
<strong>{@literal @}Assisted("dueDate")</strong> Date dueDate,
Money amount);
} </pre>
...and to the concrete type's constructor parameters:
<pre>public class RealPayment implements Payment {
{@literal @}Inject
public RealPayment(
CreditService creditService,
AuthService authService,
<strong>{@literal @}Assisted("startDate")</strong> Date startDate,
<strong>{@literal @}Assisted("dueDate")</strong> Date dueDate,
<strong>{@literal @}Assisted</strong> Money amount) {
...
}
}</pre>
<h3>Values are created by Guice</h3>
Returned factories use child injectors to create values. The values are eligible for method
interception. In addition, {@literal @}{@literal Inject} members will be injected before they are
returned.
<h3>Backwards compatibility using {@literal @}AssistedInject</h3>
Instead of the {@literal @}Inject annotation, you may annotate the constructed classes with
{@literal @}{@link AssistedInject}. This triggers a limited backwards-compatability mode.
<p>Instead of matching factory method arguments to constructor parameters using their names, the
<strong>parameters are matched by their order</strong>. The first factory method argument is
used for the first {@literal @}Assisted constructor parameter, etc.. Annotation names have no
effect.
<p>Returned values are <strong>not created by Guice</strong>. These types are not eligible for
method interception. They do receive post-construction member injection.
@param <F> The factory interface
@author jmourits@google.com (Jerome Mourits)
@author jessewilson@google.com (Jesse Wilson)
@author dtm@google.com (Daniel Martin)]]>
</doc>
</class>
<!-- end class com.google.inject.assistedinject.FactoryProvider -->
</package>
<package name="com.google.inject.binder">
<!-- start interface com.google.inject.binder.AnnotatedBindingBuilder -->
<interface name="AnnotatedBindingBuilder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.binder.LinkedBindingBuilder<T>"/>
<method name="annotatedWith" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="annotatedWith" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.binder.AnnotatedBindingBuilder -->
<!-- start interface com.google.inject.binder.AnnotatedConstantBindingBuilder -->
<interface name="AnnotatedConstantBindingBuilder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="annotatedWith" return="com.google.inject.binder.ConstantBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="annotatedWith" return="com.google.inject.binder.ConstantBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.binder.AnnotatedConstantBindingBuilder -->
<!-- start interface com.google.inject.binder.AnnotatedElementBuilder -->
<interface name="AnnotatedElementBuilder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="annotatedWith"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="annotatedWith"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.binder.AnnotatedElementBuilder -->
<!-- start interface com.google.inject.binder.ConstantBindingBuilder -->
<interface name="ConstantBindingBuilder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="java.lang.String"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="int"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="long"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="boolean"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="double"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="float"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="short"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="char"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<method name="to"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="E extends java.lang.Enum<E>"/>
<doc>
<![CDATA[Binds constant to the given value.]]>
</doc>
</method>
<doc>
<![CDATA[Binds to a constant value.]]>
</doc>
</interface>
<!-- end interface com.google.inject.binder.ConstantBindingBuilder -->
<!-- start interface com.google.inject.binder.LinkedBindingBuilder -->
<interface name="LinkedBindingBuilder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.binder.ScopedBindingBuilder"/>
<method name="to" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="implementation" type="java.lang.Class<? extends T>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="to" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="implementation" type="com.google.inject.TypeLiteral<? extends T>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="to" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="targetKey" type="com.google.inject.Key<? extends T>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="toInstance"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="instance" type="T"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.
@see com.google.inject.Injector#injectMembers]]>
</doc>
</method>
<method name="toProvider" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="provider" type="com.google.inject.Provider<? extends T>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.
@see com.google.inject.Injector#injectMembers]]>
</doc>
</method>
<method name="toProvider" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerType" type="java.lang.Class<? extends com.google.inject.Provider<? extends T>>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="toProvider" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerKey" type="com.google.inject.Key<? extends com.google.inject.Provider<? extends T>>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.binder.LinkedBindingBuilder -->
<!-- start interface com.google.inject.binder.ScopedBindingBuilder -->
<interface name="ScopedBindingBuilder" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="in"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="scopeAnnotation" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="in"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="scope" type="com.google.inject.Scope"/>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.]]>
</doc>
</method>
<method name="asEagerSingleton"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Instructs the {@link com.google.inject.Injector} to eagerly initialize this
singleton-scoped binding upon creation. Useful for application
initialization logic. See the EDSL examples at
{@link com.google.inject.Binder}.]]>
</doc>
</method>
<doc>
<![CDATA[See the EDSL examples at {@link com.google.inject.Binder}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.binder.ScopedBindingBuilder -->
</package>
<package name="com.google.inject.jndi">
<!-- start class com.google.inject.jndi.JndiIntegration -->
<class name="JndiIntegration" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="fromJndi" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Creates a provider which looks up objects in JNDI using the given name.
Example usage:
<pre>
bind(DataSource.class).toProvider(fromJndi(DataSource.class, "java:..."));
</pre>]]>
</doc>
</method>
<doc>
<![CDATA[Integrates Guice with JNDI. Requires a binding to
{@link javax.naming.Context}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.jndi.JndiIntegration -->
</package>
<package name="com.google.inject.matcher">
<!-- start class com.google.inject.matcher.AbstractMatcher -->
<class name="AbstractMatcher" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.matcher.Matcher<T>"/>
<constructor name="AbstractMatcher"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="and" return="com.google.inject.matcher.Matcher<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="other" type="com.google.inject.matcher.Matcher<? super T>"/>
</method>
<method name="or" return="com.google.inject.matcher.Matcher<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="other" type="com.google.inject.matcher.Matcher<? super T>"/>
</method>
<doc>
<![CDATA[Implements {@code and()} and {@code or()}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.matcher.AbstractMatcher -->
<!-- start interface com.google.inject.matcher.Matcher -->
<interface name="Matcher" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="matches" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="t" type="T"/>
<doc>
<![CDATA[Returns {@code true} if this matches {@code t}, {@code false} otherwise.]]>
</doc>
</method>
<method name="and" return="com.google.inject.matcher.Matcher<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="other" type="com.google.inject.matcher.Matcher<? super T>"/>
<doc>
<![CDATA[Returns a new matcher which returns {@code true} if both this and the
given matcher return {@code true}.]]>
</doc>
</method>
<method name="or" return="com.google.inject.matcher.Matcher<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="other" type="com.google.inject.matcher.Matcher<? super T>"/>
<doc>
<![CDATA[Returns a new matcher which returns {@code true} if either this or the
given matcher return {@code true}.]]>
</doc>
</method>
<doc>
<![CDATA[Returns {@code true} or {@code false} for a given input.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.matcher.Matcher -->
<!-- start class com.google.inject.matcher.Matchers -->
<class name="Matchers" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="any" return="com.google.inject.matcher.Matcher<java.lang.Object>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a matcher which matches any input.]]>
</doc>
</method>
<method name="not" return="com.google.inject.matcher.Matcher<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="com.google.inject.matcher.Matcher<? super T>"/>
<doc>
<![CDATA[Inverts the given matcher.]]>
</doc>
</method>
<method name="annotatedWith" return="com.google.inject.matcher.Matcher<java.lang.reflect.AnnotatedElement>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Returns a matcher which matches elements (methods, classes, etc.)
with a given annotation.]]>
</doc>
</method>
<method name="annotatedWith" return="com.google.inject.matcher.Matcher<java.lang.reflect.AnnotatedElement>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Returns a matcher which matches elements (methods, classes, etc.)
with a given annotation.]]>
</doc>
</method>
<method name="subclassesOf" return="com.google.inject.matcher.Matcher<java.lang.Class>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="superclass" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Returns a matcher which matches subclasses of the given type (as well as
the given type).]]>
</doc>
</method>
<method name="only" return="com.google.inject.matcher.Matcher<java.lang.Object>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="java.lang.Object"/>
<doc>
<![CDATA[Returns a matcher which matches objects equal to the given object.]]>
</doc>
</method>
<method name="identicalTo" return="com.google.inject.matcher.Matcher<java.lang.Object>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="java.lang.Object"/>
<doc>
<![CDATA[Returns a matcher which matches only the given object.]]>
</doc>
</method>
<method name="inPackage" return="com.google.inject.matcher.Matcher<java.lang.Class>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="targetPackage" type="java.lang.Package"/>
<doc>
<![CDATA[Returns a matcher which matches classes in the given package. Packages are specific to their
classloader, so classes with the same package name may not have the same package at runtime.]]>
</doc>
</method>
<method name="inSubpackage" return="com.google.inject.matcher.Matcher<java.lang.Class>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="targetPackageName" type="java.lang.String"/>
<doc>
<![CDATA[Returns a matcher which matches classes in the given package and its subpackages. Unlike
{@link #inPackage(Package) inPackage()}, this matches classes from any classloader.
@since 2.0]]>
</doc>
</method>
<method name="returns" return="com.google.inject.matcher.Matcher<java.lang.reflect.Method>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="returnType" type="com.google.inject.matcher.Matcher<? super java.lang.Class<?>>"/>
<doc>
<![CDATA[Returns a matcher which matches methods with matching return types.]]>
</doc>
</method>
<doc>
<![CDATA[Matcher implementations. Supports matching classes and methods.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.matcher.Matchers -->
</package>
<package name="com.google.inject.multibindings">
<!-- start class com.google.inject.multibindings.MapBinder -->
<class name="MapBinder" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="newMapBinder" return="com.google.inject.multibindings.MapBinder<K, V>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="keyType" type="com.google.inject.TypeLiteral<K>"/>
<param name="valueType" type="com.google.inject.TypeLiteral<V>"/>
<doc>
<![CDATA[Returns a new mapbinder that collects entries of {@code keyType}/{@code valueType} in a
{@link Map} that is itself bound with no binding annotation.]]>
</doc>
</method>
<method name="newMapBinder" return="com.google.inject.multibindings.MapBinder<K, V>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="keyType" type="java.lang.Class<K>"/>
<param name="valueType" type="java.lang.Class<V>"/>
<doc>
<![CDATA[Returns a new mapbinder that collects entries of {@code keyType}/{@code valueType} in a
{@link Map} that is itself bound with no binding annotation.]]>
</doc>
</method>
<method name="newMapBinder" return="com.google.inject.multibindings.MapBinder<K, V>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="keyType" type="com.google.inject.TypeLiteral<K>"/>
<param name="valueType" type="com.google.inject.TypeLiteral<V>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Returns a new mapbinder that collects entries of {@code keyType}/{@code valueType} in a
{@link Map} that is itself bound with {@code annotation}.]]>
</doc>
</method>
<method name="newMapBinder" return="com.google.inject.multibindings.MapBinder<K, V>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="keyType" type="java.lang.Class<K>"/>
<param name="valueType" type="java.lang.Class<V>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Returns a new mapbinder that collects entries of {@code keyType}/{@code valueType} in a
{@link Map} that is itself bound with {@code annotation}.]]>
</doc>
</method>
<method name="newMapBinder" return="com.google.inject.multibindings.MapBinder<K, V>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="keyType" type="com.google.inject.TypeLiteral<K>"/>
<param name="valueType" type="com.google.inject.TypeLiteral<V>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Returns a new mapbinder that collects entries of {@code keyType}/{@code valueType} in a
{@link Map} that is itself bound with {@code annotationType}.]]>
</doc>
</method>
<method name="newMapBinder" return="com.google.inject.multibindings.MapBinder<K, V>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="keyType" type="java.lang.Class<K>"/>
<param name="valueType" type="java.lang.Class<V>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Returns a new mapbinder that collects entries of {@code keyType}/{@code valueType} in a
{@link Map} that is itself bound with {@code annotationType}.]]>
</doc>
</method>
<method name="addBinding" return="com.google.inject.binder.LinkedBindingBuilder<V>"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="K"/>
<doc>
<![CDATA[Returns a binding builder used to add a new entry in the map. Each
key must be distinct (and non-null). Bound providers will be evaluated each
time the map is injected.
<p>It is an error to call this method without also calling one of the
{@code to} methods on the returned binding builder.
<p>Scoping elements independently is supported. Use the {@code in} method
to specify a binding scope.]]>
</doc>
</method>
<doc>
<![CDATA[An API to bind multiple map entries separately, only to later inject them as
a complete map. MapBinder is intended for use in your application's module:
<pre><code>
public class SnacksModule extends AbstractModule {
protected void configure() {
MapBinder<String, Snack> mapbinder
= MapBinder.newMapBinder(binder(), String.class, Snack.class);
mapbinder.addBinding("twix").toInstance(new Twix());
mapbinder.addBinding("snickers").toProvider(SnickersProvider.class);
mapbinder.addBinding("skittles").to(Skittles.class);
}
}</code></pre>
<p>With this binding, a {@link Map}{@code <String, Snack>} can now be
injected:
<pre><code>
class SnackMachine {
{@literal @}Inject
public SnackMachine(Map<String, Snack> snacks) { ... }
}</code></pre>
<p>In addition to binding {@code Map<K, V>}, a mapbinder will also bind
{@code Map<K, Provider<V>>} for lazy value provision:
<pre><code>
class SnackMachine {
{@literal @}Inject
public SnackMachine(Map<String, Provider<Snack>> snackProviders) { ... }
}</code></pre>
<p>Creating mapbindings from different modules is supported. For example, it
is okay to have both {@code CandyModule} and {@code ChipsModule} both
create their own {@code MapBinder<String, Snack>}, and to each contribute
bindings to the snacks map. When that map is injected, it will contain
entries from both modules.
<p>Values are resolved at map injection time. If a value is bound to a
provider, that provider's get method will be called each time the map is
injected (unless the binding is also scoped, or a map of providers is injected).
<p>Annotations are used to create different maps of the same key/value
type. Each distinct annotation gets its own independent map.
<p><strong>Keys must be distinct.</strong> If the same key is bound more than
once, map injection will fail.
<p><strong>Keys must be non-null.</strong> {@code addBinding(null)} will
throw an unchecked exception.
<p><strong>Values must be non-null to use map injection.</strong> If any
value is null, map injection will fail (although injecting a map of providers
will not).
@author dpb@google.com (David P. Baker)]]>
</doc>
</class>
<!-- end class com.google.inject.multibindings.MapBinder -->
<!-- start class com.google.inject.multibindings.Multibinder -->
<class name="Multibinder" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="newSetBinder" return="com.google.inject.multibindings.Multibinder<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Returns a new multibinder that collects instances of {@code type} in a {@link Set} that is
itself bound with no binding annotation.]]>
</doc>
</method>
<method name="newSetBinder" return="com.google.inject.multibindings.Multibinder<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns a new multibinder that collects instances of {@code type} in a {@link Set} that is
itself bound with no binding annotation.]]>
</doc>
</method>
<method name="newSetBinder" return="com.google.inject.multibindings.Multibinder<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Returns a new multibinder that collects instances of {@code type} in a {@link Set} that is
itself bound with {@code annotation}.]]>
</doc>
</method>
<method name="newSetBinder" return="com.google.inject.multibindings.Multibinder<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="type" type="java.lang.Class<T>"/>
<param name="annotation" type="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Returns a new multibinder that collects instances of {@code type} in a {@link Set} that is
itself bound with {@code annotation}.]]>
</doc>
</method>
<method name="newSetBinder" return="com.google.inject.multibindings.Multibinder<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="type" type="com.google.inject.TypeLiteral<T>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Returns a new multibinder that collects instances of {@code type} in a {@link Set} that is
itself bound with {@code annotationType}.]]>
</doc>
</method>
<method name="newSetBinder" return="com.google.inject.multibindings.Multibinder<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="type" type="java.lang.Class<T>"/>
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Returns a new multibinder that collects instances of {@code type} in a {@link Set} that is
itself bound with {@code annotationType}.]]>
</doc>
</method>
<method name="addBinding" return="com.google.inject.binder.LinkedBindingBuilder<T>"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a binding builder used to add a new element in the set. Each
bound element must have a distinct value. Bound providers will be
evaluated each time the set is injected.
<p>It is an error to call this method without also calling one of the
{@code to} methods on the returned binding builder.
<p>Scoping elements independently is supported. Use the {@code in} method
to specify a binding scope.]]>
</doc>
</method>
<doc>
<![CDATA[An API to bind multiple values separately, only to later inject them as a
complete collection. Multibinder is intended for use in your application's
module:
<pre><code>
public class SnacksModule extends AbstractModule {
protected void configure() {
Multibinder<Snack> multibinder
= Multibinder.newSetBinder(binder(), Snack.class);
multibinder.addBinding().toInstance(new Twix());
multibinder.addBinding().toProvider(SnickersProvider.class);
multibinder.addBinding().to(Skittles.class);
}
}</code></pre>
<p>With this binding, a {@link Set}{@code <Snack>} can now be injected:
<pre><code>
class SnackMachine {
{@literal @}Inject
public SnackMachine(Set<Snack> snacks) { ... }
}</code></pre>
<p>Create multibindings from different modules is supported. For example, it
is okay to have both {@code CandyModule} and {@code ChipsModule} to both
create their own {@code Multibinder<Snack>}, and to each contribute bindings
to the set of snacks. When that set is injected, it will contain elements
from both modules.
<p>Elements are resolved at set injection time. If an element is bound to a
provider, that provider's get method will be called each time the set is
injected (unless the binding is also scoped).
<p>Annotations are be used to create different sets of the same element
type. Each distinct annotation gets its own independent collection of
elements.
<p><strong>Elements must be distinct.</strong> If multiple bound elements
have the same value, set injection will fail.
<p><strong>Elements must be non-null.</strong> If any set element is null,
set injection will fail.
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</class>
<!-- end class com.google.inject.multibindings.Multibinder -->
</package>
<package name="com.google.inject.name">
<!-- start class com.google.inject.name.Named -->
<class name="Named" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Annotates named things.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.name.Named -->
<!-- start class com.google.inject.name.Names -->
<class name="Names" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="named" return="com.google.inject.name.Named"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Creates a {@link Named} annotation with {@code name} as the value.]]>
</doc>
</method>
<method name="bindProperties"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="properties" type="java.util.Map<java.lang.String, java.lang.String>"/>
<doc>
<![CDATA[Creates a constant binding to {@code @Named(key)} for each entry in
{@code properties}.]]>
</doc>
</method>
<method name="bindProperties"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="properties" type="java.util.Properties"/>
<doc>
<![CDATA[Creates a constant binding to {@code @Named(key)} for each property. This
method binds all properties including those inherited from
{@link Properties#defaults defaults}.]]>
</doc>
</method>
<doc>
<![CDATA[Utility methods for use with {@code @}{@link Named}.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.name.Names -->
</package>
<package name="com.google.inject.servlet">
<!-- start class com.google.inject.servlet.GuiceFilter -->
<class name="GuiceFilter" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GuiceFilter"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="doFilter"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="servletRequest" type="ServletRequest"/>
<param name="servletResponse" type="ServletResponse"/>
<param name="filterChain" type="FilterChain"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="ServletException" type="ServletException"/>
</method>
<method name="init"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="filterConfig" type="FilterConfig"/>
<exception name="ServletException" type="ServletException"/>
</method>
<method name="destroy"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[<p>
Apply this filter in web.xml above all other filters (typically), to all requests where you plan
to use servlet scopes. This is also needed in order to dispatch requests to injectable filters
and servlets:
<pre>
<filter>
<filter-name>guiceFilter</filter-name>
<filter-class><b>com.google.inject.servlet.GuiceFilter</b></filter-class>
</filter>
<filter-mapping>
<filter-name>guiceFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</pre>
This filter must appear before every filter that makes use of Guice injection or servlet
scopes functionality. Typically, you will only register this filter in web.xml and register
any other filters (and servlets) using a {@link ServletModule}.
@author crazybob@google.com (Bob Lee)
@author dhanji@gmail.com (Dhanji R. Prasanna)]]>
</doc>
</class>
<!-- end class com.google.inject.servlet.GuiceFilter -->
<!-- start class com.google.inject.servlet.GuiceServletContextListener -->
<class name="GuiceServletContextListener" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GuiceServletContextListener"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="contextInitialized"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="servletContextEvent" type="ServletContextEvent"/>
</method>
<method name="contextDestroyed"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="servletContextEvent" type="ServletContextEvent"/>
</method>
<method name="getInjector" return="com.google.inject.Injector"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Override this method to create (or otherwise obtain a reference to) your
injector.]]>
</doc>
</method>
<doc>
<![CDATA[As of Guice 2.0 you can still use (your subclasses of) {@code GuiceServletContextListener}
class as a logical place to create and configure your injector. This will ensure the injector
is created when the web application is deployed.
@author Kevin Bourrillion (kevinb@google.com)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.servlet.GuiceServletContextListener -->
<!-- start class com.google.inject.servlet.RequestParameters -->
<class name="RequestParameters" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Apply this to field or parameters of type {@code Map<String, String[]>}
when you want the HTTP request parameter map to be injected.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.servlet.RequestParameters -->
<!-- start class com.google.inject.servlet.RequestScoped -->
<class name="RequestScoped" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Apply this to implementation classes when you want one instance per request.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.servlet.RequestScoped -->
<!-- start class com.google.inject.servlet.ServletModule -->
<class name="ServletModule" extends="com.google.inject.AbstractModule"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ServletModule"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="configure"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
</method>
<method name="configureServlets"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[<h3>Servlet Mapping EDSL</h3>
<p> Part of the EDSL builder language for configuring servlets
and filters with guice-servlet. Think of this as an in-code replacement for web.xml.
Filters and servlets are configured here using simple java method calls. Here is a typical
example of registering a filter when creating your Guice injector:
<pre>
Guice.createInjector(..., new ServletModule() {
{@literal @}Override
protected void configureServlets() {
<b>serve("*.html").with(MyServlet.class)</b>
}
}
</pre>
This registers a servlet (subclass of {@code HttpServlet}) called {@code MyServlet} to service
any web pages ending in {@code .html}. You can also use a path-style syntax to register
servlets:
<pre>
<b>serve("/my/*").with(MyServlet.class)</b>
</pre>
Every servlet (or filter) is required to be a singleton. If you cannot annotate the class
directly, you should add a separate {@code bind(..).in(Singleton.class)} rule elsewhere in
your module. Mapping a servlet that is bound under any other scope is an error.
<p>
<h4>Dispatch Order</h4>
You are free to register as many servlets and filters as you like this way. They will
be compared and dispatched in the order in which the filter methods are called:
<pre>
Guice.createInjector(..., new ServletModule() {
{@literal @}Override
protected void configureServlets() {
filter("/*").through(MyFilter.class);
filter("*.css").through(MyCssFilter.class);
// etc..
serve("*.html").with(MyServlet.class);
serve("/my/*").with(MyServlet.class);
// etc..
}
}
</pre>
This will traverse down the list of rules in lexical order. For example, a url
"{@code /my/file.js}" (after it runs through the matching filters) will first
be compared against the servlet mapping:
<pre>
serve("*.html").with(MyServlet.class);
</pre>
And failing that, it will descend to the next servlet mapping:
<pre>
serve("/my/*").with(MyServlet.class);
</pre>
Since this rule matches, Guice Servlet will dispatch to {@code MyServlet}. These
two mapping rules can also be written in more compact form using varargs syntax:
<pre>
serve(<b>"*.html", "/my/*"</b>).with(MyServlet.class);
</pre>
This way you can map several URI patterns to the same servlet. A similar syntax is
also available for filter mappings.
<p>
<h4>Regular Expressions</h4>
You can also map servlets (or filters) to URIs using regular expressions:
<pre>
<b>serveRegex("(.)*ajax(.)*").with(MyAjaxServlet.class)</b>
</pre>
This will map any URI containing the text "ajax" in it to {@code MyAjaxServlet}. Such as:
<ul>
<li>http://www.google.com/ajax.html</li>
<li>http://www.google.com/content/ajax/index</li>
<li>http://www.google.com/it/is_totally_ajaxian</li>
</ul>
<h3>Initialization Parameters</h3>
Servlets (and filters) allow you to pass in init params
using the {@code <init-param>} tag in web.xml. You can similarly pass in parameters to
Servlets and filters registered in Guice-servlet using a {@link java.util.Map} of parameter
name/value pairs. For example, to initialize {@code MyServlet} with two parameters
({@code name="Dhanji", site="google.com"}) you could write:
<pre>
Map<String, String> params = new HashMap<String, String>();
params.put("name", "Dhanji");
params.put("site", "google.com");
...
serve("/*").with(MyServlet.class, <b>params</b>)
</pre>
<p>
<h3>Binding Keys</h3>
You can also bind keys rather than classes. This lets you hide
implementations with package-local visbility and expose them using
only a Guice module and an annotation:
<pre>
...
filter("/*").through(<b>Key.get(Filter.class, Fave.class)</b>);
</pre>
Where {@code Filter.class} refers to the Servlet API interface and {@code Fave.class} is a
custom binding annotation. Elsewhere (in one of your own modules) you can bind this
filter's implementation:
<pre>
bind(Filter.class)<b>.annotatedWith(Fave.class)</b>.to(MyFilterImpl.class);
</pre>
See {@link com.google.inject.Binder} for more information on binding syntax.
<p>
<h3>Multiple Modules</h3>
It is sometimes useful to capture servlet and filter mappings from multiple different
modules. This is essential if you want to package and offer drop-in Guice plugins that
provide servlet functionality.
<p>
Guice Servlet allows you to register several instances of {@code ServletModule} to your
injector. The order in which these modules are installed determines the dispatch order
of filters and the precedence order of servlets. For example, if you had two servlet modules,
{@code RpcModule} and {@code WebServiceModule} and they each contained a filter that mapped
to the same URI pattern, {@code "/*"}:
<p>
In {@code RpcModule}:
<pre>
filter("/*").through(RpcFilter.class);
</pre>
In {@code WebServiceModule}:
<pre>
filter("/*").through(WebServiceFilter.class);
</pre>
Then the order in which these filters are dispatched is determined by the order in which
the modules are installed:
<pre>
<b>install(new WebServiceModule());</b>
install(new RpcModule());
</pre>
In the case shown above {@code WebServiceFilter} will run first.
@since 2.0]]>
</doc>
</method>
<method name="filter" return="com.google.inject.servlet.ServletModule.FilterKeyBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="urlPattern" type="java.lang.String"/>
<param name="morePatterns" type="java.lang.String[]"/>
<doc>
<![CDATA[@param urlPattern Any Servlet-style pattern. examples: /*, /html/*, *.html, etc.
@since 2.0]]>
</doc>
</method>
<method name="filterRegex" return="com.google.inject.servlet.ServletModule.FilterKeyBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="regex" type="java.lang.String"/>
<param name="regexes" type="java.lang.String[]"/>
<doc>
<![CDATA[@param regex Any Java-style regular expression.
@since 2.0]]>
</doc>
</method>
<method name="serve" return="com.google.inject.servlet.ServletModule.ServletKeyBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="urlPattern" type="java.lang.String"/>
<param name="morePatterns" type="java.lang.String[]"/>
<doc>
<![CDATA[@param urlPattern Any Servlet-style pattern. examples: /*, /html/*, *.html, etc.
@since 2.0]]>
</doc>
</method>
<method name="serveRegex" return="com.google.inject.servlet.ServletModule.ServletKeyBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="protected"
deprecated="not deprecated">
<param name="regex" type="java.lang.String"/>
<param name="regexes" type="java.lang.String[]"/>
<doc>
<![CDATA[@param regex Any Java-style regular expression.
@since 2.0]]>
</doc>
</method>
<doc>
<![CDATA[Configures the servlet scopes and creates bindings for the servlet API
objects so you can inject the request, response, session, etc.
<p>
You should subclass this module to register servlets and
filters in the {@link #configureServlets()} method.
@author crazybob@google.com (Bob Lee)
@author dhanji@gmail.com (Dhanji R. Prasanna)]]>
</doc>
</class>
<!-- end class com.google.inject.servlet.ServletModule -->
<!-- start interface com.google.inject.servlet.ServletModule.FilterKeyBindingBuilder -->
<interface name="ServletModule.FilterKeyBindingBuilder" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<method name="through"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="filterKey" type="java.lang.Class<? extends Filter>"/>
</method>
<method name="through"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="filterKey" type="com.google.inject.Key<? extends Filter>"/>
</method>
<method name="through"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dummyFilterClass" type="java.lang.Class<? extends Filter>"/>
<param name="contextParams" type="java.util.Map<java.lang.String, java.lang.String>"/>
</method>
<method name="through"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dummyFilterClass" type="com.google.inject.Key<? extends Filter>"/>
<param name="contextParams" type="java.util.Map<java.lang.String, java.lang.String>"/>
</method>
<doc>
<![CDATA[See the EDSL examples at {@link ServletModule#configureServlets()}
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.servlet.ServletModule.FilterKeyBindingBuilder -->
<!-- start interface com.google.inject.servlet.ServletModule.ServletKeyBindingBuilder -->
<interface name="ServletModule.ServletKeyBindingBuilder" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<method name="with"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="servletKey" type="java.lang.Class<? extends HttpServlet>"/>
</method>
<method name="with"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="servletKey" type="com.google.inject.Key<? extends HttpServlet>"/>
</method>
<method name="with"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="servletKey" type="java.lang.Class<? extends HttpServlet>"/>
<param name="contextParams" type="java.util.Map<java.lang.String, java.lang.String>"/>
</method>
<method name="with"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="servletKey" type="com.google.inject.Key<? extends HttpServlet>"/>
<param name="contextParams" type="java.util.Map<java.lang.String, java.lang.String>"/>
</method>
<doc>
<![CDATA[See the EDSL examples at {@link ServletModule#configureServlets()}
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.servlet.ServletModule.ServletKeyBindingBuilder -->
<!-- start class com.google.inject.servlet.ServletScopes -->
<class name="ServletScopes" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<field name="REQUEST" type="com.google.inject.Scope"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[HTTP servlet request scope.]]>
</doc>
</field>
<field name="SESSION" type="com.google.inject.Scope"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[HTTP session scope.]]>
</doc>
</field>
<doc>
<![CDATA[Servlet scopes.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.servlet.ServletScopes -->
<!-- start class com.google.inject.servlet.SessionScoped -->
<class name="SessionScoped" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.annotation.Annotation"/>
<doc>
<![CDATA[Apply this to implementation classes when you want one instance per session.
@see com.google.inject.Scopes#SINGLETON
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.servlet.SessionScoped -->
</package>
<package name="com.google.inject.spi">
<!-- start interface com.google.inject.spi.BindingScopingVisitor -->
<interface name="BindingScopingVisitor" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="visitEagerSingleton" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Visit an eager singleton or single instance. This scope strategy is found on both module and
injector bindings.]]>
</doc>
</method>
<method name="visitScope" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="scope" type="com.google.inject.Scope"/>
<doc>
<![CDATA[Visit a scope instance. This scope strategy is found on both module and injector bindings.]]>
</doc>
</method>
<method name="visitScopeAnnotation" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="scopeAnnotation" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
<doc>
<![CDATA[Visit a scope annotation. This scope strategy is found only on module bindings. The instance
that implements this scope is registered by {@link com.google.inject.Binder#bindScope(Class,
Scope) Binder.bindScope()}.]]>
</doc>
</method>
<method name="visitNoScoping" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Visit an unspecified or unscoped strategy. On a module, this strategy indicates that the
injector should use scoping annotations to find a scope. On an injector, it indicates that
no scope is applied to the binding. An unscoped binding will behave like a scoped one when it
is linked to a scoped binding.]]>
</doc>
</method>
<doc>
<![CDATA[Visits each of the strategies used to scope an injection.
@param <V> any type to be returned by the visit method. Use {@link Void} with
{@code return null} if no return type is needed.
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.BindingScopingVisitor -->
<!-- start interface com.google.inject.spi.BindingTargetVisitor -->
<interface name="BindingTargetVisitor" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.InstanceBinding<? extends T>"/>
<doc>
<![CDATA[Visit a instance binding. The same instance is returned for every injection. This target is
found in both module and injector bindings.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.ProviderInstanceBinding<? extends T>"/>
<doc>
<![CDATA[Visit a provider instance binding. The provider's {@code get} method is invoked to resolve
injections. This target is found in both module and injector bindings.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.ProviderKeyBinding<? extends T>"/>
<doc>
<![CDATA[Visit a provider key binding. To resolve injections, the provider key is first resolved, then
that provider's {@code get} method is invoked. This target is found in both module and injector
bindings.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.LinkedKeyBinding<? extends T>"/>
<doc>
<![CDATA[Visit a linked key binding. The other key's binding is used to resolve injections. This
target is found in both module and injector bindings.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.ExposedBinding<? extends T>"/>
<doc>
<![CDATA[Visit a binding to a key exposed from an enclosed private environment. This target is only
found in injector bindings.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.UntargettedBinding<? extends T>"/>
<doc>
<![CDATA[Visit an untargetted binding. This target is found only on module bindings. It indicates
that the injector should use its implicit binding strategies to resolve injections.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.ConstructorBinding<? extends T>"/>
<doc>
<![CDATA[Visit a constructor binding. To resolve injections, an instance is instantiated by invoking
{@code constructor}. This target is found only on injector bindings.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.ConvertedConstantBinding<? extends T>"/>
<doc>
<![CDATA[Visit a binding created from converting a bound instance to a new type. The source binding
has the same binding annotation but a different type. This target is found only on injector
bindings.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.ProviderBinding<? extends T>"/>
<doc>
<![CDATA[Visit a binding to a {@link com.google.inject.Provider} that delegates to the binding for the
provided type. This target is found only on injector bindings.]]>
</doc>
</method>
<doc>
<![CDATA[Visits each of the strategies used to find an instance to satisfy an injection.
@param <V> any type to be returned by the visit method. Use {@link Void} with
{@code return null} if no return type is needed.
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.BindingTargetVisitor -->
<!-- start interface com.google.inject.spi.ConstructorBinding -->
<interface name="ConstructorBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<implements name="com.google.inject.spi.HasDependencies"/>
<method name="getConstructor" return="com.google.inject.spi.InjectionPoint"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the constructor this binding injects.]]>
</doc>
</method>
<method name="getInjectableMembers" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns all instance method and field injection points on {@code type}.
@return a possibly empty set of injection points. The set has a specified iteration order. All
fields are returned and then all methods. Within the fields, supertype fields are returned
before subtype fields. Similarly, supertype methods are returned before subtype methods.]]>
</doc>
</method>
<method name="getMethodInterceptors" return="java.util.Map<java.lang.reflect.Method, java.util.List<org.aopalliance.intercept.MethodInterceptor>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the interceptors applied to each method, in the order that they will be applied.
@return a possibly empty map]]>
</doc>
</method>
<doc>
<![CDATA[A binding to the constructor of a concrete clss. To resolve injections, an instance is
instantiated by invoking the constructor.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ConstructorBinding -->
<!-- start interface com.google.inject.spi.ConvertedConstantBinding -->
<interface name="ConvertedConstantBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<implements name="com.google.inject.spi.HasDependencies"/>
<method name="getValue" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the converted value.]]>
</doc>
</method>
<method name="getSourceKey" return="com.google.inject.Key<java.lang.String>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the key for the source binding. That binding can e retrieved from an injector using
{@link com.google.inject.Injector#getBinding(Key) Injector.getBinding(key)}.]]>
</doc>
</method>
<method name="getDependencies" return="java.util.Set<com.google.inject.spi.Dependency<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a singleton set containing only the converted key.]]>
</doc>
</method>
<doc>
<![CDATA[A binding created from converting a bound instance to a new type. The source binding has the same
binding annotation but a different type.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ConvertedConstantBinding -->
<!-- start class com.google.inject.spi.DefaultBindingScopingVisitor -->
<class name="DefaultBindingScopingVisitor" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.BindingScopingVisitor<V>"/>
<constructor name="DefaultBindingScopingVisitor"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="visitOther" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<doc>
<![CDATA[Default visit implementation. Returns {@code null}.]]>
</doc>
</method>
<method name="visitEagerSingleton" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="visitScope" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="scope" type="com.google.inject.Scope"/>
</method>
<method name="visitScopeAnnotation" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="scopeAnnotation" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
</method>
<method name="visitNoScoping" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[No-op visitor for subclassing. All interface methods simply delegate to
{@link #visitOther()}, returning its result.
@param <V> any type to be returned by the visit method. Use {@link Void} with
{@code return null} if no return type is needed.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.DefaultBindingScopingVisitor -->
<!-- start class com.google.inject.spi.DefaultBindingTargetVisitor -->
<class name="DefaultBindingTargetVisitor" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.BindingTargetVisitor<T, V>"/>
<constructor name="DefaultBindingTargetVisitor"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="visitOther" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.Binding<? extends T>"/>
<doc>
<![CDATA[Default visit implementation. Returns {@code null}.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="instanceBinding" type="com.google.inject.spi.InstanceBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerInstanceBinding" type="com.google.inject.spi.ProviderInstanceBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerKeyBinding" type="com.google.inject.spi.ProviderKeyBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="linkedKeyBinding" type="com.google.inject.spi.LinkedKeyBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="exposedBinding" type="com.google.inject.spi.ExposedBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="untargettedBinding" type="com.google.inject.spi.UntargettedBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="constructorBinding" type="com.google.inject.spi.ConstructorBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="convertedConstantBinding" type="com.google.inject.spi.ConvertedConstantBinding<? extends T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerBinding" type="com.google.inject.spi.ProviderBinding<? extends T>"/>
</method>
<doc>
<![CDATA[No-op visitor for subclassing. All interface methods simply delegate to {@link
#visitOther(Binding)}, returning its result.
@param <V> any type to be returned by the visit method. Use {@link Void} with
{@code return null} if no return type is needed.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.DefaultBindingTargetVisitor -->
<!-- start class com.google.inject.spi.DefaultElementVisitor -->
<class name="DefaultElementVisitor" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.ElementVisitor<V>"/>
<constructor name="DefaultElementVisitor"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="visitOther" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="element" type="com.google.inject.spi.Element"/>
<doc>
<![CDATA[Default visit implementation. Returns {@code null}.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="message" type="com.google.inject.spi.Message"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.Binding<T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="interceptorBinding" type="com.google.inject.spi.InterceptorBinding"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="scopeBinding" type="com.google.inject.spi.ScopeBinding"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeConverterBinding" type="com.google.inject.spi.TypeConverterBinding"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerLookup" type="com.google.inject.spi.ProviderLookup<T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="injectionRequest" type="com.google.inject.spi.InjectionRequest"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="staticInjectionRequest" type="com.google.inject.spi.StaticInjectionRequest"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="privateElements" type="com.google.inject.spi.PrivateElements"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="lookup" type="com.google.inject.spi.MembersInjectorLookup<T>"/>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.TypeListenerBinding"/>
</method>
<doc>
<![CDATA[No-op visitor for subclassing. All interface methods simply delegate to
{@link #visitOther(Element)}, returning its result.
@param <V> any type to be returned by the visit method. Use {@link Void} with
{@code return null} if no return type is needed.
@author sberlin@gmail.com (Sam Berlin)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.DefaultElementVisitor -->
<!-- start class com.google.inject.spi.Dependency -->
<class name="Dependency" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="get" return="com.google.inject.spi.Dependency<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Returns a new dependency that is not attached to an injection point. The returned dependency is
nullable.]]>
</doc>
</method>
<method name="forInjectionPoints" return="java.util.Set<com.google.inject.spi.Dependency<?>>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="injectionPoints" type="java.util.Set<com.google.inject.spi.InjectionPoint>"/>
<doc>
<![CDATA[Returns the dependencies from the given injection points.]]>
</doc>
</method>
<method name="getKey" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the key to the binding that satisfies this dependency.]]>
</doc>
</method>
<method name="isNullable" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns true if null is a legal value for this dependency.]]>
</doc>
</method>
<method name="getInjectionPoint" return="com.google.inject.spi.InjectionPoint"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the injection point to which this dependency belongs, or null if this dependency isn't
attached to a particular injection point.]]>
</doc>
</method>
<method name="getParameterIndex" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the index of this dependency in the injection point's parameter list, or {@code -1} if
this dependency does not belong to a parameter list. Only method and constuctor dependencies
are elements in a parameter list.]]>
</doc>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[A variable that can be resolved by an injector.
<p>Use {@link #get} to build a freestanding dependency, or {@link InjectionPoint} to build one
that's attached to a constructor, method or field.
@author crazybob@google.com (Bob Lee)
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.Dependency -->
<!-- start interface com.google.inject.spi.Element -->
<interface name="Element" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns an arbitrary object containing information about the "place" where this element was
configured. Used by Guice in the production of descriptive error messages.
<p>Tools might specially handle types they know about; {@code StackTraceElement} is a good
example. Tools should simply call {@code toString()} on the source object if the type is
unfamiliar.]]>
</doc>
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
<doc>
<![CDATA[Accepts an element visitor. Invokes the visitor method specific to this element's type.
@param visitor to call back on]]>
</doc>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<doc>
<![CDATA[Writes this module element to the given binder (optional operation).
@param binder to apply configuration element to
@throws UnsupportedOperationException if the {@code applyTo} method is not supported by this
element.]]>
</doc>
</method>
<doc>
<![CDATA[A core component of a module or injector.
<p>The elements of a module can be inspected, validated and rewritten. Use {@link
Elements#getElements(com.google.inject.Module[]) Elements.getElements()} to read the elements
from a module, and {@link Elements#getModule(Iterable) Elements.getModule()} to rewrite them.
This can be used for static analysis and generation of Guice modules.
<p>The elements of an injector can be inspected and exercised. Use {@link
com.google.inject.Injector#getBindings Injector.getBindings()} to reflect on Guice injectors.
@author jessewilson@google.com (Jesse Wilson)
@author crazybob@google.com (Bob Lee)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.Element -->
<!-- start class com.google.inject.spi.Elements -->
<class name="Elements" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<constructor name="Elements"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getElements" return="java.util.List<com.google.inject.spi.Element>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Records the elements executed by {@code modules}.]]>
</doc>
</method>
<method name="getElements" return="java.util.List<com.google.inject.spi.Element>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stage" type="com.google.inject.Stage"/>
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Records the elements executed by {@code modules}.]]>
</doc>
</method>
<method name="getElements" return="java.util.List<com.google.inject.spi.Element>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[Records the elements executed by {@code modules}.]]>
</doc>
</method>
<method name="getElements" return="java.util.List<com.google.inject.spi.Element>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="stage" type="com.google.inject.Stage"/>
<param name="modules" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[Records the elements executed by {@code modules}.]]>
</doc>
</method>
<method name="getModule" return="com.google.inject.Module"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="elements" type="java.lang.Iterable<? extends com.google.inject.spi.Element>"/>
<doc>
<![CDATA[Returns the module composed of {@code elements}.]]>
</doc>
</method>
<doc>
<![CDATA[Exposes elements of a module so they can be inspected, validated or {@link
Element#applyTo(Binder) rewritten}.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.Elements -->
<!-- start interface com.google.inject.spi.ElementVisitor -->
<interface name="ElementVisitor" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.Binding<T>"/>
<doc>
<![CDATA[Visit a mapping from a key (type and optional annotation) to the strategy for getting
instances of the type.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.InterceptorBinding"/>
<doc>
<![CDATA[Visit a registration of interceptors for matching methods of matching classes.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.ScopeBinding"/>
<doc>
<![CDATA[Visit a registration of a scope annotation with the scope that implements it.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.TypeConverterBinding"/>
<doc>
<![CDATA[Visit a registration of type converters for matching target types.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="com.google.inject.spi.InjectionRequest"/>
<doc>
<![CDATA[Visit a request to inject the instance fields and methods of an instance.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="request" type="com.google.inject.spi.StaticInjectionRequest"/>
<doc>
<![CDATA[Visit a request to inject the static fields and methods of type.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="lookup" type="com.google.inject.spi.ProviderLookup<T>"/>
<doc>
<![CDATA[Visit a lookup of the provider for a type.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="lookup" type="com.google.inject.spi.MembersInjectorLookup<T>"/>
<doc>
<![CDATA[Visit a lookup of the members injector.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="message" type="com.google.inject.spi.Message"/>
<doc>
<![CDATA[Visit an error message and the context in which it occured.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="elements" type="com.google.inject.spi.PrivateElements"/>
<doc>
<![CDATA[Visit a collection of configuration elements for a {@linkplain com.google.inject.PrivateBinder
private binder}.]]>
</doc>
</method>
<method name="visit" return="V"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binding" type="com.google.inject.spi.TypeListenerBinding"/>
<doc>
<![CDATA[Visit an injectable type listener binding.]]>
</doc>
</method>
<doc>
<![CDATA[Visit elements.
@param <V> any type to be returned by the visit method. Use {@link Void} with
{@code return null} if no return type is needed.
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ElementVisitor -->
<!-- start interface com.google.inject.spi.ExposedBinding -->
<interface name="ExposedBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<implements name="com.google.inject.spi.HasDependencies"/>
<method name="getPrivateElements" return="com.google.inject.spi.PrivateElements"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the enclosed environment that holds the original binding.]]>
</doc>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<doc>
<![CDATA[Unsupported. Always throws {@link UnsupportedOperationException}.]]>
</doc>
</method>
<doc>
<![CDATA[A binding to a key exposed from an enclosed private environment.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ExposedBinding -->
<!-- start interface com.google.inject.spi.HasDependencies -->
<interface name="HasDependencies" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getDependencies" return="java.util.Set<com.google.inject.spi.Dependency<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the known dependencies for this type. If this has dependencies whose values are not
known statically, a dependency for the {@link com.google.inject.Injector Injector} will be
included in the returned set.
@return a possibly empty set]]>
</doc>
</method>
<doc>
<![CDATA[Implemented by {@link com.google.inject.Binding bindings}, {@link com.google.inject.Provider
providers} and instances that expose their dependencies explicitly.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.HasDependencies -->
<!-- start interface com.google.inject.spi.InjectionListener -->
<interface name="InjectionListener" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="afterInjection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="injectee" type="I"/>
<doc>
<![CDATA[Invoked by Guice after it injects the fields and methods of instance.
@param injectee instance that Guice injected dependencies into]]>
</doc>
</method>
<doc>
<![CDATA[Listens for injections into instances of type {@code I}. Useful for performing further
injections, post-injection initialization, and more.
@author crazybob@google.com (Bob Lee)
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.InjectionListener -->
<!-- start class com.google.inject.spi.InjectionPoint -->
<class name="InjectionPoint" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="getMember" return="java.lang.reflect.Member"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the injected constructor, field, or method.]]>
</doc>
</method>
<method name="getDependencies" return="java.util.List<com.google.inject.spi.Dependency<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the dependencies for this injection point. If the injection point is for a method or
constructor, the dependencies will correspond to that member's parameters. Field injection
points always have a single dependency for the field itself.
@return a possibly-empty list]]>
</doc>
</method>
<method name="isOptional" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns true if this injection point shall be skipped if the injector cannot resolve bindings
for all required dependencies. Both explicit bindings (as specified in a module), and implicit
bindings ({@literal @}{@link com.google.inject.ImplementedBy ImplementedBy}, default
constructors etc.) may be used to satisfy optional injection points.]]>
</doc>
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="forConstructorOf" return="com.google.inject.spi.InjectionPoint"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<?>"/>
<doc>
<![CDATA[Returns a new injection point for the injectable constructor of {@code type}.
@param type a concrete type with exactly one constructor annotated {@literal @}{@link Inject},
or a no-arguments constructor that is not private.
@throws ConfigurationException if there is no injectable constructor, more than one injectable
constructor, or if parameters of the injectable constructor are malformed, such as a
parameter with multiple binding annotations.]]>
</doc>
</method>
<method name="forConstructorOf" return="com.google.inject.spi.InjectionPoint"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Returns a new injection point for the injectable constructor of {@code type}.
@param type a concrete type with exactly one constructor annotated {@literal @}{@link Inject},
or a no-arguments constructor that is not private.
@throws ConfigurationException if there is no injectable constructor, more than one injectable
constructor, or if parameters of the injectable constructor are malformed, such as a
parameter with multiple binding annotations.]]>
</doc>
</method>
<method name="forStaticMethodsAndFields" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral"/>
<doc>
<![CDATA[Returns all static method and field injection points on {@code type}.
@return a possibly empty set of injection points. The set has a specified iteration order. All
fields are returned and then all methods. Within the fields, supertype fields are returned
before subtype fields. Similarly, supertype methods are returned before subtype methods.
@throws ConfigurationException if there is a malformed injection point on {@code type}, such as
a field with multiple binding annotations. The exception's {@link
ConfigurationException#getPartialValue() partial value} is a {@code Set<InjectionPoint>}
of the valid injection points.]]>
</doc>
</method>
<method name="forStaticMethodsAndFields" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Returns all static method and field injection points on {@code type}.
@return a possibly empty set of injection points. The set has a specified iteration order. All
fields are returned and then all methods. Within the fields, supertype fields are returned
before subtype fields. Similarly, supertype methods are returned before subtype methods.
@throws ConfigurationException if there is a malformed injection point on {@code type}, such as
a field with multiple binding annotations. The exception's {@link
ConfigurationException#getPartialValue() partial value} is a {@code Set<InjectionPoint>}
of the valid injection points.]]>
</doc>
</method>
<method name="forInstanceMethodsAndFields" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<?>"/>
<doc>
<![CDATA[Returns all instance method and field injection points on {@code type}.
@return a possibly empty set of injection points. The set has a specified iteration order. All
fields are returned and then all methods. Within the fields, supertype fields are returned
before subtype fields. Similarly, supertype methods are returned before subtype methods.
@throws ConfigurationException if there is a malformed injection point on {@code type}, such as
a field with multiple binding annotations. The exception's {@link
ConfigurationException#getPartialValue() partial value} is a {@code Set<InjectionPoint>}
of the valid injection points.]]>
</doc>
</method>
<method name="forInstanceMethodsAndFields" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<?>"/>
<doc>
<![CDATA[Returns all instance method and field injection points on {@code type}.
@return a possibly empty set of injection points. The set has a specified iteration order. All
fields are returned and then all methods. Within the fields, supertype fields are returned
before subtype fields. Similarly, supertype methods are returned before subtype methods.
@throws ConfigurationException if there is a malformed injection point on {@code type}, such as
a field with multiple binding annotations. The exception's {@link
ConfigurationException#getPartialValue() partial value} is a {@code Set<InjectionPoint>}
of the valid injection points.]]>
</doc>
</method>
<doc>
<![CDATA[A constructor, field or method that can receive injections. Typically this is a member with the
{@literal @}{@link Inject} annotation. For non-private, no argument constructors, the member may
omit the annotation.
@author crazybob@google.com (Bob Lee)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.InjectionPoint -->
<!-- start class com.google.inject.spi.InjectionRequest -->
<class name="InjectionRequest" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<constructor name="InjectionRequest" type="java.lang.Object, com.google.inject.TypeLiteral<T>, T"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getInstance" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getType" return="com.google.inject.TypeLiteral<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getInjectionPoints" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="ConfigurationException" type="com.google.inject.ConfigurationException"/>
<doc>
<![CDATA[Returns the instance methods and fields of {@code instance} that will be injected to fulfill
this request.
@return a possibly empty set of injection points. The set has a specified iteration order. All
fields are returned and then all methods. Within the fields, supertype fields are returned
before subtype fields. Similarly, supertype methods are returned before subtype methods.
@throws ConfigurationException if there is a malformed injection point on the class of {@code
instance}, such as a field with multiple binding annotations. The exception's {@link
ConfigurationException#getPartialValue() partial value} is a {@code Set<InjectionPoint>}
of the valid injection points.]]>
</doc>
</method>
<method name="acceptVisitor" return="R"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<R>"/>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<doc>
<![CDATA[A request to inject the instance fields and methods of an instance. Requests are created
explicitly in a module using {@link com.google.inject.Binder#requestInjection(Object)
requestInjection()} statements:
<pre>
requestInjection(serviceInstance);</pre>
@author mikeward@google.com (Mike Ward)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.InjectionRequest -->
<!-- start interface com.google.inject.spi.InstanceBinding -->
<interface name="InstanceBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<implements name="com.google.inject.spi.HasDependencies"/>
<method name="getInstance" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the user-supplied instance.]]>
</doc>
</method>
<method name="getInjectionPoints" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the field and method injection points of the instance, injected at injector-creation
time only.
@return a possibly empty set]]>
</doc>
</method>
<doc>
<![CDATA[A binding to a single instance. The same instance is returned for every injection.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.InstanceBinding -->
<!-- start class com.google.inject.spi.InterceptorBinding -->
<class name="InterceptorBinding" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getClassMatcher" return="com.google.inject.matcher.Matcher<? super java.lang.Class<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getMethodMatcher" return="com.google.inject.matcher.Matcher<? super java.lang.reflect.Method>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getInterceptors" return="java.util.List<MethodInterceptor>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<doc>
<![CDATA[Registration of interceptors for matching methods of matching classes. Instances are created
explicitly in a module using {@link com.google.inject.Binder#bindInterceptor(
Matcher, Matcher, MethodInterceptor[]) bindInterceptor()} statements:
<pre>
bindInterceptor(Matchers.subclassesOf(MyAction.class),
Matchers.annotatedWith(Transactional.class),
new MyTransactionInterceptor());</pre>
or from an injectable type listener using {@link TypeEncounter#bindInterceptor(Matcher,
org.aopalliance.intercept.MethodInterceptor[]) TypeEncounter.bindInterceptor()}.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.InterceptorBinding -->
<!-- start interface com.google.inject.spi.LinkedKeyBinding -->
<interface name="LinkedKeyBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<method name="getLinkedKey" return="com.google.inject.Key<? extends T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the linked key used to resolve injections. That binding can be retrieved from an
injector using {@link com.google.inject.Injector#getBinding(Key) Injector.getBinding(key)}.]]>
</doc>
</method>
<doc>
<![CDATA[A binding to a linked key. The other key's binding is used to resolve injections.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.LinkedKeyBinding -->
<!-- start class com.google.inject.spi.MembersInjectorLookup -->
<class name="MembersInjectorLookup" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<constructor name="MembersInjectorLookup" type="java.lang.Object, com.google.inject.TypeLiteral<T>"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getType" return="com.google.inject.TypeLiteral<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the type containing the members to be injected.]]>
</doc>
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
</method>
<method name="initializeDelegate"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delegate" type="com.google.inject.MembersInjector<T>"/>
<doc>
<![CDATA[Sets the actual members injector.
@throws IllegalStateException if the delegate is already set]]>
</doc>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<method name="getDelegate" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the delegate members injector, or {@code null} if it has not yet been initialized.
The delegate will be initialized when this element is processed, or otherwise used to create
an injector.]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the looked up members injector. The result is not valid until this lookup has been
initialized, which usually happens when the injector is created. The members injector will
throw an {@code IllegalStateException} if you try to use it beforehand.]]>
</doc>
</method>
<doc>
<![CDATA[A lookup of the members injector for a type. Lookups are created explicitly in a module using
{@link com.google.inject.Binder#getMembersInjector(Class) getMembersInjector()} statements:
<pre>
MembersInjector<PaymentService> membersInjector
= getMembersInjector(PaymentService.class);</pre>
@author crazybob@google.com (Bob Lee)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.MembersInjectorLookup -->
<!-- start class com.google.inject.spi.Message -->
<class name="Message" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="java.io.Serializable"/>
<implements name="com.google.inject.spi.Element"/>
<constructor name="Message" type="java.util.List<java.lang.Object>, java.lang.String, java.lang.Throwable"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@since 2.0]]>
</doc>
</constructor>
<constructor name="Message" type="java.lang.Object, java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<constructor name="Message" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getSource" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getSources" return="java.util.List<java.lang.Object>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[@since 2.0]]>
</doc>
</method>
<method name="getMessage" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the error message text.]]>
</doc>
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
<doc>
<![CDATA[@since 2.0]]>
</doc>
</method>
<method name="getCause" return="java.lang.Throwable"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the throwable that caused this message, or {@code null} if this
message was not caused by a throwable.
@since 2.0]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="hashCode" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="equals" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="o" type="java.lang.Object"/>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<doc>
<![CDATA[@since 2.0]]>
</doc>
</method>
<doc>
<![CDATA[An error message and the context in which it occured. Messages are usually created internally by
Guice and its extensions. Messages can be created explicitly in a module using {@link
com.google.inject.Binder#addError(Throwable) addError()} statements:
<pre>
try {
bindPropertiesFromFile();
} catch (IOException e) {
addError(e);
}</pre>
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.spi.Message -->
<!-- start interface com.google.inject.spi.PrivateElements -->
<interface name="PrivateElements" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<method name="getElements" return="java.util.List<com.google.inject.spi.Element>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the configuration information in this private environment.]]>
</doc>
</method>
<method name="getInjector" return="com.google.inject.Injector"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the child injector that hosts these private elements, or null if the elements haven't
been used to create an injector.]]>
</doc>
</method>
<method name="getExposedKeys" return="java.util.Set<com.google.inject.Key<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the unique exposed keys for these private elements.]]>
</doc>
</method>
<method name="getExposedSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<?>"/>
<doc>
<![CDATA[Returns an arbitrary object containing information about the "place" where this key was
exposed. Used by Guice in the production of descriptive error messages.
<p>Tools might specially handle types they know about; {@code StackTraceElement} is a good
example. Tools should simply call {@code toString()} on the source object if the type is
unfamiliar.
@param key one of the keys exposed by this module.]]>
</doc>
</method>
<doc>
<![CDATA[A private collection of elements that are hidden from the enclosing injector or module by
default. See {@link com.google.inject.PrivateModule PrivateModule} for details.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.PrivateElements -->
<!-- start interface com.google.inject.spi.ProviderBinding -->
<interface name="ProviderBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<method name="getProvidedKey" return="com.google.inject.Key<?>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the key whose binding is used to {@link Provider#get provide instances}. That binding
can be retrieved from an injector using {@link com.google.inject.Injector#getBinding(Key)
Injector.getBinding(providedKey)}]]>
</doc>
</method>
<doc>
<![CDATA[A binding to a {@link Provider} that delegates to the binding for the provided type. This binding
is used whenever a {@code Provider<T>} is injected (as opposed to injecting {@code T} directly).
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ProviderBinding -->
<!-- start interface com.google.inject.spi.ProviderInstanceBinding -->
<interface name="ProviderInstanceBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<implements name="com.google.inject.spi.HasDependencies"/>
<method name="getProviderInstance" return="com.google.inject.Provider<? extends T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the user-supplied, unscoped provider.]]>
</doc>
</method>
<method name="getInjectionPoints" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the field and method injection points of the provider, injected at injector-creation
time only.
@return a possibly empty set]]>
</doc>
</method>
<doc>
<![CDATA[A binding to a provider instance. The provider's {@code get} method is invoked to resolve
injections.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ProviderInstanceBinding -->
<!-- start interface com.google.inject.spi.ProviderKeyBinding -->
<interface name="ProviderKeyBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<method name="getProviderKey" return="com.google.inject.Key<? extends com.google.inject.Provider<? extends T>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the key used to resolve the provider's binding. That binding can be retrieved from an
injector using {@link com.google.inject.Injector#getBinding(Key)
Injector.getBinding(providerKey)}]]>
</doc>
</method>
<doc>
<![CDATA[A binding to a provider key. To resolve injections, the provider key is first resolved, then that
provider's {@code get} method is invoked.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ProviderKeyBinding -->
<!-- start class com.google.inject.spi.ProviderLookup -->
<class name="ProviderLookup" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<constructor name="ProviderLookup" type="java.lang.Object, com.google.inject.Key<T>"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getKey" return="com.google.inject.Key<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
</method>
<method name="initializeDelegate"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="delegate" type="com.google.inject.Provider<T>"/>
<doc>
<![CDATA[Sets the actual provider.
@throws IllegalStateException if the delegate is already set]]>
</doc>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<method name="getDelegate" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the delegate provider, or {@code null} if it has not yet been initialized. The delegate
will be initialized when this element is processed, or otherwise used to create an injector.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the looked up provider. The result is not valid until this lookup has been initialized,
which usually happens when the injector is created. The provider will throw an {@code
IllegalStateException} if you try to use it beforehand.]]>
</doc>
</method>
<doc>
<![CDATA[A lookup of the provider for a type. Lookups are created explicitly in a module using
{@link com.google.inject.Binder#getProvider(Class) getProvider()} statements:
<pre>
Provider<PaymentService> paymentServiceProvider
= getProvider(PaymentService.class);</pre>
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.ProviderLookup -->
<!-- start interface com.google.inject.spi.ProviderWithDependencies -->
<interface name="ProviderWithDependencies" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Provider<T>"/>
<implements name="com.google.inject.spi.HasDependencies"/>
<doc>
<![CDATA[A provider with dependencies on other injected types. If a {@link Provider} has dependencies that
aren't specified in injections, this interface should be used to expose all dependencies.
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.ProviderWithDependencies -->
<!-- start class com.google.inject.spi.ScopeBinding -->
<class name="ScopeBinding" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getAnnotationType" return="java.lang.Class<? extends java.lang.annotation.Annotation>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getScope" return="com.google.inject.Scope"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<doc>
<![CDATA[Registration of a scope annotation with the scope that implements it. Instances are created
explicitly in a module using {@link com.google.inject.Binder#bindScope(Class, Scope) bindScope()}
statements:
<pre>
Scope recordScope = new RecordScope();
bindScope(RecordScoped.class, new RecordScope());</pre>
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.ScopeBinding -->
<!-- start class com.google.inject.spi.StaticInjectionRequest -->
<class name="StaticInjectionRequest" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getType" return="java.lang.Class<?>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getInjectionPoints" return="java.util.Set<com.google.inject.spi.InjectionPoint>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="ConfigurationException" type="com.google.inject.ConfigurationException"/>
<doc>
<![CDATA[Returns the static methods and fields of {@code type} that will be injected to fulfill this
request.
@return a possibly empty set of injection points. The set has a specified iteration order. All
fields are returned and then all methods. Within the fields, supertype fields are returned
before subtype fields. Similarly, supertype methods are returned before subtype methods.
@throws ConfigurationException if there is a malformed injection point on {@code type}, such as
a field with multiple binding annotations. The exception's {@link
ConfigurationException#getPartialValue() partial value} is a {@code Set<InjectionPoint>}
of the valid injection points.]]>
</doc>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
</method>
<doc>
<![CDATA[A request to inject the static fields and methods of a type. Requests are created
explicitly in a module using {@link com.google.inject.Binder#requestStaticInjection(Class[])
requestStaticInjection()} statements:
<pre>
requestStaticInjection(MyLegacyService.class);</pre>
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.StaticInjectionRequest -->
<!-- start interface com.google.inject.spi.TypeConverter -->
<interface name="TypeConverter" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="convert" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="value" type="java.lang.String"/>
<param name="toType" type="com.google.inject.TypeLiteral<?>"/>
<doc>
<![CDATA[Converts a string value. Throws an exception if a conversion error occurs.]]>
</doc>
</method>
<doc>
<![CDATA[Converts constant string values to a different type.
@author crazybob@google.com (Bob Lee)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.TypeConverter -->
<!-- start class com.google.inject.spi.TypeConverterBinding -->
<class name="TypeConverterBinding" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getTypeMatcher" return="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getTypeConverter" return="com.google.inject.spi.TypeConverter"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<doc>
<![CDATA[Registration of type converters for matching target types. Instances are created
explicitly in a module using {@link com.google.inject.Binder#convertToTypes(Matcher,
TypeConverter) convertToTypes()} statements:
<pre>
convertToTypes(Matchers.only(DateTime.class), new DateTimeConverter());</pre>
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.TypeConverterBinding -->
<!-- start interface com.google.inject.spi.TypeEncounter -->
<interface name="TypeEncounter" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="message" type="java.lang.String"/>
<param name="arguments" type="java.lang.Object[]"/>
<doc>
<![CDATA[Records an error message for type {@code I} which will be presented to the user at a later
time. Unlike throwing an exception, this enable us to continue configuring the Injector and
discover more errors. Uses {@link String#format(String, Object[])} to insert the arguments
into the message.]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="t" type="java.lang.Throwable"/>
<doc>
<![CDATA[Records an exception for type {@code I}, the full details of which will be logged, and the
message of which will be presented to the user at a later time. If your type listener calls
something that you worry may fail, you should catch the exception and pass it to this method.]]>
</doc>
</method>
<method name="addError"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="message" type="com.google.inject.spi.Message"/>
<doc>
<![CDATA[Records an error message to be presented to the user at a later time.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="com.google.inject.Key<T>"/>
<doc>
<![CDATA[Returns the provider used to obtain instances for the given injection key. The returned
provider will not be valid until the injector has been created. The provider will throw an
{@code IllegalStateException} if you try to use it beforehand.]]>
</doc>
</method>
<method name="getProvider" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the provider used to obtain instances for the given injection type. The returned
provider will not be valid until the injetor has been created. The provider will throw an
{@code IllegalStateException} if you try to use it beforehand.]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="typeLiteral" type="com.google.inject.TypeLiteral<T>"/>
<doc>
<![CDATA[Returns the members injector used to inject dependencies into methods and fields on instances
of the given type {@code T}. The returned members injector will not be valid until the main
injector has been created. The members injector will throw an {@code IllegalStateException}
if you try to use it beforehand.
@param typeLiteral type to get members injector for]]>
</doc>
</method>
<method name="getMembersInjector" return="com.google.inject.MembersInjector<T>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<doc>
<![CDATA[Returns the members injector used to inject dependencies into methods and fields on instances
of the given type {@code T}. The returned members injector will not be valid until the main
injector has been created. The members injector will throw an {@code IllegalStateException}
if you try to use it beforehand.
@param type type to get members injector for]]>
</doc>
</method>
<method name="register"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="membersInjector" type="com.google.inject.MembersInjector<? super I>"/>
<doc>
<![CDATA[Registers a members injector for type {@code I}. Guice will use the members injector after its
performed its own injections on an instance of {@code I}.]]>
</doc>
</method>
<method name="register"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="listener" type="com.google.inject.spi.InjectionListener<? super I>"/>
<doc>
<![CDATA[Registers an injection listener for type {@code I}. Guice will notify the listener after all
injections have been performed on an instance of {@code I}.]]>
</doc>
</method>
<method name="bindInterceptor"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="methodMatcher" type="com.google.inject.matcher.Matcher<? super java.lang.reflect.Method>"/>
<param name="interceptors" type="org.aopalliance.intercept.MethodInterceptor[]"/>
<doc>
<![CDATA[Binds method interceptor[s] to methods matched in type {@code I} and its supertypes. A
method is eligible for interception if:
<ul>
<li>Guice created the instance the method is on</li>
<li>Neither the enclosing type nor the method is final</li>
<li>And the method is package-private or more accessible</li>
</ul>
@param methodMatcher matches methods the interceptor should apply to. For
example: {@code annotatedWith(Transactional.class)}.
@param interceptors to bind]]>
</doc>
</method>
<doc>
<![CDATA[Context of an injectable type encounter. Enables reporting errors, registering injection
listeners and binding method interceptors for injectable type {@code I}. It is an error to use
an encounter after the {@link TypeListener#hear(TypeLiteral, TypeEncounter) hear()} method has
returned.
@param <I> the injectable type encountered
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.TypeEncounter -->
<!-- start interface com.google.inject.spi.TypeListener -->
<interface name="TypeListener" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="hear"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="com.google.inject.TypeLiteral<I>"/>
<param name="encounter" type="com.google.inject.spi.TypeEncounter<I>"/>
<doc>
<![CDATA[Invoked when Guice encounters a new type eligible for constructor or members injection.
Called during injector creation (or afterwords if Guice encounters a type at run time and
creates a JIT binding).
@param type encountered by Guice
@param encounter context of this encounter, enables reporting errors, registering injection
listeners and binding method interceptors for {@code type}.
@param <I> the injectable type]]>
</doc>
</method>
<doc>
<![CDATA[Listens for Guice to encounter injectable types. If a given type has its constructor injected in
one situation but only its methods and fields injected in another, Guice will notify this
listener once.
<p>Useful for extra type checking, {@linkplain TypeEncounter#register(InjectionListener)
registering injection listeners}, and {@linkplain TypeEncounter#bindInterceptor(
com.google.inject.matcher.Matcher, org.aopalliance.intercept.MethodInterceptor[])
binding method interceptors}.
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.TypeListener -->
<!-- start class com.google.inject.spi.TypeListenerBinding -->
<class name="TypeListenerBinding" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.spi.Element"/>
<method name="getListener" return="com.google.inject.spi.TypeListener"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the registered listener.]]>
</doc>
</method>
<method name="getTypeMatcher" return="com.google.inject.matcher.Matcher<? super com.google.inject.TypeLiteral<?>>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns the type matcher which chooses which types the listener should be notified of.]]>
</doc>
</method>
<method name="getSource" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="acceptVisitor" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="visitor" type="com.google.inject.spi.ElementVisitor<T>"/>
</method>
<method name="applyTo"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<doc>
<![CDATA[Binds types (picked using a Matcher) to an type listener. Registrations are created explicitly in
a module using {@link com.google.inject.Binder#bindListener(Matcher, TypeListener)} statements:
<pre>
register(only(new TypeLiteral<PaymentService<CreditCard>>() {}), listener);</pre>
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.spi.TypeListenerBinding -->
<!-- start interface com.google.inject.spi.UntargettedBinding -->
<interface name="UntargettedBinding" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="com.google.inject.Binding<T>"/>
<doc>
<![CDATA[An untargetted binding. This binding indicates that the injector should use its implicit binding
strategies to resolve injections.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</interface>
<!-- end interface com.google.inject.spi.UntargettedBinding -->
</package>
<package name="com.google.inject.spring">
<!-- start class com.google.inject.spring.SpringIntegration -->
<class name="SpringIntegration" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="fromSpring" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="type" type="java.lang.Class<T>"/>
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Creates a provider which looks up objects from Spring using the given name.
Expects a binding to {@link
org.springframework.beans.factory.BeanFactory}. Example usage:
<pre>
bind(DataSource.class)
.toProvider(fromSpring(DataSource.class, "dataSource"));
</pre>]]>
</doc>
</method>
<method name="bindAll"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
<param name="beanFactory" type="ListableBeanFactory"/>
<doc>
<![CDATA[Binds all Spring beans from the given factory by name. For a Spring bean
named "foo", this method creates a binding to the bean's type and
{@code @Named("foo")}.
@see com.google.inject.name.Named
@see com.google.inject.name.Names#named(String)]]>
</doc>
</method>
<doc>
<![CDATA[Integrates Guice with Spring.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.spring.SpringIntegration -->
</package>
<package name="com.google.inject.struts2">
<!-- start class com.google.inject.struts2.GuiceObjectFactory -->
<class name="GuiceObjectFactory" extends="ObjectFactory"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="GuiceObjectFactory"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="isNoArgConstructorRequired" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getClassInstance" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
</method>
<method name="buildBean" return="java.lang.Object"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="clazz" type="java.lang.Class"/>
<param name="extraContext" type="java.util.Map"/>
</method>
<method name="buildInterceptor" return="Interceptor"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="interceptorConfig" type="InterceptorConfig"/>
<param name="interceptorRefParams" type="java.util.Map"/>
<exception name="ConfigurationException" type="ConfigurationException"/>
</method>
</class>
<!-- end class com.google.inject.struts2.GuiceObjectFactory -->
</package>
<package name="com.google.inject.throwingproviders">
<!-- start interface com.google.inject.throwingproviders.ThrowingProvider -->
<interface name="ThrowingProvider" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="get" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="Exception" type="java.lang.Exception"/>
</method>
<doc>
<![CDATA[Alternative to the Guice {@link com.google.inject.Provider} that throws
a checked Exception. Users may not inject {@code T} directly.
<p>This interface must be extended to use application-specific exception types.
Such subinterfaces may not define new methods:
<pre>
public interface RemoteProvider<T> extends ThrowingProvider<T, RemoteException> { }
</pre>
<p>When this type is bound using {@link ThrowingProviderBinder}, the value returned
or exception thrown by {@link #get} will be scoped. As a consequence, {@link #get}
will invoked at most once within each scope.
@author jmourits@google.com (Jerome Mourits)
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</interface>
<!-- end interface com.google.inject.throwingproviders.ThrowingProvider -->
<!-- start class com.google.inject.throwingproviders.ThrowingProviderBinder -->
<class name="ThrowingProviderBinder" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="create" return="com.google.inject.throwingproviders.ThrowingProviderBinder"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="binder" type="com.google.inject.Binder"/>
</method>
<method name="bind" return="com.google.inject.throwingproviders.ThrowingProviderBinder.SecondaryBinder<P>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="interfaceType" type="java.lang.Class<P>"/>
<param name="valueType" type="java.lang.reflect.Type"/>
</method>
<doc>
<![CDATA[<p>Builds a binding for a {@link ThrowingProvider} using a fluent API:
<pre><code>ThrowingProviderBinder.create(binder())
.bind(RemoteProvider.class, Customer.class)
.to(RemoteCustomerProvider.class)
.in(RequestScope.class);
</code></pre>
@author jmourits@google.com (Jerome Mourits)
@author jessewilson@google.com (Jesse Wilson)]]>
</doc>
</class>
<!-- end class com.google.inject.throwingproviders.ThrowingProviderBinder -->
<!-- start class com.google.inject.throwingproviders.ThrowingProviderBinder.SecondaryBinder -->
<class name="ThrowingProviderBinder.SecondaryBinder" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ThrowingProviderBinder.SecondaryBinder" type="java.lang.Class<P>, java.lang.reflect.Type"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="annotatedWith" return="com.google.inject.throwingproviders.ThrowingProviderBinder.SecondaryBinder<P>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotationType" type="java.lang.Class<? extends java.lang.annotation.Annotation>"/>
</method>
<method name="annotatedWith" return="com.google.inject.throwingproviders.ThrowingProviderBinder.SecondaryBinder<P>"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="annotation" type="java.lang.annotation.Annotation"/>
</method>
<method name="to" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="target" type="P extends com.google.inject.throwingproviders.ThrowingProvider"/>
</method>
<method name="to" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="targetType" type="java.lang.Class<? extends P>"/>
</method>
<method name="to" return="com.google.inject.binder.ScopedBindingBuilder"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="targetKey" type="com.google.inject.Key<? extends P>"/>
</method>
</class>
<!-- end class com.google.inject.throwingproviders.ThrowingProviderBinder.SecondaryBinder -->
</package>
<package name="com.google.inject.tools.jmx">
<!-- start interface com.google.inject.tools.jmx.ManagedBindingMBean -->
<interface name="ManagedBindingMBean" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="getSource" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the source of this binding.]]>
</doc>
</method>
<method name="getProvider" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the provider to which this binding is bound.]]>
</doc>
</method>
<method name="getKey" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Gets the binding key.]]>
</doc>
</method>
<doc>
<![CDATA[JMX interface to bindings.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</interface>
<!-- end interface com.google.inject.tools.jmx.ManagedBindingMBean -->
<!-- start class com.google.inject.tools.jmx.Manager -->
<class name="Manager" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="Manager"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="manage"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="domain" type="java.lang.String"/>
<param name="injector" type="com.google.inject.Injector"/>
<doc>
<![CDATA[Registers all the bindings of an Injector with the platform MBean server.
Consider using the name of your root {@link Module} class as the domain.]]>
</doc>
</method>
<method name="manage"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="server" type="javax.management.MBeanServer"/>
<param name="domain" type="java.lang.String"/>
<param name="injector" type="com.google.inject.Injector"/>
<doc>
<![CDATA[Registers all the bindings of an Injector with the given MBean server.
Consider using the name of your root {@link Module} class as the domain.]]>
</doc>
</method>
<method name="main"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="args" type="java.lang.String[]"/>
<exception name="Exception" type="java.lang.Exception"/>
<doc>
<![CDATA[Run with no arguments for usage instructions.]]>
</doc>
</method>
<doc>
<![CDATA[Provides a JMX interface to Guice.
@author crazybob@google.com (Bob Lee)]]>
</doc>
</class>
<!-- end class com.google.inject.tools.jmx.Manager -->
</package>
<package name="com.google.inject.util">
<!-- start class com.google.inject.util.Modules -->
<class name="Modules" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="override" return="com.google.inject.util.Modules.OverriddenModuleBuilder"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Returns a builder that creates a module that overlays override modules over the given
modules. If a key is bound in both sets of modules, only the binding from the override modules
is kept. This can be used to replace the bindings of a production module with test bindings:
<pre>
Module functionalTestModule
= Modules.override(new ProductionModule()).with(new TestModule());
</pre>
<p>Prefer to write smaller modules that can be reused and tested without overrides.
@param modules the modules whose bindings are open to be overridden]]>
</doc>
</method>
<method name="override" return="com.google.inject.util.Modules.OverriddenModuleBuilder"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[Returns a builder that creates a module that overlays override modules over the given
modules. If a key is bound in both sets of modules, only the binding from the override modules
is kept. This can be used to replace the bindings of a production module with test bindings:
<pre>
Module functionalTestModule
= Modules.override(getProductionModules()).with(getTestModules());
</pre>
<p>Prefer to write smaller modules that can be reused and tested without overrides.
@param modules the modules whose bindings are open to be overridden]]>
</doc>
</method>
<method name="combine" return="com.google.inject.Module"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[Returns a new module that installs all of {@code modules}.]]>
</doc>
</method>
<method name="combine" return="com.google.inject.Module"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="modules" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[Returns a new module that installs all of {@code modules}.]]>
</doc>
</method>
<field name="EMPTY_MODULE" type="com.google.inject.Module"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[Static utility methods for creating and working with instances of {@link Module}.
@author jessewilson@google.com (Jesse Wilson)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.util.Modules -->
<!-- start interface com.google.inject.util.Modules.OverriddenModuleBuilder -->
<interface name="Modules.OverriddenModuleBuilder" abstract="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<method name="with" return="com.google.inject.Module"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="overrides" type="com.google.inject.Module[]"/>
<doc>
<![CDATA[See the EDSL example at {@link Modules#override(Module[]) override()}.]]>
</doc>
</method>
<method name="with" return="com.google.inject.Module"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="overrides" type="java.lang.Iterable<? extends com.google.inject.Module>"/>
<doc>
<![CDATA[See the EDSL example at {@link Modules#override(Module[]) override()}.]]>
</doc>
</method>
<doc>
<![CDATA[See the EDSL example at {@link Modules#override(Module[]) override()}.]]>
</doc>
</interface>
<!-- end interface com.google.inject.util.Modules.OverriddenModuleBuilder -->
<!-- start class com.google.inject.util.Providers -->
<class name="Providers" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="of" return="com.google.inject.Provider<T>"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="instance" type="T"/>
<doc>
<![CDATA[Returns a provider which always provides {@code instance}. This should not
be necessary to use in your application, but is helpful for several types
of unit tests.
@param instance the instance that should always be provided. This is also
permitted to be null, to enable aggressive testing, although in real
life a Guice-supplied Provider will never return null.]]>
</doc>
</method>
<doc>
<![CDATA[Static utility methods for creating and working with instances of
{@link Provider}.
@author Kevin Bourrillion (kevinb9n@gmail.com)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.util.Providers -->
<!-- start class com.google.inject.util.Types -->
<class name="Types" extends="java.lang.Object"
abstract="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<method name="newParameterizedType" return="java.lang.reflect.ParameterizedType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="rawType" type="java.lang.reflect.Type"/>
<param name="typeArguments" type="java.lang.reflect.Type[]"/>
<doc>
<![CDATA[Returns a new parameterized type, applying {@code typeArguments} to
{@code rawType}. The returned type does not have an owner type.
@return a {@link java.io.Serializable serializable} parameterized type.]]>
</doc>
</method>
<method name="newParameterizedTypeWithOwner" return="java.lang.reflect.ParameterizedType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="ownerType" type="java.lang.reflect.Type"/>
<param name="rawType" type="java.lang.reflect.Type"/>
<param name="typeArguments" type="java.lang.reflect.Type[]"/>
<doc>
<![CDATA[Returns a new parameterized type, applying {@code typeArguments} to
{@code rawType} and enclosed by {@code ownerType}.
@return a {@link java.io.Serializable serializable} parameterized type.]]>
</doc>
</method>
<method name="arrayOf" return="java.lang.reflect.GenericArrayType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="componentType" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Returns an array type whose elements are all instances of
{@code componentType}.
@return a {@link java.io.Serializable serializable} generic array type.]]>
</doc>
</method>
<method name="subtypeOf" return="java.lang.reflect.WildcardType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="bound" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Returns a type that represents an unknown type that extends {@code bound}.
For example, if {@code bound} is {@code CharSequence.class}, this returns
{@code ? extends CharSequence}. If {@code bound} is {@code Object.class},
this returns {@code ?}, which is shorthand for {@code ? extends Object}.]]>
</doc>
</method>
<method name="supertypeOf" return="java.lang.reflect.WildcardType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="bound" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Returns a type that represents an unknown supertype of {@code bound}. For
example, if {@code bound} is {@code String.class}, this returns {@code ?
super String}.]]>
</doc>
</method>
<method name="listOf" return="java.lang.reflect.ParameterizedType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="elementType" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Returns a type modelling a {@link List} whose elements are of type
{@code elementType}.
@return a {@link java.io.Serializable serializable} parameterized type.]]>
</doc>
</method>
<method name="setOf" return="java.lang.reflect.ParameterizedType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="elementType" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Returns a type modelling a {@link Set} whose elements are of type
{@code elementType}.
@return a {@link java.io.Serializable serializable} parameterized type.]]>
</doc>
</method>
<method name="mapOf" return="java.lang.reflect.ParameterizedType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="keyType" type="java.lang.reflect.Type"/>
<param name="valueType" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Returns a type modelling a {@link Map} whose keys are of type
{@code keyType} and whose values are of type {@code valueType}.
@return a {@link java.io.Serializable serializable} parameterized type.]]>
</doc>
</method>
<method name="providerOf" return="java.lang.reflect.ParameterizedType"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="providedType" type="java.lang.reflect.Type"/>
<doc>
<![CDATA[Returns a type modelling a {@link Provider} that provides elements of type
{@code elementType}.
@return a {@link java.io.Serializable serializable} parameterized type.]]>
</doc>
</method>
<doc>
<![CDATA[Static methods for working with types.
@author crazybob@google.com (Bob Lee)
@since 2.0]]>
</doc>
</class>
<!-- end class com.google.inject.util.Types -->
</package>
</api>
|