/usr/share/doc/libplexus-utils2-java/api/org/codehaus/plexus/util/xml/pull/XmlPullParser.html is in libplexus-utils2-java-doc 3.0.22-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XmlPullParser (Plexus Common Utilities 3.0.22 API)</title>
<meta name="date" content="2015-11-19">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XmlPullParser (Plexus Common Utilities 3.0.22 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XmlPullParser.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/codehaus/plexus/util/xml/pull/MXSerializer.html" title="class in org.codehaus.plexus.util.xml.pull"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/codehaus/plexus/util/xml/pull/XmlPullParser.html" target="_top">Frames</a></li>
<li><a href="XmlPullParser.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.codehaus.plexus.util.xml.pull</div>
<h2 title="Interface XmlPullParser" class="title">Interface XmlPullParser</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/MXParser.html" title="class in org.codehaus.plexus.util.xml.pull">MXParser</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">XmlPullParser</span></pre>
<div class="block">XML Pull Parser is an interface that defines parsing functionality provided
in <a href="http://www.xmlpull.org/">XMLPULL V1 API</a> (visit this website to
learn more about API and its implementations).
<p>There are following different
kinds of parser depending on which features are set:<ul>
<li><b>non-validating</b> parser as defined in XML 1.0 spec when
FEATURE_PROCESS_DOCDECL is set to true
<li><b>validating parser</b> as defined in XML 1.0 spec when
FEATURE_VALIDATION is true (and that implies that FEATURE_PROCESS_DOCDECL is true)
<li>when FEATURE_PROCESS_DOCDECL is false (this is default and
if different value is required necessary must be changed before parsing is started)
then parser behaves like XML 1.0 compliant non-validating parser under condition that
<em>no DOCDECL is present</em> in XML documents
(internal entities can still be defined with defineEntityReplacementText()).
This mode of operation is intended <b>for operation in constrained environments</b> such as J2ME.
</ul>
<p>There are two key methods: next() and nextToken(). While next() provides
access to high level parsing events, nextToken() allows access to lower
level tokens.
<p>The current event state of the parser
can be determined by calling the
<a href="#getEventType()">getEventType()</a> method.
Initially, the parser is in the <a href="#START_DOCUMENT">START_DOCUMENT</a>
state.
<p>The method <a href="#next()">next()</a> advances the parser to the
next event. The int value returned from next determines the current parser
state and is identical to the value returned from following calls to
getEventType ().
<p>The following event types are seen by next()<dl>
<dt><a href="#START_TAG">START_TAG</a><dd> An XML start tag was read.
<dt><a href="#TEXT">TEXT</a><dd> Text content was read;
the text content can be retrieved using the getText() method.
(when in validating mode next() will not report ignorable whitespaces, use nextToken() instead)
<dt><a href="#END_TAG">END_TAG</a><dd> An end tag was read
<dt><a href="#END_DOCUMENT">END_DOCUMENT</a><dd> No more events are available
</dl>
<p>after first next() or nextToken() (or any other next*() method)
is called user application can obtain
XML version, standalone and encoding from XML declaration
in following ways:<ul>
<li><b>version</b>:
getProperty("<a href="http://xmlpull.org/v1/doc/properties.html#xmldecl-version">http://xmlpull.org/v1/doc/properties.html#xmldecl-version</a>")
returns String ("1.0") or null if XMLDecl was not read or if property is not supported
<li><b>standalone</b>:
getProperty("<a href="http://xmlpull.org/v1/doc/features.html#xmldecl-standalone">http://xmlpull.org/v1/doc/features.html#xmldecl-standalone</a>")
returns Boolean: null if there was no standalone declaration
or if property is not supported
otherwise returns Boolean(true) if standalone="yes" and Boolean(false) when standalone="no"
<li><b>encoding</b>: obtained from getInputEncoding()
null if stream had unknown encoding (not set in setInputStream)
and it was not declared in XMLDecl
</ul>
A minimal example for using this API may look as follows:
<pre>
import java.io.IOException;
import java.io.StringReader;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.<a href="XmlPullParserException.html">XmlPullParserException.html</a>;
import org.xmlpull.v1.<a href="XmlPullParserFactory.html">XmlPullParserFactory</a>;
public class SimpleXmlPullApp
{
public static void main (String args[])
throws XmlPullParserException, IOException
{
XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
factory.setNamespaceAware(true);
XmlPullParser xpp = factory.newPullParser();
xpp.<a href="#setInput">setInput</a>( new StringReader ( "<foo>Hello World!</foo>" ) );
int eventType = xpp.getEventType();
while (eventType != xpp.END_DOCUMENT) {
if(eventType == xpp.START_DOCUMENT) {
System.out.println("Start document");
} else if(eventType == xpp.END_DOCUMENT) {
System.out.println("End document");
} else if(eventType == xpp.START_TAG) {
System.out.println("Start tag "+xpp.<a href="#getName()">getName()</a>);
} else if(eventType == xpp.END_TAG) {
System.out.println("End tag "+xpp.getName());
} else if(eventType == xpp.TEXT) {
System.out.println("Text "+xpp.<a href="#getText()">getText()</a>);
}
eventType = xpp.next();
}
}
}
</pre>
<p>The above example will generate the following output:
<pre>
Start document
Start tag foo
Text Hello World!
End tag foo
</pre>
<p>For more details on API usage, please refer to the
quick Introduction available at <a href="http://www.xmlpull.org">http://www.xmlpull.org</a></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd><a href="http://www-ai.cs.uni-dortmund.de/PERSONAL/haustein.html">Stefan Haustein</a>, <a href="http://www.extreme.indiana.edu/~aslom/">Aleksander Slominski</a></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#defineEntityReplacementText(java.lang.String,%20java.lang.String)"><code>defineEntityReplacementText(java.lang.String, java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getName()"><code>getName()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace(java.lang.String)"><code>getNamespace(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setInput(java.io.Reader)"><code>setInput(java.io.Reader)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_PROCESS_DOCDECL"><code>FEATURE_PROCESS_DOCDECL</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_VALIDATION"><code>FEATURE_VALIDATION</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#START_DOCUMENT"><code>START_DOCUMENT</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#START_TAG"><code>START_TAG</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#TEXT"><code>TEXT</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_TAG"><code>END_TAG</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_DOCUMENT"><code>END_DOCUMENT</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#CDSECT">CDSECT</a></strong></code>
<div class="block">A CDATA sections was just read;
this token is available only from calls to <a href="#nextToken()">nextToken()</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#COMMENT">COMMENT</a></strong></code>
<div class="block">An XML comment was just read.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#DOCDECL">DOCDECL</a></strong></code>
<div class="block">An XML document type declaration was just read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_DOCUMENT">END_DOCUMENT</a></strong></code>
<div class="block">Logical end of the xml document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_TAG">END_TAG</a></strong></code>
<div class="block">Returned from getEventType(), <a href="#next()">next()</a>, or
<a href="#nextToken()">nextToken()</a> when an end tag was read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#ENTITY_REF">ENTITY_REF</a></strong></code>
<div class="block">An entity reference was just read;
this token is available from <a href="#nextToken()">nextToken()</a>
only.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_PROCESS_DOCDECL">FEATURE_PROCESS_DOCDECL</a></strong></code>
<div class="block">This feature determines whether the document declaration
is processed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_PROCESS_NAMESPACES">FEATURE_PROCESS_NAMESPACES</a></strong></code>
<div class="block">This feature determines whether the parser processes
namespaces.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_REPORT_NAMESPACE_ATTRIBUTES">FEATURE_REPORT_NAMESPACE_ATTRIBUTES</a></strong></code>
<div class="block">This feature determines whether namespace attributes are
exposed via the attribute access methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_VALIDATION">FEATURE_VALIDATION</a></strong></code>
<div class="block">If this feature is activated, all validation errors as
defined in the XML 1.0 sepcification are reported.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#IGNORABLE_WHITESPACE">IGNORABLE_WHITESPACE</a></strong></code>
<div class="block">Ignorable whitespace was just read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#NO_NAMESPACE">NO_NAMESPACE</a></strong></code>
<div class="block">This constant represents the default namespace (empty string "")</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#PROCESSING_INSTRUCTION">PROCESSING_INSTRUCTION</a></strong></code>
<div class="block">An XML processing instruction declaration was just read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#START_DOCUMENT">START_DOCUMENT</a></strong></code>
<div class="block">Signalize that parser is at the very beginning of the document
and nothing was read yet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#START_TAG">START_TAG</a></strong></code>
<div class="block">Returned from getEventType(),
<a href="#next()">next()</a>, <a href="#nextToken()">nextToken()</a> when
a start tag was read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#TEXT">TEXT</a></strong></code>
<div class="block">Character data was read and will is available by calling getText().</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#TYPES">TYPES</a></strong></code>
<div class="block">This array can be used to convert the event type integer constants
such as START_TAG or TEXT to
to a string.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#defineEntityReplacementText(java.lang.String,%20java.lang.String)">defineEntityReplacementText</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> entityName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> replacementText)</code>
<div class="block">Set new value for entity replacement text as defined in
<a href="http://www.w3.org/TR/REC-xml#intern-replacement">XML 1.0 Section 4.5
Construction of Internal Entity Replacement Text</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeCount()">getAttributeCount</a></strong>()</code>
<div class="block">Returns the number of attributes of the current start tag, or
-1 if the current event type is not START_TAG</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeName(int)">getAttributeName</a></strong>(int index)</code>
<div class="block">Returns the local name of the specified attribute
if namespaces are enabled or just attribute name if namespaces are disabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeNamespace(int)">getAttributeNamespace</a></strong>(int index)</code>
<div class="block">Returns the namespace URI of the attribute
with the given index (starts from 0).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributePrefix(int)">getAttributePrefix</a></strong>(int index)</code>
<div class="block">Returns the prefix of the specified attribute
Returns null if the element has no prefix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeType(int)">getAttributeType</a></strong>(int index)</code>
<div class="block">Returns the type of the specified attribute
If parser is non-validating it MUST return CDATA.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeValue(int)">getAttributeValue</a></strong>(int index)</code>
<div class="block">Returns the given attributes value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeValue(java.lang.String,%20java.lang.String)">getAttributeValue</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Returns the attributes value identified by namespace URI and namespace localName.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getColumnNumber()">getColumnNumber</a></strong>()</code>
<div class="block">Returns the current column number, starting from 0.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getDepth()">getDepth</a></strong>()</code>
<div class="block">Returns the current depth of the element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getEventType()">getEventType</a></strong>()</code>
<div class="block">Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getFeature(java.lang.String)">getFeature</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Returns the current value of the given feature.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getInputEncoding()">getInputEncoding</a></strong>()</code>
<div class="block">Returns the input encoding if known, null otherwise.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getLineNumber()">getLineNumber</a></strong>()</code>
<div class="block">Returns the current line number, starting from 1.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getName()">getName</a></strong>()</code>
<div class="block">For START_TAG or END_TAG events, the (local) name of the current
element is returned when namespaces are enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace()">getNamespace</a></strong>()</code>
<div class="block">Returns the namespace URI of the current element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace(java.lang.String)">getNamespace</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</code>
<div class="block">Returns the URI corresponding to the given prefix,
depending on current state of the parser.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespaceCount(int)">getNamespaceCount</a></strong>(int depth)</code>
<div class="block">Returns the numbers of elements in the namespace stack for the given
depth.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespacePrefix(int)">getNamespacePrefix</a></strong>(int pos)</code>
<div class="block">Returns the namespace prefixe for the given position
in the namespace stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespaceUri(int)">getNamespaceUri</a></strong>(int pos)</code>
<div class="block">Returns the namespace URI for the given position in the
namespace stack
If the position is out of range, an exception is thrown.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getPositionDescription()">getPositionDescription</a></strong>()</code>
<div class="block">Returns a short text describing the current parser state, including
the position, a
description of the current event and the data source if known.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getPrefix()">getPrefix</a></strong>()</code>
<div class="block">Returns the prefix of the current element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getProperty(java.lang.String)">getProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Look up the value of a property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()">getText</a></strong>()</code>
<div class="block">Returns the text content of the current event as String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>char[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getTextCharacters(int[])">getTextCharacters</a></strong>(int[] holderForStartAndLength)</code>
<div class="block">Returns the buffer that contains the text of the current event,
as well as the start offset and length relevant for the current
event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#isAttributeDefault(int)">isAttributeDefault</a></strong>(int index)</code>
<div class="block">Returns if the specified attribute was not in input was declared in XML.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#isEmptyElementTag()">isEmptyElementTag</a></strong>()</code>
<div class="block">Returns true if the current event is START_TAG and the tag
is degenerated
(e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#isWhitespace()">isWhitespace</a></strong>()</code>
<div class="block">Checks whether the current TEXT event contains only whitespace
characters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()">next</a></strong>()</code>
<div class="block">Get next parsing event - element content wil be coalesced and only one
TEXT event must be returned for whole element content
(comments and processing instructions will be ignored and emtity references
must be expanded or exception mus be thrown if entity reerence can not be exapnded).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextTag()">nextTag</a></strong>()</code>
<div class="block">Call next() and return event if it is START_TAG or END_TAG
otherwise throw an exception.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextText()">nextText</a></strong>()</code>
<div class="block">If current event is START_TAG then if next element is TEXT then element content is returned
or if next event is END_TAG then empty string is returned, otherwise exception is thrown.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()">nextToken</a></strong>()</code>
<div class="block">This method works similarly to next() but will expose
additional event types (COMMENT, CDSECT, DOCDECL, ENTITY_REF, PROCESSING_INSTRUCTION, or
IGNORABLE_WHITESPACE) if they are available in input.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#require(int,%20java.lang.String,%20java.lang.String)">require</a></strong>(int type,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Test if the current event is of the given type and if the
namespace and name do match.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setFeature(java.lang.String,%20boolean)">setFeature</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
boolean state)</code>
<div class="block">Use this call to change the general behaviour of the parser,
such as namespace processing or doctype declaration handling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setInput(java.io.InputStream,%20java.lang.String)">setInput</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> inputStream,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> inputEncoding)</code>
<div class="block">Sets the input stream the parser is going to process.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setInput(java.io.Reader)">setInput</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> in)</code>
<div class="block">Set the input source for parser to the given reader and
resets the parser.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setProperty(java.lang.String,%20java.lang.Object)">setProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code>
<div class="block">Set the value of a property.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="NO_NAMESPACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_NAMESPACE</h4>
<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NO_NAMESPACE</pre>
<div class="block">This constant represents the default namespace (empty string "")</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.NO_NAMESPACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="START_DOCUMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>START_DOCUMENT</h4>
<pre>static final int START_DOCUMENT</pre>
<div class="block">Signalize that parser is at the very beginning of the document
and nothing was read yet.
This event type can only be observed by calling getEvent()
before the first call to next(), nextToken, or nextTag()</a>).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.START_DOCUMENT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="END_DOCUMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>END_DOCUMENT</h4>
<pre>static final int END_DOCUMENT</pre>
<div class="block">Logical end of the xml document. Returned from getEventType, next()
and nextToken()
when the end of the input document has been reached.
<p><strong>NOTE:</strong> calling again
<a href="#next()">next()</a> or <a href="#nextToken()">nextToken()</a>
will result in exception being thrown.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.END_DOCUMENT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="START_TAG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>START_TAG</h4>
<pre>static final int START_TAG</pre>
<div class="block">Returned from getEventType(),
<a href="#next()">next()</a>, <a href="#nextToken()">nextToken()</a> when
a start tag was read.
The name of start tag is available from getName(), its namespace and prefix are
available from getNamespace() and getPrefix()
if <a href='#FEATURE_PROCESS_NAMESPACES'>namespaces are enabled</a>.
See getAttribute* methods to retrieve element attributes.
See getNamespace* methods to retrieve newly declared namespaces.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getName()"><code>getName()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getPrefix()"><code>getPrefix()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace(java.lang.String)"><code>getNamespace(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeCount()"><code>getAttributeCount()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getDepth()"><code>getDepth()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespaceCount(int)"><code>getNamespaceCount(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace(java.lang.String)"><code>getNamespace(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_PROCESS_NAMESPACES"><code>FEATURE_PROCESS_NAMESPACES</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.START_TAG">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="END_TAG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>END_TAG</h4>
<pre>static final int END_TAG</pre>
<div class="block">Returned from getEventType(), <a href="#next()">next()</a>, or
<a href="#nextToken()">nextToken()</a> when an end tag was read.
The name of start tag is available from getName(), its
namespace and prefix are
available from getNamespace() and getPrefix().</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getName()"><code>getName()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getPrefix()"><code>getPrefix()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace(java.lang.String)"><code>getNamespace(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_PROCESS_NAMESPACES"><code>FEATURE_PROCESS_NAMESPACES</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.END_TAG">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT</h4>
<pre>static final int TEXT</pre>
<div class="block">Character data was read and will is available by calling getText().
<p><strong>Please note:</strong> <a href="#next()">next()</a> will
accumulate multiple
events into one TEXT event, skipping IGNORABLE_WHITESPACE,
PROCESSING_INSTRUCTION and COMMENT events,
In contrast, <a href="#nextToken()">nextToken()</a> will stop reading
text when any other event is observed.
Also, when the state was reached by calling next(), the text value will
be normalized, whereas getText() will
return unnormalized content in the case of nextToken(). This allows
an exact roundtrip without changing line ends when examining low
level events, whereas for high level applications the text is
normalized appropriately.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.TEXT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CDSECT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CDSECT</h4>
<pre>static final int CDSECT</pre>
<div class="block">A CDATA sections was just read;
this token is available only from calls to <a href="#nextToken()">nextToken()</a>.
A call to next() will accumulate various text events into a single event
of type TEXT. The text contained in the CDATA section is available
by calling getText().</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.CDSECT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ENTITY_REF">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENTITY_REF</h4>
<pre>static final int ENTITY_REF</pre>
<div class="block">An entity reference was just read;
this token is available from <a href="#nextToken()">nextToken()</a>
only. The entity name is available by calling getName(). If available,
the replacement text can be obtained by calling getTextt(); otherwise,
the user is responsible for resolving the entity reference.
This event type is never returned from next(); next() will
accumulate the replacement text and other text
events to a single TEXT event.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.ENTITY_REF">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="IGNORABLE_WHITESPACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IGNORABLE_WHITESPACE</h4>
<pre>static final int IGNORABLE_WHITESPACE</pre>
<div class="block">Ignorable whitespace was just read.
This token is available only from <a href="#nextToken()">nextToken()</a>).
For non-validating
parsers, this event is only reported by nextToken() when outside
the root element.
Validating parsers may be able to detect ignorable whitespace at
other locations.
The ignorable whitespace string is available by calling getText()
<p><strong>NOTE:</strong> this is different from calling the
isWhitespace() method, since text content
may be whitespace but not ignorable.
Ignorable whitespace is skipped by next() automatically; this event
type is never returned from next().</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.IGNORABLE_WHITESPACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PROCESSING_INSTRUCTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROCESSING_INSTRUCTION</h4>
<pre>static final int PROCESSING_INSTRUCTION</pre>
<div class="block">An XML processing instruction declaration was just read. This
event type is available only via <a href="#nextToken()">nextToken()</a>.
getText() will return text that is inside the processing instruction.
Calls to next() will skip processing instructions automatically.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.PROCESSING_INSTRUCTION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="COMMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMMENT</h4>
<pre>static final int COMMENT</pre>
<div class="block">An XML comment was just read. This event type is this token is
available via <a href="#nextToken()">nextToken()</a> only;
calls to next() will skip comments automatically.
The content of the comment can be accessed using the getText()
method.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.COMMENT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DOCDECL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOCDECL</h4>
<pre>static final int DOCDECL</pre>
<div class="block">An XML document type declaration was just read. This token is
available from <a href="#nextToken()">nextToken()</a> only.
The unparsed text inside the doctype is available via
the getText() method.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.DOCDECL">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPES</h4>
<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] TYPES</pre>
<div class="block">This array can be used to convert the event type integer constants
such as START_TAG or TEXT to
to a string. For example, the value of TYPES[START_TAG] is
the string "START_TAG".
This array is intended for diagnostic output only. Relying
on the contents of the array may be dangerous since malicious
applications may alter the array, although it is final, due
to limitations of the Java language.</div>
</li>
</ul>
<a name="FEATURE_PROCESS_NAMESPACES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FEATURE_PROCESS_NAMESPACES</h4>
<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FEATURE_PROCESS_NAMESPACES</pre>
<div class="block">This feature determines whether the parser processes
namespaces. As for all features, the default value is false.
<p><strong>NOTE:</strong> The value can not be changed during
parsing an must be set before parsing.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getFeature(java.lang.String)"><code>getFeature(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setFeature(java.lang.String,%20boolean)"><code>setFeature(java.lang.String, boolean)</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.FEATURE_PROCESS_NAMESPACES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FEATURE_REPORT_NAMESPACE_ATTRIBUTES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FEATURE_REPORT_NAMESPACE_ATTRIBUTES</h4>
<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FEATURE_REPORT_NAMESPACE_ATTRIBUTES</pre>
<div class="block">This feature determines whether namespace attributes are
exposed via the attribute access methods. Like all features,
the default value is false. This feature cannot be changed
during parsing.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getFeature(java.lang.String)"><code>getFeature(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setFeature(java.lang.String,%20boolean)"><code>setFeature(java.lang.String, boolean)</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.FEATURE_REPORT_NAMESPACE_ATTRIBUTES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FEATURE_PROCESS_DOCDECL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FEATURE_PROCESS_DOCDECL</h4>
<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FEATURE_PROCESS_DOCDECL</pre>
<div class="block">This feature determines whether the document declaration
is processed. If set to false,
the DOCDECL event type is reported by nextToken()
and ignored by next().
If this featue is activated, then the document declaration
must be processed by the parser.
<p><strong>Please note:</strong> If the document type declaration
was ignored, entity references may cause exceptions
later in the parsing process.
The default value of this feature is false. It cannot be changed
during parsing.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getFeature(java.lang.String)"><code>getFeature(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setFeature(java.lang.String,%20boolean)"><code>setFeature(java.lang.String, boolean)</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.FEATURE_PROCESS_DOCDECL">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FEATURE_VALIDATION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FEATURE_VALIDATION</h4>
<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FEATURE_VALIDATION</pre>
<div class="block">If this feature is activated, all validation errors as
defined in the XML 1.0 sepcification are reported.
This implies that FEATURE_PROCESS_DOCDECL is true and both, the
internal and external document type declaration will be processed.
<p><strong>Please Note:</strong> This feature can not be changed
during parsing. The default value is false.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getFeature(java.lang.String)"><code>getFeature(java.lang.String)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setFeature(java.lang.String,%20boolean)"><code>setFeature(java.lang.String, boolean)</code></a>,
<a href="../../../../../../constant-values.html#org.codehaus.plexus.util.xml.pull.XmlPullParser.FEATURE_VALIDATION">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFeature(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFeature</h4>
<pre>void setFeature(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
boolean state)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Use this call to change the general behaviour of the parser,
such as namespace processing or doctype declaration handling.
This method must be called before the first call to next or
nextToken. Otherwise, an exception is thrown.
<p>Example: call setFeature(FEATURE_PROCESS_NAMESPACES, true) in order
to switch on namespace processing. The initial settings correspond
to the properties requested from the XML Pull Parser factory.
If none were requested, all feautures are deactivated by default.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code> - If the feature is not supported or can not be set</dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If string with the feature name is null</dd></dl>
</li>
</ul>
<a name="getFeature(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFeature</h4>
<pre>boolean getFeature(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Returns the current value of the given feature.
<p><strong>Please note:</strong> unknown features are
<strong>always</strong> returned as false.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of feature to be retrieved.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The value of the feature.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if string the feature name is null</dd></dl>
</li>
</ul>
<a name="setProperty(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>void setProperty(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Set the value of a property.
The property name is any fully-qualified URI.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code> - If the property is not supported or can not be set</dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If string with the property name is null</dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getProperty(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Look up the value of a property.
The property name is any fully-qualified URI.
<p><strong>NOTE:</strong> unknown properties are <strong>always</strong>
returned as null.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of property to be retrieved.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The value of named property.</dd></dl>
</li>
</ul>
<a name="setInput(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInput</h4>
<pre>void setInput(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> in)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Set the input source for parser to the given reader and
resets the parser. The event type is set to the initial value
START_DOCUMENT.
Setting the reader to null will just stop parsing and
reset parser state,
allowing the parser to free internal resources
such as parsing buffers.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd></dl>
</li>
</ul>
<a name="setInput(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInput</h4>
<pre>void setInput(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> inputStream,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> inputEncoding)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Sets the input stream the parser is going to process.
This call resets the parser state and sets the event type
to the initial value START_DOCUMENT.
<p><strong>NOTE:</strong> If an input encoding string is passed,
it MUST be used. Otherwise,
if inputEncoding is null, the parser SHOULD try to determine
input encoding following XML 1.0 specification (see below).
If encoding detection is supported then following feature
<a href="http://xmlpull.org/v1/doc/features.html#detect-encoding">http://xmlpull.org/v1/doc/features.html#detect-encoding</a>
MUST be true amd otherwise it must be false</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputStream</code> - contains a raw byte input stream of possibly
unknown encoding (when inputEncoding is null).</dd><dd><code>inputEncoding</code> - if not null it MUST be used as encoding for inputStream</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd></dl>
</li>
</ul>
<a name="getInputEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputEncoding</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getInputEncoding()</pre>
<div class="block">Returns the input encoding if known, null otherwise.
If setInput(InputStream, inputEncoding) was called with an inputEncoding
value other than null, this value must be returned
from this method. Otherwise, if inputEncoding is null and
the parser suppports the encoding detection feature
(http://xmlpull.org/v1/doc/features.html#detect-encoding),
it must return the detected encoding.
If setInput(Reader) was called, null is returned.
After first call to next if XML declaration was present this method
will return encoding declared.</div>
</li>
</ul>
<a name="defineEntityReplacementText(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defineEntityReplacementText</h4>
<pre>void defineEntityReplacementText(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> entityName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> replacementText)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Set new value for entity replacement text as defined in
<a href="http://www.w3.org/TR/REC-xml#intern-replacement">XML 1.0 Section 4.5
Construction of Internal Entity Replacement Text</a>.
If FEATURE_PROCESS_DOCDECL or FEATURE_VALIDATION are set, calling this
function will result in an exception -- when processing of DOCDECL is
enabled, there is no need to the entity replacement text manually.
<p>The motivation for this function is to allow very small
implementations of XMLPULL that will work in J2ME environments.
Though these implementations may not be able to process the document type
declaration, they still can work with known DTDs by using this function.
<p><b>Please notes:</b> The given value is used literally as replacement text
and it corresponds to declaring entity in DTD that has all special characters
escaped: left angle bracket is replaced with &lt;, ampersnad with &amp;
and so on.
<p><b>Note:</b> The given value is the literal replacement text and must not
contain any other entity reference (if it contains any entity reference
there will be no further replacement).
<p><b>Note:</b> The list of pre-defined entity names will
always contain standard XML entities such as
amp (&amp;), lt (&lt;), gt (&gt;), quot (&quot;), and apos (&apos;).
Those cannot be redefined by this method!</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#setInput(java.io.Reader)"><code>setInput(java.io.Reader)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_PROCESS_DOCDECL"><code>FEATURE_PROCESS_DOCDECL</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#FEATURE_VALIDATION"><code>FEATURE_VALIDATION</code></a></dd></dl>
</li>
</ul>
<a name="getNamespaceCount(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespaceCount</h4>
<pre>int getNamespaceCount(int depth)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Returns the numbers of elements in the namespace stack for the given
depth.
If namespaces are not enabled, 0 is returned.
<p><b>NOTE:</b> when parser is on END_TAG then it is allowed to call
this function with getDepth()+1 argument to retrieve position of namespace
prefixes and URIs that were declared on corresponding START_TAG.
<p><b>NOTE:</b> to retrieve lsit of namespaces declared in current element:<pre>
XmlPullParser pp = ...
int nsStart = pp.getNamespaceCount(pp.getDepth()-1);
int nsEnd = pp.getNamespaceCount(pp.getDepth());
for (int i = nsStart; i < nsEnd; i++) {
String prefix = pp.getNamespacePrefix(i);
String ns = pp.getNamespaceUri(i);
// ...
}
</pre></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespacePrefix(int)"><code>getNamespacePrefix(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespaceUri(int)"><code>getNamespaceUri(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace()"><code>getNamespace()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespace(java.lang.String)"><code>getNamespace(String)</code></a></dd></dl>
</li>
</ul>
<a name="getNamespacePrefix(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespacePrefix</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNamespacePrefix(int pos)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Returns the namespace prefixe for the given position
in the namespace stack.
Default namespace declaration (xmlns='...') will have null as prefix.
If the given index is out of range, an exception is thrown.
<p><b>Please note:</b> when the parser is on an END_TAG,
namespace prefixes that were declared
in the corresponding START_TAG are still accessible
although they are no longer in scope.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd></dl>
</li>
</ul>
<a name="getNamespaceUri(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespaceUri</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNamespaceUri(int pos)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Returns the namespace URI for the given position in the
namespace stack
If the position is out of range, an exception is thrown.
<p><b>NOTE:</b> when parser is on END_TAG then namespace prefixes that were declared
in corresponding START_TAG are still accessible even though they are not in scope</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd></dl>
</li>
</ul>
<a name="getNamespace(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNamespace(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefix)</pre>
<div class="block">Returns the URI corresponding to the given prefix,
depending on current state of the parser.
<p>If the prefix was not declared in the current scope,
null is returned. The default namespace is included
in the namespace table and is available via
getNamespace (null).
<p>This method is a convenience method for
<pre>
for (int i = getNamespaceCount(getDepth ())-1; i >= 0; i--) {
if (getNamespacePrefix(i).equals( prefix )) {
return getNamespaceUri(i);
}
}
return null;
</pre>
<p><strong>Please note:</strong> parser implementations
may provide more efifcient lookup, e.g. using a Hashtable.
The 'xml' prefix is bound to "http://www.w3.org/XML/1998/namespace", as
defined in the
<a href="http://www.w3.org/TR/REC-xml-names/#ns-using">Namespaces in XML</a>
specification. Analogous, the 'xmlns' prefix is resolved to
<a href="http://www.w3.org/2000/xmlns/">http://www.w3.org/2000/xmlns/</a></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespaceCount(int)"><code>getNamespaceCount(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespacePrefix(int)"><code>getNamespacePrefix(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getNamespaceUri(int)"><code>getNamespaceUri(int)</code></a></dd></dl>
</li>
</ul>
<a name="getDepth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDepth</h4>
<pre>int getDepth()</pre>
<div class="block">Returns the current depth of the element.
Outside the root element, the depth is 0. The
depth is incremented by 1 when a start tag is reached.
The depth is decremented AFTER the end tag
event was observed.
<pre>
<!-- outside --> 0
<root> 1
sometext 1
<foobar> 2
</foobar> 2
</root> 1
<!-- outside --> 0
</pre></div>
</li>
</ul>
<a name="getPositionDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPositionDescription</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPositionDescription()</pre>
<div class="block">Returns a short text describing the current parser state, including
the position, a
description of the current event and the data source if known.
This method is especially useful to provide meaningful
error messages and for debugging purposes.</div>
</li>
</ul>
<a name="getLineNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineNumber</h4>
<pre>int getLineNumber()</pre>
<div class="block">Returns the current line number, starting from 1.
When the parser does not know the current line number
or can not determine it, -1 is returned (e.g. for WBXML).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>current line number or -1 if unknown.</dd></dl>
</li>
</ul>
<a name="getColumnNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNumber</h4>
<pre>int getColumnNumber()</pre>
<div class="block">Returns the current column number, starting from 0.
When the parser does not know the current column number
or can not determine it, -1 is returned (e.g. for WBXML).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>current column number or -1 if unknown.</dd></dl>
</li>
</ul>
<a name="isWhitespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWhitespace</h4>
<pre>boolean isWhitespace()
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Checks whether the current TEXT event contains only whitespace
characters.
For IGNORABLE_WHITESPACE, this is always true.
For TEXT and CDSECT, false is returned when the current event text
contains at least one non-white space character. For any other
event type an exception is thrown.
<p><b>Please note:</b> non-validating parsers are not
able to distinguish whitespace and ignorable whitespace,
except from whitespace outside the root element. Ignorable
whitespace is reported as separate event, which is exposed
via nextToken only.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd></dl>
</li>
</ul>
<a name="getText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getText()</pre>
<div class="block">Returns the text content of the current event as String.
The value returned depends on current event type,
for example for TEXT event it is element content
(this is typical case when next() is used).
See description of nextToken() for detailed description of
possible returned values for different types of events.
<p><strong>NOTE:</strong> in case of ENTITY_REF, this method returns
the entity replacement text (or null if not available). This is
the only case where
getText() and getTextCharacters() return different values.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getEventType()"><code>getEventType()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a></dd></dl>
</li>
</ul>
<a name="getTextCharacters(int[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextCharacters</h4>
<pre>char[] getTextCharacters(int[] holderForStartAndLength)</pre>
<div class="block">Returns the buffer that contains the text of the current event,
as well as the start offset and length relevant for the current
event. See getText(), next() and nextToken() for description of possible returned values.
<p><strong>Please note:</strong> this buffer must not
be modified and its content MAY change after a call to
next() or nextToken(). This method will always return the
same value as getText(), except for ENTITY_REF. In the case
of ENTITY ref, getText() returns the replacement text and
this method returns the actual input buffer containing the
entity name.
If getText() returns null, this method returns null as well and
the values returned in the holder array MUST be -1 (both start
and length).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holderForStartAndLength</code> - Must hold an 2-element int array
into which the start offset and length values will be written.</dd>
<dt><span class="strong">Returns:</span></dt><dd>char buffer that contains the text of the current event
(null if the current event has no text associated).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getText()"><code>getText()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a></dd></dl>
</li>
</ul>
<a name="getNamespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getNamespace()</pre>
<div class="block">Returns the namespace URI of the current element.
The default namespace is represented
as empty string.
If namespaces are not enabled, an empty String ("") is always returned.
The current event must be START_TAG or END_TAG; otherwise,
null is returned.</div>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre>
<div class="block">For START_TAG or END_TAG events, the (local) name of the current
element is returned when namespaces are enabled. When namespace
processing is disabled, the raw name is returned.
For ENTITY_REF events, the entity name is returned.
If the current event is not START_TAG, END_TAG, or ENTITY_REF,
null is returned.
<p><b>Please note:</b> To reconstruct the raw element name
when namespaces are enabled and the prefix is not null,
you will need to add the prefix and a colon to localName..</div>
</li>
</ul>
<a name="getPrefix()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrefix</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPrefix()</pre>
<div class="block">Returns the prefix of the current element.
If the element is in the default namespace (has no prefix),
null is returned.
If namespaces are not enabled, or the current event
is not START_TAG or END_TAG, null is returned.</div>
</li>
</ul>
<a name="isEmptyElementTag()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmptyElementTag</h4>
<pre>boolean isEmptyElementTag()
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Returns true if the current event is START_TAG and the tag
is degenerated
(e.g. <foobar/>).
<p><b>NOTE:</b> if the parser is not on START_TAG, an exception
will be thrown.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd></dl>
</li>
</ul>
<a name="getAttributeCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeCount</h4>
<pre>int getAttributeCount()</pre>
<div class="block">Returns the number of attributes of the current start tag, or
-1 if the current event type is not START_TAG</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeNamespace(int)"><code>getAttributeNamespace(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeName(int)"><code>getAttributeName(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributePrefix(int)"><code>getAttributePrefix(int)</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#getAttributeValue(int)"><code>getAttributeValue(int)</code></a></dd></dl>
</li>
</ul>
<a name="getAttributeNamespace(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeNamespace</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAttributeNamespace(int index)</pre>
<div class="block">Returns the namespace URI of the attribute
with the given index (starts from 0).
Returns an empty string ("") if namespaces are not enabled
or the attribute has no namespace.
Throws an IndexOutOfBoundsException if the index is out of range
or the current event type is not START_TAG.
<p><strong>NOTE:</strong> if FEATURE_REPORT_NAMESPACE_ATTRIBUTES is set
then namespace attributes (xmlns:ns='...') must be reported
with namespace
<a href="http://www.w3.org/2000/xmlns/">http://www.w3.org/2000/xmlns/</a>
(visit this URL for description!).
The default namespace attribute (xmlns="...") will be reported with empty namespace.
<p><strong>NOTE:</strong>The xml prefix is bound as defined in
<a href="http://www.w3.org/TR/REC-xml-names/#ns-using">Namespaces in XML</a>
specification to "http://www.w3.org/XML/1998/namespace".</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - zero based index of attribute</dd>
<dt><span class="strong">Returns:</span></dt><dd>attribute namespace,
empty string ("") is returned if namesapces processing is not enabled or
namespaces processing is enabled but attribute has no namespace (it has no prefix).</dd></dl>
</li>
</ul>
<a name="getAttributeName(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeName</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAttributeName(int index)</pre>
<div class="block">Returns the local name of the specified attribute
if namespaces are enabled or just attribute name if namespaces are disabled.
Throws an IndexOutOfBoundsException if the index is out of range
or current event type is not START_TAG.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - zero based index of attribute</dd>
<dt><span class="strong">Returns:</span></dt><dd>attribute name (null is never returned)</dd></dl>
</li>
</ul>
<a name="getAttributePrefix(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributePrefix</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAttributePrefix(int index)</pre>
<div class="block">Returns the prefix of the specified attribute
Returns null if the element has no prefix.
If namespaces are disabled it will always return null.
Throws an IndexOutOfBoundsException if the index is out of range
or current event type is not START_TAG.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - zero based index of attribute</dd>
<dt><span class="strong">Returns:</span></dt><dd>attribute prefix or null if namespaces processing is not enabled.</dd></dl>
</li>
</ul>
<a name="getAttributeType(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeType</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAttributeType(int index)</pre>
<div class="block">Returns the type of the specified attribute
If parser is non-validating it MUST return CDATA.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - zero based index of attribute</dd>
<dt><span class="strong">Returns:</span></dt><dd>attribute type (null is never returned)</dd></dl>
</li>
</ul>
<a name="isAttributeDefault(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttributeDefault</h4>
<pre>boolean isAttributeDefault(int index)</pre>
<div class="block">Returns if the specified attribute was not in input was declared in XML.
If parser is non-validating it MUST always return false.
This information is part of XML infoset:</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - zero based index of attribute</dd>
<dt><span class="strong">Returns:</span></dt><dd>false if attribute was in input</dd></dl>
</li>
</ul>
<a name="getAttributeValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeValue</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAttributeValue(int index)</pre>
<div class="block">Returns the given attributes value.
Throws an IndexOutOfBoundsException if the index is out of range
or current event type is not START_TAG.
<p><strong>NOTE:</strong> attribute value must be normalized
(including entity replacement text if PROCESS_DOCDECL is false) as described in
<a href="http://www.w3.org/TR/REC-xml#AVNormalize">XML 1.0 section
3.3.3 Attribute-Value Normalization</a></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - zero based index of attribute</dd>
<dt><span class="strong">Returns:</span></dt><dd>value of attribute (null is never returned)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#defineEntityReplacementText(java.lang.String,%20java.lang.String)"><code>defineEntityReplacementText(java.lang.String, java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="getAttributeValue(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeValue</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAttributeValue(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Returns the attributes value identified by namespace URI and namespace localName.
If namespaces are disabled namespace must be null.
If current event type is not START_TAG then IndexOutOfBoundsException will be thrown.
<p><strong>NOTE:</strong> attribute value must be normalized
(including entity replacement text if PROCESS_DOCDECL is false) as described in
<a href="http://www.w3.org/TR/REC-xml#AVNormalize">XML 1.0 section
3.3.3 Attribute-Value Normalization</a></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>namespace</code> - Namespace of the attribute if namespaces are enabled otherwise must be null</dd><dd><code>name</code> - If namespaces enabled local name of attribute otherwise just attribute name</dd>
<dt><span class="strong">Returns:</span></dt><dd>value of attribute or null if attribute with given name does not exist</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#defineEntityReplacementText(java.lang.String,%20java.lang.String)"><code>defineEntityReplacementText(java.lang.String, java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="getEventType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventType</h4>
<pre>int getEventType()
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></pre>
<div class="block">Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.)</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#nextToken()"><code>nextToken()</code></a></dd></dl>
</li>
</ul>
<a name="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>int next()
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a>,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Get next parsing event - element content wil be coalesced and only one
TEXT event must be returned for whole element content
(comments and processing instructions will be ignored and emtity references
must be expanded or exception mus be thrown if entity reerence can not be exapnded).
If element content is empty (content is "") then no TEXT event will be reported.
<p><b>NOTE:</b> empty element (such as <tag/>) will be reported
with two separate events: START_TAG, END_TAG - it must be so to preserve
parsing equivalency of empty element to <tag></tag>.
(see isEmptyElementTag ())</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#isEmptyElementTag()"><code>isEmptyElementTag()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#START_TAG"><code>START_TAG</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#TEXT"><code>TEXT</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_TAG"><code>END_TAG</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_DOCUMENT"><code>END_DOCUMENT</code></a></dd></dl>
</li>
</ul>
<a name="nextToken()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextToken</h4>
<pre>int nextToken()
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a>,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">This method works similarly to next() but will expose
additional event types (COMMENT, CDSECT, DOCDECL, ENTITY_REF, PROCESSING_INSTRUCTION, or
IGNORABLE_WHITESPACE) if they are available in input.
<p>If special feature
<a href="http://xmlpull.org/v1/doc/features.html#xml-roundtrip">FEATURE_XML_ROUNDTRIP</a>
(identified by URI: http://xmlpull.org/v1/doc/features.html#xml-roundtrip)
is enabled it is possible to do XML document round trip ie. reproduce
exectly on output the XML input using getText():
returned content is always unnormalized (exactly as in input).
Otherwise returned content is end-of-line normalized as described
<a href="http://www.w3.org/TR/REC-xml#sec-line-ends">XML 1.0 End-of-Line Handling</a>
and. Also when this feature is enabled exact content of START_TAG, END_TAG,
DOCDECL and PROCESSING_INSTRUCTION is available.
<p>Here is the list of tokens that can be returned from nextToken()
and what getText() and getTextCharacters() returns:<dl>
<dt>START_DOCUMENT<dd>null
<dt>END_DOCUMENT<dd>null
<dt>START_TAG<dd>null unless FEATURE_XML_ROUNDTRIP
enabled and then returns XML tag, ex: <tag attr='val'>
<dt>END_TAG<dd>null unless FEATURE_XML_ROUNDTRIP
id enabled and then returns XML tag, ex: </tag>
<dt>TEXT<dd>return element content.
<br>Note: that element content may be delivered in multiple consecutive TEXT events.
<dt>IGNORABLE_WHITESPACE<dd>return characters that are determined to be ignorable white
space. If the FEATURE_XML_ROUNDTRIP is enabled all whitespace content outside root
element will always reported as IGNORABLE_WHITESPACE otherise rteporting is optional.
<br>Note: that element content may be delevered in multiple consecutive IGNORABLE_WHITESPACE events.
<dt>CDSECT<dd>
return text <em>inside</em> CDATA
(ex. 'fo<o' from <!CDATA[fo<o]]>)
<dt>PROCESSING_INSTRUCTION<dd>
if FEATURE_XML_ROUNDTRIP is true
return exact PI content ex: 'pi foo' from <?pi foo?>
otherwise it may be exact PI content or concatenation of PI target,
space and data so for example for
<?target data?> string "target data" may
be returned if FEATURE_XML_ROUNDTRIP is false.
<dt>COMMENT<dd>return comment content ex. 'foo bar' from <!--foo bar-->
<dt>ENTITY_REF<dd>getText() MUST return entity replacement text if PROCESS_DOCDECL is false
otherwise getText() MAY return null,
additionally getTextCharacters() MUST return entity name
(for example 'entity_name' for &entity_name;).
<br><b>NOTE:</b> this is the only place where value returned from getText() and
getTextCharacters() <b>are different</b>
<br><b>NOTE:</b> it is user responsibility to resolve entity reference
if PROCESS_DOCDECL is false and there is no entity replacement text set in
defineEntityReplacementText() method (getText() will be null)
<br><b>NOTE:</b> character entities (ex. &#32;) and standard entities such as
&amp; &lt; &gt; &quot; &apos; are reported as well
and are <b>not</b> reported as TEXT tokens but as ENTITY_REF tokens!
This requirement is added to allow to do roundtrip of XML documents!
<dt>DOCDECL<dd>
if FEATURE_XML_ROUNDTRIP is true or PROCESS_DOCDECL is false
then return what is inside of DOCDECL for example it returns:<pre>
" titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd"
[<!ENTITY % active.links "INCLUDE">]"</pre>
<p>for input document that contained:<pre>
<!DOCTYPE titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd"
[<!ENTITY % active.links "INCLUDE">]></pre>
otherwise if FEATURE_XML_ROUNDTRIP is false and PROCESS_DOCDECL is true
then what is returned is undefined (it may be even null)
</dd>
</dl>
<p><strong>NOTE:</strong> there is no gurantee that there will only one TEXT or
IGNORABLE_WHITESPACE event from nextToken() as parser may chose to deliver element content in
multiple tokens (dividing element content into chunks)
<p><strong>NOTE:</strong> whether returned text of token is end-of-line normalized
is depending on FEATURE_XML_ROUNDTRIP.
<p><strong>NOTE:</strong> XMLDecl (<?xml ...?>) is not reported but its content
is available through optional properties (see class description above).</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#next()"><code>next()</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#START_TAG"><code>START_TAG</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#TEXT"><code>TEXT</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_TAG"><code>END_TAG</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#END_DOCUMENT"><code>END_DOCUMENT</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#COMMENT"><code>COMMENT</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#DOCDECL"><code>DOCDECL</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#PROCESSING_INSTRUCTION"><code>PROCESSING_INSTRUCTION</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#ENTITY_REF"><code>ENTITY_REF</code></a>,
<a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParser.html#IGNORABLE_WHITESPACE"><code>IGNORABLE_WHITESPACE</code></a></dd></dl>
</li>
</ul>
<a name="require(int, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>require</h4>
<pre>void require(int type,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a>,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Test if the current event is of the given type and if the
namespace and name do match. null will match any namespace
and any name. If the test is not passed, an exception is
thrown. The exception text indicates the parser position,
the expected event and the current event that is not meeting the
requirement.
<p>Essentially it does this
<pre>
if (type != getEventType()
|| (namespace != null && !namespace.equals( getNamespace () ) )
|| (name != null && !name.equals( getName() ) ) )
throw new XmlPullParserException( "expected "+ TYPES[ type ]+getPositionDescription());
</pre></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="nextText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextText</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nextText()
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a>,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">If current event is START_TAG then if next element is TEXT then element content is returned
or if next event is END_TAG then empty string is returned, otherwise exception is thrown.
After calling this function successfully parser will be positioned on END_TAG.
<p>The motivation for this function is to allow to parse consistently both
empty elements and elements that has non empty content, for example for input: <ol>
<li><tag>foo</tag>
<li><tag></tag> (which is equivalent to <tag/>
both input can be parsed with the same code:
<pre>
p.nextTag()
p.requireEvent(p.START_TAG, "", "tag");
String content = p.nextText();
p.requireEvent(p.END_TAG, "", "tag");
</pre>
This function together with nextTag make it very easy to parse XML that has
no mixed content.
<p>Essentially it does this
<pre>
if(getEventType() != START_TAG) {
throw new XmlPullParserException(
"parser must be on START_TAG to read next text", this, null);
}
int eventType = next();
if(eventType == TEXT) {
String result = getText();
eventType = next();
if(eventType != END_TAG) {
throw new XmlPullParserException(
"event TEXT it must be immediately followed by END_TAG", this, null);
}
return result;
} else if(eventType == END_TAG) {
return "";
} else {
throw new XmlPullParserException(
"parser must be on START_TAG or TEXT to read text", this, null);
}
</pre></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="nextTag()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>nextTag</h4>
<pre>int nextTag()
throws <a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a>,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Call next() and return event if it is START_TAG or END_TAG
otherwise throw an exception.
It will skip whitespace TEXT before actual tag if any.
<p>essentially it does this
<pre>
int eventType = next();
if(eventType == TEXT && isWhitespace()) { // skip whitespace
eventType = next();
}
if (eventType != START_TAG && eventType != END_TAG) {
throw new XmlPullParserException("expected start or end tag", this, null);
}
return eventType;
</pre></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code></dd>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XmlPullParser.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/codehaus/plexus/util/xml/pull/MXSerializer.html" title="class in org.codehaus.plexus.util.xml.pull"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/codehaus/plexus/util/xml/pull/XmlPullParserException.html" title="class in org.codehaus.plexus.util.xml.pull"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/codehaus/plexus/util/xml/pull/XmlPullParser.html" target="_top">Frames</a></li>
<li><a href="XmlPullParser.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2015. All rights reserved.</small></p>
</body>
</html>
|