/usr/share/doc/libpirl-java/api/PIRL/PVL/Parser.html is in libpirl-java-doc 2.3.8-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 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Tue Nov 20 23:14:30 UTC 2012 -->
<title>Parser</title>
<meta name="date" content="2012-11-20">
<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="Parser";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/PVL/Parser.html" target="_top">Frames</a></li>
<li><a href="Parser.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">PIRL.PVL</div>
<h2 title="Class Parser" class="title">Class Parser</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">PIRL.Strings.String_Buffer</a></li>
<li>
<ul class="inheritance">
<li><a href="../../PIRL/Strings/String_Buffer_Reader.html" title="class in PIRL.Strings">PIRL.Strings.String_Buffer_Reader</a></li>
<li>
<ul class="inheritance">
<li>PIRL.PVL.Parser</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Parser</span>
extends <a href="../../PIRL/Strings/String_Buffer_Reader.html" title="class in PIRL.Strings">String_Buffer_Reader</a></pre>
<div class="block">The <I>Parser</I> extends the <I>String_Buffer_Reader</I> to interpret
the characters as a sequence of Parameter Value Language (PVL) syntax
statements.
<P>
This Parser implements the syntax of the PVL used by the
Planetary Data System (PDS) as specified by the <A
HREF="http://www.ccsds.org" TARGET="_top"> Consultative Committee for
Space Data Systems</A> in the <A
HREF="http://www.ccsds.org/blue_books.html" TARGET="_top"> Blue
Book</A> "Parameter Value Language Specification (CCSDS0006,8)", June
2000 [CCSDS 641.0-B-2] and <A
HREF="http://www.ccsds.org/green_books.html" TARGET="_top"> Green
Book</A> "Parameter Value Language - A Tutorial", May 1992 [CCSDS
641.0-G-1] documents. PVL has been accepted by the <A
HREF="http://www.iso.ch" TARGET="_top"> International Standards
Organization (ISO)</A>, as a Draft Standard (ISO/CD 14961:1997). The
PVL syntax defines a <I>Parameter</I> with this basic format:
<P>
<BLOCKQUOTE>
[<B><I>Comments</I></B>]<BR>
<B><I>Name</I></B> [<B>= <I>Value</I></B>][<B>;</B>]
</BLOCKQUOTE>
<P>
The optional Comments are enclosed in C-style delimiters, or
optionally preceeded by a crosshatch ('#') character on each line.
The PVL syntax for a <I>Value</I> follows this format:
<P>
<BLOCKQUOTE>
[<B>(</B>|<B>{</B>]<B><I>Datum</I></B> [<B><<I>Units</I>></B>][<B>, <I>Datum</I></B> [...]][<B>)</B>|<B>}</B> [<B><<I>Units</I>></B>]]
</BLOCKQUOTE>
<P>
The purpose of a Parser object is to assemble Parameter and Value
objects using the PVL statements obtained from the associated
String_Buffer_Reader.
<P>
The class methods that perform the parsing of the character source are
organized into a hierarchy:
<P>
<UL TYPE="DISC">
<LI><CODE>Get</CODE>
<LI><CODE>Add_To</CODE>
<UL TYPE="DISC">
<LI><CODE>Get_Parameter</CODE>
<UL TYPE="DISC">
<LI><CODE>Get_Comments</CODE>
<LI><CODE>Get_Value</CODE>
<UL TYPE="DISC">
<LI><CODE>Get_Datum</CODE>
<UL TYPE="DISC">
<LI><CODE>Get_Quoted_String</CODE>
</UL>
<LI><CODE>Get_Units</CODE>
</UL>
</UL>
</UL>
</UL>
<P>
Higher level methods utilize lower level methods to assemble their
constituent parts. At the top level an aggregate of all Parameters
that can be interpreted from the input will be collected by getting
as many Parameters as possible; a Parameter is produced from the
input stream by getting any comments, a name String, and a Value; a
Value includes as many datum and optional units descriptions that can
be sequentially found in the input stream; and a datum is composed
from primitive syntactic elements, including integer or real number
representations or character strings which may be quoted (a Parameter
name may also be a quoted string). Typically applications will only
use the top method(s). Applications needing finer grained control
over input stream parsing may, of course, use the lower level methods
directly, however it is much easier to just get all of the Parameters
from an input source and then manipulate the Parameter-Value object
hierarchy.
<P>
Each method that parses the input stream interprets the contents of
the logical String_Buffer_Reader which presents the entire virtual
contents of the stream from the current location onwards. Except for
the top level which does not interpret the character source directly,
these methods first seek forward from the current location to the
beginning of a potentially relevant syntactic character sequence. If
the sequence is recognized as suitable for the item the method is
responsible for interpreting then the appropriate end of the sequence
is found and the characters it contains are translated into the
corresponding internal form of object class variable. If the
translation is successful then the logical <CODE>Next_Location</CODE>
of the String_Buffer_Reader is moved forward to the end of the
sequence before the iterative interpretation of the stream continues.
If, however, the beginning of a recognizable syntactic sequence is
not found, or the translation of a sequence fails, then the method
returns empty handed, and without having advanced the logical
String_Buffer_Reader, to the invoking method which may invoke a
different method in an attempt to get a different item or itself
discontinue its efforts to assemble an item. Thus each parsing method
either gets its item and advances the current location in the
character stream, or does not get its item nor advance the stream;
i.e. the PVL statements encountered in the character source are
sequentially translated at the same time that the input stream is
incrementally moved forward.
<P></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/String_Buffer_Reader.html" title="class in PIRL.Strings"><code>String_Buffer_Reader</code></a>,
<a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL"><code>Parameter</code></a>,
<a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL"><code>Value</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 boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#All_Values_Strings_Default">All_Values_Strings_Default</a></strong></code>
<div class="block">The default for treating <a href="../../PIRL/PVL/Parser.html#All_Values_Strings(boolean)"><code>all
values as strings</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#CHARACTER_ENCODING">CHARACTER_ENCODING</a></strong></code>
<div class="block">The PVL character encoding: "US-ASCII".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#COMMENT_END_DELIMITERS">COMMENT_END_DELIMITERS</a></strong></code>
<div class="block">Marks the end of a comment string: '*' and '/'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#COMMENT_START_DELIMITERS">COMMENT_START_DELIMITERS</a></strong></code>
<div class="block">Marks the start of a comment string: '/' and '*'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#CONTAINER_NAME">CONTAINER_NAME</a></strong></code>
<div class="block">The default name of the aggregate Parameter to contain all
Parameters when a Parser Get finds more than one Parameter:
"The Container".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#CROSSHATCH">CROSSHATCH</a></strong></code>
<div class="block">Begins a "crosshatch comment" that extends to the end of the line: '#'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments_Default">Crosshatch_Comments_Default</a></strong></code>
<div class="block">The default for allowing <a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments(boolean)"><code>crosshatched-to-EOL comments</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#DATE_TIME_DELIMITERS">DATE_TIME_DELIMITERS</a></strong></code>
<div class="block">Set of characters that suggests a DATE_TIME type of STRING Value: "-:".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#ID">ID</a></strong></code>
<div class="block">Class name and version identification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#LINE_BREAK">LINE_BREAK</a></strong></code>
<div class="block">Character sequence that separates PVL statement lines: "\r\n" (CR-NL).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#NUMBER_BASE_DELIMITER">NUMBER_BASE_DELIMITER</a></strong></code>
<div class="block">Encloses the datum of a Value in radix base notation: '#'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#PARAMETER_NAME_DELIMITER">PARAMETER_NAME_DELIMITER</a></strong></code>
<div class="block">Delimits a Parameter name from its Value: '='.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#PARAMETER_VALUE_DELIMITER">PARAMETER_VALUE_DELIMITER</a></strong></code>
<div class="block">Delimits elements of an ARRAY Value: ','.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#RESERVED_CHARACTERS">RESERVED_CHARACTERS</a></strong></code>
<div class="block">Characters reserved by the PVL syntax.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#SEQUENCE_END_DELIMITER">SEQUENCE_END_DELIMITER</a></strong></code>
<div class="block">Marks the end of a SEQUENCE ARRAY Value: ')'</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#SEQUENCE_START_DELIMITER">SEQUENCE_START_DELIMITER</a></strong></code>
<div class="block">Marks the start of a SEQUENCE ARRAY Value: '('.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#SET_END_DELIMITER">SET_END_DELIMITER</a></strong></code>
<div class="block">Marks the end of a SET ARRAY Value: '}'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#SET_START_DELIMITER">SET_START_DELIMITER</a></strong></code>
<div class="block">Marks the start of a SET ARRAY Value: '{'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#STATEMENT_CONTINUATION_DELIMITER">STATEMENT_CONTINUATION_DELIMITER</a></strong></code>
<div class="block">Indicates that the statement continues in the next record: '&'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER">STATEMENT_END_DELIMITER</a></strong></code>
<div class="block">Marks the end of a PVL statement: ';'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Strict_Default">Strict_Default</a></strong></code>
<div class="block">The default for enforcing <a href="../../PIRL/PVL/Parser.html#Strict(boolean)"><code>strict</code></a> PVL syntax rules.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#String_Continuation_Default">String_Continuation_Default</a></strong></code>
<div class="block"><a href="../../PIRL/PVL/Parser.html#String_Continuation(boolean)"><code>String continuation</code></a> default.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#STRING_CONTINUATION_DELIMITER">STRING_CONTINUATION_DELIMITER</a></strong></code>
<div class="block">Indicates that the quoted string continues unbroken in the next record: '-'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#SYMBOL_DELIMITER">SYMBOL_DELIMITER</a></strong></code>
<div class="block">Encloses a SYMBOL STRING Value: '\''.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER">TEXT_DELIMITER</a></strong></code>
<div class="block">Encloses a TEXT STRING Value: '"'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#UNITS_END_DELIMITER">UNITS_END_DELIMITER</a></strong></code>
<div class="block">Marks the end of a Value units description: '>'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#UNITS_START_DELIMITER">UNITS_START_DELIMITER</a></strong></code>
<div class="block">Marks the start of a Value units description: '<'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#VERBATIM_STRING_DELIMITERS">VERBATIM_STRING_DELIMITERS</a></strong></code>
<div class="block">Encloses a verbatim (uninterpreted) string: "\\v".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings_Default">Verbatim_Strings_Default</a></strong></code>
<div class="block"><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>Verbatim strings</code></a> default.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#WHITESPACE">WHITESPACE</a></strong></code>
<div class="block">Set of "whitespace" characters between PVL tokens: " \t\r\n\f\013"
(SP, HT, CR, NL, FF, and VT).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_PIRL.Strings.String_Buffer_Reader">
<!-- -->
</a>
<h3>Fields inherited from class PIRL.Strings.<a href="../../PIRL/Strings/String_Buffer_Reader.html" title="class in PIRL.Strings">String_Buffer_Reader</a></h3>
<code><a href="../../PIRL/Strings/String_Buffer_Reader.html#DEFAULT_READ_LIMIT">DEFAULT_READ_LIMIT</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#DEFAULT_SIZE_INCREMENT">DEFAULT_SIZE_INCREMENT</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#INVALID_CHARACTER">INVALID_CHARACTER</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#NO_READ_LIMIT">NO_READ_LIMIT</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_PIRL.Strings.String_Buffer">
<!-- -->
</a>
<h3>Fields inherited from class PIRL.Strings.<a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a></h3>
<code><a href="../../PIRL/Strings/String_Buffer.html#QUESTIONABLE_CHARACTER">QUESTIONABLE_CHARACTER</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser()">Parser</a></strong>()</code>
<div class="block">Creates a Parser with no source of PVL statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(char[])">Parser</a></strong>(char[] char_array)</code>
<div class="block">Creates a Parser using a character array as the source of PVL
statements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(char[], int, int)">Parser</a></strong>(char[] char_array,
int offset,
int length)</code>
<div class="block">Creates a Parser using a characer array subset as the source of PVL
statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(java.io.File)">Parser</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code>
<div class="block">Creates a Parser using a File to create a new Reader as the
source of PVL statements, with no limit on the amount to read.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(java.io.File, long)">Parser</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
long read_limit)</code>
<div class="block">Creates a Parser using a File to create a new Reader as the
source of PVL statements, and sets a limit on the amount to read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(java.io.InputStream)">Parser</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input_stream)</code>
<div class="block">Creates a Parser using an InputStream to create a new Reader as the
source of PVL statements, with no limit on the amount to read.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(java.io.InputStream, long)">Parser</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input_stream,
long read_limit)</code>
<div class="block">Creates a Parser using an InputStream to create a new Reader as the
source of PVL statements, and sets a limit on the amount to read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(java.io.Reader)">Parser</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader)</code>
<div class="block">Creates a Parser using a Reader as the source of PVL statements,
with no limit on the amount to read.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(java.io.Reader, long)">Parser</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader,
long read_limit)</code>
<div class="block">Creates a Parser using a Reader as the source of PVL statements,
and sets a limit on the amount to read.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Parser.html#Parser(java.lang.String)">Parser</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> string)</code>
<div class="block">Creates a Parser using a String as the source of PVL statements.</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><a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Add_To(PIRL.PVL.Parameter)">Add_To</a></strong>(<a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a> The_Aggregate)</code>
<div class="block">Adds to a Parameter all Parameters found from the input source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#All_Values_Strings()">All_Values_Strings</a></strong>()</code>
<div class="block">Tests if the Parser will treat all values as strings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#All_Values_Strings(boolean)">All_Values_Strings</a></strong>(boolean all_values_strings)</code>
<div class="block">Enable or disable treating all values as strings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Bad_Character(java.lang.String)">Bad_Character</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> string)</code>
<div class="block">Checks a String for any bad character.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments()">Crosshatch_Comments</a></strong>()</code>
<div class="block">Tests if crosshatch comments will be recognized.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments(boolean)">Crosshatch_Comments</a></strong>(boolean crosshatch_comments)</code>
<div class="block">Enable or disable recognition of crosshatch comments.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#First_Warning()">First_Warning</a></strong>()</code>
<div class="block">Returns the first warning since the last <CODE>Reset_Warning</CODE>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#First_Warning(boolean)">First_Warning</a></strong>(boolean first)</code>
<div class="block">Enables or disables returning the first warning that occurs as the
current warning status.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#Get_Comments()">Get_Comments</a></strong>()</code>
<div class="block">Gets the next sequence of comments from the source of PVL statements
as a single comment String.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Get_Datum(PIRL.PVL.Value)">Get_Datum</a></strong>(<a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a> The_Value)</code>
<div class="block">Gets a datum from the source of PVL statements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Get_Parameter()">Get_Parameter</a></strong>()</code>
<div class="block">Gets a Parameter from the source of PVL statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#Get_Quoted_String()">Get_Quoted_String</a></strong>()</code>
<div class="block">Gets a quoted String from the source of PVL statements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#Get_Units()">Get_Units</a></strong>()</code>
<div class="block">Gets a units description String from the source of PVL statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Get_Value()">Get_Value</a></strong>()</code>
<div class="block">Gets a Value from the source of PVL statements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Get()">Get</a></strong>()</code>
<div class="block">Gets as many Parameters as possible.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#isprint(char)">isprint</a></strong>(char character)</code>
<div class="block">Tests if a character is printable: in the ASCII range from the
space character (' ') to the tilde character ('~') inclusive.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Last_Warning()">Last_Warning</a></strong>()</code>
<div class="block">Returns the last warning since a <CODE>Reset_Warning</CODE>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Last_Warning(boolean)">Last_Warning</a></strong>(boolean last)</code>
<div class="block">Enables or disables returning the last warning that occurs as the
current warning status.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Reset_Warning()">Reset_Warning</a></strong>()</code>
<div class="block">Clears any warning status so that the <CODE>Warning</CODE> method
will return null until the next warning condition occurs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.File, long)">Set_Reader</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
long read_limit)</code>
<div class="block">Sets the Reader where the Parser will obtain characters by
constructing a FileInputStream from the specified File and passing
this to the <a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.InputStream, long)"><code><CODE>Set_Reader
(InputStream, long)</CODE></code></a> method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.InputStream, long)">Set_Reader</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input_stream,
long read_limit)</code>
<div class="block">Sets the Reader where the Parser will obtain characters by
constructing an InputStreamReader from the specified InputStream
and wrapping this in a BufferedReader, the same size as the
<CODE>Size_Increment</CODE> of the String_Buffer_Reader, for
efficiency.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.Reader, long)">Set_Reader</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader,
long read_limit)</code>
<div class="block">Sets the Reader where the Parser will obtain characters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#skip_whitespace_and_comments(long)">skip_whitespace_and_comments</a></strong>(long location)</code>
<div class="block">Gets the next location in the PVL source stream following any
sequence of whitespace and/or comments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Special_Classification(java.lang.String)">Special_Classification</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
<div class="block">Gets the Parameter classification code corresponding to the
specified special Parameter name String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="/usr/share/doc/default-jdk-doc/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="../../PIRL/PVL/Parser.html#Special_Name(int)">Special_Name</a></strong>(int classification)</code>
<div class="block">Gets the special Parameter name String for the specified Parameter
classification code.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Strict()">Strict</a></strong>()</code>
<div class="block">Tests if the Parser will enforce strict PVL syntax rules.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Strict(boolean)">Strict</a></strong>(boolean strict)</code>
<div class="block">Enables or disables strict PVL syntax rules in the Parser.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#String_Continuation()">String_Continuation</a></strong>()</code>
<div class="block">Tests if the Parser will recognize multi-line string continuation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#String_Continuation(boolean)">String_Continuation</a></strong>(boolean continuation)</code>
<div class="block">Enable or disable string continuation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#translate_from_escape_sequences(PIRL.Strings.String_Buffer)">translate_from_escape_sequences</a></strong>(<a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a> string)</code>
<div class="block">Translates escape sequences in a String_Buffer to their
corresponding special characters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings()">Verbatim_Strings</a></strong>()</code>
<div class="block">Tests if the Parser will handle quoted strings verbatim.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)">Verbatim_Strings</a></strong>(boolean verbatim)</code>
<div class="block">Enable or disable verbatim quoted strings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Parser.html#Warning()">Warning</a></strong>()</code>
<div class="block">Gets the current warning status.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_PIRL.Strings.String_Buffer_Reader">
<!-- -->
</a>
<h3>Methods inherited from class PIRL.Strings.<a href="../../PIRL/Strings/String_Buffer_Reader.html" title="class in PIRL.Strings">String_Buffer_Reader</a></h3>
<code><a href="../../PIRL/Strings/String_Buffer_Reader.html#Buffer_Location()">Buffer_Location</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Char_At(long)">Char_At</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#End_Index()">End_Index</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#End_Location()">End_Location</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Ended()">Ended</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Equals(long, java.lang.String)">Equals</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Extend()">Extend</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Filter_Input()">Filter_Input</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Filter_Input(boolean)">Filter_Input</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Filter_Input(int)">Filter_Input</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Get_Reader()">Get_Reader</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Index(long)">Index</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Is_Empty()">Is_Empty</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Is_End(long)">Is_End</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Is_Text(char)">Is_Text</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Location_Of(long, char)">Location_Of</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Location_Of(long, java.lang.String)">Location_Of</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Location(int)">Location</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Next_Index()">Next_Index</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Next_Index(int)">Next_Index</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Next_Location()">Next_Location</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Next_Location(long)">Next_Location</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#No_Read_Limit()">No_Read_Limit</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Non_Text_Limit()">Non_Text_Limit</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Non_Text_Limit(int)">Non_Text_Limit</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Read_Limit()">Read_Limit</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Read_Limit(long)">Read_Limit</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Reader_Source()">Reader_Source</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Record_Size(char, char)">Record_Size</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Record_Size(int)">Record_Size</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Reset_Location()">Reset_Location</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Reset()">Reset</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Set_Reader(java.io.Reader)">Set_Reader</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Size_Increment()">Size_Increment</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Size_Increment(int)">Size_Increment</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Skip_Over(long, java.lang.String)">Skip_Over</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Skip_Until(long, java.lang.String)">Skip_Until</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#String_Source()">String_Source</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Substring(long, long)">Substring</a>, <a href="../../PIRL/Strings/String_Buffer_Reader.html#Total_Read()">Total_Read</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_PIRL.Strings.String_Buffer">
<!-- -->
</a>
<h3>Methods inherited from class PIRL.Strings.<a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a></h3>
<code><a href="../../PIRL/Strings/String_Buffer.html#append(boolean)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(byte)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(byte[])">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(byte[], int, int)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(char)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(char[])">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(char[], int, int)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(double)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(float)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(int)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(long)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(java.lang.Object)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#append(java.lang.String)">append</a>, <a href="../../PIRL/Strings/String_Buffer.html#capacity()">capacity</a>, <a href="../../PIRL/Strings/String_Buffer.html#charAt(int)">charAt</a>, <a href="../../PIRL/Strings/String_Buffer.html#clean(char)">clean</a>, <a href="../../PIRL/Strings/String_Buffer.html#clear()">clear</a>, <a href="../../PIRL/Strings/String_Buffer.html#delete(int, int)">delete</a>, <a href="../../PIRL/Strings/String_Buffer.html#deleteCharAt(int)">deleteCharAt</a>, <a href="../../PIRL/Strings/String_Buffer.html#ensureCapacity(int)">ensureCapacity</a>, <a href="../../PIRL/Strings/String_Buffer.html#equals_ignore_case(int, java.lang.String)">equals_ignore_case</a>, <a href="../../PIRL/Strings/String_Buffer.html#equals(int, java.lang.String)">equals</a>, <a href="../../PIRL/Strings/String_Buffer.html#equalsIgnoreCase(int, java.lang.String)">equalsIgnoreCase</a>, <a href="../../PIRL/Strings/String_Buffer.html#escape_to_special()">escape_to_special</a>, <a href="../../PIRL/Strings/String_Buffer.html#escape_to_special(java.lang.String)">escape_to_special</a>, <a href="../../PIRL/Strings/String_Buffer.html#from_character_references()">from_character_references</a>, <a href="../../PIRL/Strings/String_Buffer.html#from_character_references(java.lang.String)">from_character_references</a>, <a href="../../PIRL/Strings/String_Buffer.html#getChars(int, int, char[], int)">getChars</a>, <a href="../../PIRL/Strings/String_Buffer.html#index_of(int, char)">index_of</a>, <a href="../../PIRL/Strings/String_Buffer.html#index_of(int, java.lang.String)">index_of</a>, <a href="../../PIRL/Strings/String_Buffer.html#indexOf(int, char)">indexOf</a>, <a href="../../PIRL/Strings/String_Buffer.html#indexOf(int, java.lang.String)">indexOf</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, boolean)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, char)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, char[])">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, char[], int, int)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, double)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, float)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, int)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, long)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, java.lang.Object)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#insert(int, java.lang.String)">insert</a>, <a href="../../PIRL/Strings/String_Buffer.html#length()">length</a>, <a href="../../PIRL/Strings/String_Buffer.html#replace_span(int, java.lang.String, java.lang.String)">replace_span</a>, <a href="../../PIRL/Strings/String_Buffer.html#replace(int, int, java.lang.String)">replace</a>, <a href="../../PIRL/Strings/String_Buffer.html#replace(int, java.lang.String, java.lang.String)">replace</a>, <a href="../../PIRL/Strings/String_Buffer.html#replaceSpan(int, java.lang.String, java.lang.String)">replaceSpan</a>, <a href="../../PIRL/Strings/String_Buffer.html#reverse()">reverse</a>, <a href="../../PIRL/Strings/String_Buffer.html#setCharAt(int, char)">setCharAt</a>, <a href="../../PIRL/Strings/String_Buffer.html#setLength(int)">setLength</a>, <a href="../../PIRL/Strings/String_Buffer.html#skip_back_over(int, java.lang.String)">skip_back_over</a>, <a href="../../PIRL/Strings/String_Buffer.html#skip_back_until(int, java.lang.String)">skip_back_until</a>, <a href="../../PIRL/Strings/String_Buffer.html#skip_over(int, java.lang.String)">skip_over</a>, <a href="../../PIRL/Strings/String_Buffer.html#skip_until(int, java.lang.String)">skip_until</a>, <a href="../../PIRL/Strings/String_Buffer.html#skipBackOver(int, java.lang.String)">skipBackOver</a>, <a href="../../PIRL/Strings/String_Buffer.html#skipBackUntil(int, java.lang.String)">skipBackUntil</a>, <a href="../../PIRL/Strings/String_Buffer.html#skipOver(int, java.lang.String)">skipOver</a>, <a href="../../PIRL/Strings/String_Buffer.html#skipUntil(int, java.lang.String)">skipUntil</a>, <a href="../../PIRL/Strings/String_Buffer.html#special_to_escape()">special_to_escape</a>, <a href="../../PIRL/Strings/String_Buffer.html#special_to_escape(java.lang.String)">special_to_escape</a>, <a href="../../PIRL/Strings/String_Buffer.html#substring(int)">substring</a>, <a href="../../PIRL/Strings/String_Buffer.html#substring(int, int)">substring</a>, <a href="../../PIRL/Strings/String_Buffer.html#to_character_references()">to_character_references</a>, <a href="../../PIRL/Strings/String_Buffer.html#to_character_references(java.lang.String)">to_character_references</a>, <a href="../../PIRL/Strings/String_Buffer.html#to_printable_ASCII()">to_printable_ASCII</a>, <a href="../../PIRL/Strings/String_Buffer.html#to_printable_ASCII(java.lang.String)">to_printable_ASCII</a>, <a href="../../PIRL/Strings/String_Buffer.html#toString()">toString</a>, <a href="../../PIRL/Strings/String_Buffer.html#trim_all(char)">trim_all</a>, <a href="../../PIRL/Strings/String_Buffer.html#trim_beginning()">trim_beginning</a>, <a href="../../PIRL/Strings/String_Buffer.html#trim_end()">trim_end</a>, <a href="../../PIRL/Strings/String_Buffer.html#trim()">trim</a>, <a href="../../PIRL/Strings/String_Buffer.html#trim(char)">trim</a>, <a href="../../PIRL/Strings/String_Buffer.html#trim(int, int)">trim</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ID</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ID</pre>
<div class="block">Class name and version identification.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.ID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="Strict_Default">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Strict_Default</h4>
<pre>public static boolean Strict_Default</pre>
<div class="block">The default for enforcing <a href="../../PIRL/PVL/Parser.html#Strict(boolean)"><code>strict</code></a> PVL syntax rules.</div>
</li>
</ul>
<a name="Verbatim_Strings_Default">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Verbatim_Strings_Default</h4>
<pre>public static boolean Verbatim_Strings_Default</pre>
<div class="block"><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>Verbatim strings</code></a> default.</div>
</li>
</ul>
<a name="String_Continuation_Default">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String_Continuation_Default</h4>
<pre>public static boolean String_Continuation_Default</pre>
<div class="block"><a href="../../PIRL/PVL/Parser.html#String_Continuation(boolean)"><code>String continuation</code></a> default.</div>
</li>
</ul>
<a name="Crosshatch_Comments_Default">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Crosshatch_Comments_Default</h4>
<pre>public static boolean Crosshatch_Comments_Default</pre>
<div class="block">The default for allowing <a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments(boolean)"><code>crosshatched-to-EOL comments</code></a>.</div>
</li>
</ul>
<a name="All_Values_Strings_Default">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>All_Values_Strings_Default</h4>
<pre>public static boolean All_Values_Strings_Default</pre>
<div class="block">The default for treating <a href="../../PIRL/PVL/Parser.html#All_Values_Strings(boolean)"><code>all
values as strings</code></a>.</div>
</li>
</ul>
<a name="CROSSHATCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CROSSHATCH</h4>
<pre>public static final char CROSSHATCH</pre>
<div class="block">Begins a "crosshatch comment" that extends to the end of the line: '#'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.CROSSHATCH">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CHARACTER_ENCODING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CHARACTER_ENCODING</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CHARACTER_ENCODING</pre>
<div class="block">The PVL character encoding: "US-ASCII".</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.CHARACTER_ENCODING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="RESERVED_CHARACTERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RESERVED_CHARACTERS</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RESERVED_CHARACTERS</pre>
<div class="block">Characters reserved by the PVL syntax.
<P>
<BLOCKQUOTE>
{}()[]<>&\"',=;#%~|+! \t\r\n\f\013
</BLOCKQUOTE>
<P>
Some of these characters have special meanings in specific contexts
as delimiters of PVL items.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.RESERVED_CHARACTERS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PARAMETER_NAME_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARAMETER_NAME_DELIMITER</h4>
<pre>public static final char PARAMETER_NAME_DELIMITER</pre>
<div class="block">Delimits a Parameter name from its Value: '='.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.PARAMETER_NAME_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PARAMETER_VALUE_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARAMETER_VALUE_DELIMITER</h4>
<pre>public static final char PARAMETER_VALUE_DELIMITER</pre>
<div class="block">Delimits elements of an ARRAY Value: ','.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.PARAMETER_VALUE_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TEXT_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEXT_DELIMITER</h4>
<pre>public static final char TEXT_DELIMITER</pre>
<div class="block">Encloses a TEXT STRING Value: '"'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.TEXT_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SYMBOL_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SYMBOL_DELIMITER</h4>
<pre>public static final char SYMBOL_DELIMITER</pre>
<div class="block">Encloses a SYMBOL STRING Value: '\''.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.SYMBOL_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SET_START_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SET_START_DELIMITER</h4>
<pre>public static final char SET_START_DELIMITER</pre>
<div class="block">Marks the start of a SET ARRAY Value: '{'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.SET_START_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SET_END_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SET_END_DELIMITER</h4>
<pre>public static final char SET_END_DELIMITER</pre>
<div class="block">Marks the end of a SET ARRAY Value: '}'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.SET_END_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEQUENCE_START_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEQUENCE_START_DELIMITER</h4>
<pre>public static final char SEQUENCE_START_DELIMITER</pre>
<div class="block">Marks the start of a SEQUENCE ARRAY Value: '('.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.SEQUENCE_START_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEQUENCE_END_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEQUENCE_END_DELIMITER</h4>
<pre>public static final char SEQUENCE_END_DELIMITER</pre>
<div class="block">Marks the end of a SEQUENCE ARRAY Value: ')'</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.SEQUENCE_END_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNITS_START_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNITS_START_DELIMITER</h4>
<pre>public static final char UNITS_START_DELIMITER</pre>
<div class="block">Marks the start of a Value units description: '<'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.UNITS_START_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNITS_END_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNITS_END_DELIMITER</h4>
<pre>public static final char UNITS_END_DELIMITER</pre>
<div class="block">Marks the end of a Value units description: '>'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.UNITS_END_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="NUMBER_BASE_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NUMBER_BASE_DELIMITER</h4>
<pre>public static final char NUMBER_BASE_DELIMITER</pre>
<div class="block">Encloses the datum of a Value in radix base notation: '#'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.NUMBER_BASE_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="STATEMENT_END_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATEMENT_END_DELIMITER</h4>
<pre>public static final char STATEMENT_END_DELIMITER</pre>
<div class="block">Marks the end of a PVL statement: ';'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.STATEMENT_END_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="STATEMENT_CONTINUATION_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATEMENT_CONTINUATION_DELIMITER</h4>
<pre>public static final char STATEMENT_CONTINUATION_DELIMITER</pre>
<div class="block">Indicates that the statement continues in the next record: '&'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.STATEMENT_CONTINUATION_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="STRING_CONTINUATION_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STRING_CONTINUATION_DELIMITER</h4>
<pre>public static final char STRING_CONTINUATION_DELIMITER</pre>
<div class="block">Indicates that the quoted string continues unbroken in the next record: '-'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.STRING_CONTINUATION_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="LINE_BREAK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LINE_BREAK</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LINE_BREAK</pre>
<div class="block">Character sequence that separates PVL statement lines: "\r\n" (CR-NL).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.LINE_BREAK">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="WHITESPACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WHITESPACE</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> WHITESPACE</pre>
<div class="block">Set of "whitespace" characters between PVL tokens: " \t\r\n\f\013"
(SP, HT, CR, NL, FF, and VT).</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.WHITESPACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="COMMENT_START_DELIMITERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMMENT_START_DELIMITERS</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> COMMENT_START_DELIMITERS</pre>
<div class="block">Marks the start of a comment string: '/' and '*'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.COMMENT_START_DELIMITERS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="COMMENT_END_DELIMITERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMMENT_END_DELIMITERS</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> COMMENT_END_DELIMITERS</pre>
<div class="block">Marks the end of a comment string: '*' and '/'.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.COMMENT_END_DELIMITERS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DATE_TIME_DELIMITERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATE_TIME_DELIMITERS</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DATE_TIME_DELIMITERS</pre>
<div class="block">Set of characters that suggests a DATE_TIME type of STRING Value: "-:".</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.DATE_TIME_DELIMITERS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="VERBATIM_STRING_DELIMITERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VERBATIM_STRING_DELIMITERS</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> VERBATIM_STRING_DELIMITERS</pre>
<div class="block">Encloses a verbatim (uninterpreted) string: "\\v".</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.VERBATIM_STRING_DELIMITERS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CONTAINER_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CONTAINER_NAME</h4>
<pre>public static final <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONTAINER_NAME</pre>
<div class="block">The default name of the aggregate Parameter to contain all
Parameters when a Parser Get finds more than one Parameter:
"The Container".</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.PVL.Parser.CONTAINER_NAME">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Parser(java.io.Reader, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader,
long read_limit)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Creates a Parser using a Reader as the source of PVL statements,
and sets a limit on the amount to read.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The Reader to use as the source of characters.</dd><dd><code>read_limit</code> - The maximum amount to read.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.Reader, long)"><code>Set_Reader(Reader, long)</code></a></dd></dl>
</li>
</ul>
<a name="Parser(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Creates a Parser using a Reader as the source of PVL statements,
with no limit on the amount to read.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The Reader to use as the source of characters.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.Reader, long)"><code>Set_Reader(Reader, long)</code></a></dd></dl>
</li>
</ul>
<a name="Parser(java.io.File, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(<a href="/usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
long read_limit)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Creates a Parser using a File to create a new Reader as the
source of PVL statements, and sets a limit on the amount to read.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The File to be the basis for a new Reader.</dd><dd><code>read_limit</code> - The maximum amount to read.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.File, long)"><code>Set_Reader(File, long)</code></a></dd></dl>
</li>
</ul>
<a name="Parser(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(<a href="/usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Creates a Parser using a File to create a new Reader as the
source of PVL statements, with no limit on the amount to read.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The File to be the basis for a new Reader.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.File, long)"><code>Set_Reader(File, long)</code></a></dd></dl>
</li>
</ul>
<a name="Parser(java.io.InputStream, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input_stream,
long read_limit)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Creates a Parser using an InputStream to create a new Reader as the
source of PVL statements, and sets a limit on the amount to read.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input_stream</code> - The InputStream to be the basis for a new Reader.</dd><dd><code>read_limit</code> - The maximum amount to read.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.InputStream, long)"><code>Set_Reader(InputStream, long)</code></a></dd></dl>
</li>
</ul>
<a name="Parser(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input_stream)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Creates a Parser using an InputStream to create a new Reader as the
source of PVL statements, with no limit on the amount to read.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input_stream</code> - The InputStream to be the basis for a new Reader.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.InputStream, long)"><code>Set_Reader(InputStream, long)</code></a></dd></dl>
</li>
</ul>
<a name="Parser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser()</pre>
<div class="block">Creates a Parser with no source of PVL statements.</div>
</li>
</ul>
<a name="Parser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> string)</pre>
<div class="block">Creates a Parser using a String as the source of PVL statements.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>string</code> - The String to use as the source of characters.</dd></dl>
</li>
</ul>
<a name="Parser(char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(char[] char_array)</pre>
<div class="block">Creates a Parser using a character array as the source of PVL
statements.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>char_array</code> - The source of characters.</dd></dl>
</li>
</ul>
<a name="Parser(char[], int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Parser</h4>
<pre>public Parser(char[] char_array,
int offset,
int length)</pre>
<div class="block">Creates a Parser using a characer array subset as the source of PVL
statements.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>char_array</code> - The source of characters.</dd><dd><code>offset</code> - The array index where the character source starts.</dd><dd><code>length</code> - The number of characters to source.</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="Set_Reader(java.io.Reader, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Set_Reader</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Set_Reader(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> reader,
long read_limit)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Sets the Reader where the Parser will obtain characters.
<P>
If <a href="../../PIRL/Strings/String_Buffer_Reader.html#Filter_Input()"><code><CODE>Filter_Input</CODE></code></a> is true, then a <CODE>SIZED_RECORDS</CODE>
<a href="../../PIRL/PVL/Parser.html#Warning()"><code><CODE>Warning</CODE></code></a> is registered.
<P>
<B>N.B.</B>: When <CODE>Filter_Input</CODE> is used it will read the
first two characters from the reader to test them for non-printable
values, unless the test has already been done on the reader or <a href="../../PIRL/Strings/String_Buffer_Reader.html#Filter_Input(boolean)"><code>input filtering has been
disabled</code></a>. If no characters are yet available from the reader - e.g.
if the reader is backed by a pipe or network socket - then the read
will block until two characters become available (or an IOException
occurs). The base String_Buffer_Reader does its own
<CODE>Filter_Input</CODE> test every time its internal buffer content
is <a href="../../PIRL/Strings/String_Buffer_Reader.html#Extend()"><code>extended</code></a>. Therefore, to
prevent the Filter_Input() test from blocking when the reader is set
defer setting the reader until blocking is acceptable, it is known
that the required input will be available or filtering has been
disabled. For example:
<P>
<PRE>
Parser parser = new Parser ();
// The reader is certain not to need filtering.
parser.Filter_Input (false);
// Any of the Set_Reader methods may be used.
parser.Set_Reader (reader, read_limit);
</PRE>
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - The Reader source for Parser input. If null,
then there is no PVL source and thus nothing to be parsed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>. A
<CODE>FILE_IO</CODE> form is thrown if there is an IOException
from <CODE>Filter_Input</CODE>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/String_Buffer_Reader.html#Set_Reader(java.io.Reader)"><code>String_Buffer_Reader.Set_Reader(Reader)</code></a>,
<a href="../../PIRL/Strings/String_Buffer_Reader.html#Filter_Input()"><code>String_Buffer_Reader.Filter_Input()</code></a>,
<a href="../../PIRL/Strings/String_Buffer_Reader.html#Read_Limit(long)"><code>String_Buffer_Reader.Read_Limit(long)</code></a></dd></dl>
</li>
</ul>
<a name="Set_Reader(java.io.InputStream, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Set_Reader</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Set_Reader(<a href="/usr/share/doc/default-jdk-doc/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input_stream,
long read_limit)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Sets the Reader where the Parser will obtain characters by
constructing an InputStreamReader from the specified InputStream
and wrapping this in a BufferedReader, the same size as the
<CODE>Size_Increment</CODE> of the String_Buffer_Reader, for
efficiency.
The Parser's <a href="../../PIRL/PVL/Parser.html#CHARACTER_ENCODING"><code><CODE>CHARACTER_ENCODING</CODE></code></a> is used.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input_stream</code> - The InputStream source for Parser input. If
null then there is nothing to read.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - From <CODE>Set_Reader</CODE>. A
<CODE>FILE_IO</CODE> form is thrown if there is an
UnsupportedEncodingException when constructing the
InputStreamReader.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/String_Buffer_Reader.html#Size_Increment(int)"><code>String_Buffer_Reader.Size_Increment(int)</code></a></dd></dl>
</li>
</ul>
<a name="Set_Reader(java.io.File, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Set_Reader</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Set_Reader(<a href="/usr/share/doc/default-jdk-doc/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
long read_limit)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Sets the Reader where the Parser will obtain characters by
constructing a FileInputStream from the specified File and passing
this to the <a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.InputStream, long)"><code><CODE>Set_Reader
(InputStream, long)</CODE></code></a> method.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The File source for Parser input. If null, there
is nothing to read.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - A <CODE>FILE_IO</CODE> error condition will
occur if the File refers to a directory or a file for which
read permission is not provided. Any other IOException that
occurs while constructing the FileInputStream will also be
converted into a <CODE>PVL_Exception.FILE_IO</CODE> exception.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Set_Reader(java.io.InputStream, long)"><code>Set_Reader(InputStream, long)</code></a></dd></dl>
</li>
</ul>
<a name="Strict(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Strict</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Strict(boolean strict)</pre>
<div class="block">Enables or disables strict PVL syntax rules in the Parser.
<P>
Normally the Parser is tolerant. However, the default is controlled by
the <a href="../../PIRL/PVL/Parser.html#Strict_Default"><code>Strict_Default</code></a> value.
<P>
<B>N.B.</B>: Enabling strict syntax rules will prevent treating
<a href="../../PIRL/PVL/Parser.html#All_Values_Strings(boolean)"><code>all Values as Strings</code></a>.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>strict</code> - true if strict rules are applied; false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd></dl>
</li>
</ul>
<a name="Strict()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Strict</h4>
<pre>public boolean Strict()</pre>
<div class="block">Tests if the Parser will enforce strict PVL syntax rules.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the Parser will enforce strict syntax rules;
false otherwise.</dd></dl>
</li>
</ul>
<a name="Verbatim_Strings(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Verbatim_Strings</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Verbatim_Strings(boolean verbatim)</pre>
<div class="block">Enable or disable verbatim quoted strings.
<P>
With format control (<CODE>Verbatim_Strings</CODE> disabled)
multi-line quoted strings in PVL statements have white space
surrounding the line breaks compressed to a single space character -
except when <CODE>String_Continuation</CODE> is enabled and the last
non-white space character on the line is a dash ("-"), in which case
no space is included. This is because output formatting is expected
to be controlled by embedded format characters which are processed by
the Write method:
<P>
<BLOCKQUOTE>
\n - line break.<BR>
\t - horizontal tab.<BR>
\f - form feed (page break).<BR>
\ \ - backslash character.<BR>
\v - verbatim (no formatting) till the next \v.<BR>
</BLOCKQUOTE>
<P>
Without format control (<CODE>Verbatim_Strings</CODE> enabled) all
STRING Values are taken as-is.
<P>
By default verbatim strings are disabled. However, the default is
controlled by the <a href="../../PIRL/PVL/Parser.html#Verbatim_Strings_Default"><code>Verbatim_Strings_Default</code></a> value.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verbatim</code> - true if quoted strings in PVL statements are to
be taken verbatim, without format control.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Get_Parameter()"><code>Get_Parameter()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Get_Quoted_String()"><code>Get_Quoted_String()</code></a>,
<a href="../../PIRL/PVL/Parser.html#String_Continuation(boolean)"><code>String_Continuation(boolean)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Get_Comments()"><code>Get_Comments()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Get_Datum(PIRL.PVL.Value)"><code>Get_Datum(Value)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Get_Units()"><code>Get_Units()</code></a></dd></dl>
</li>
</ul>
<a name="Verbatim_Strings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Verbatim_Strings</h4>
<pre>public boolean Verbatim_Strings()</pre>
<div class="block">Tests if the Parser will handle quoted strings verbatim.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if quoted strings are taken verbatim; false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>Verbatim_Strings(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="String_Continuation(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String_Continuation</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> String_Continuation(boolean continuation)</pre>
<div class="block">Enable or disable string continuation.
<P>
When string continuation is enabled (the default) and <a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>verbatim strings</code></a> is disabled (the
default) the occurrance in a quoted string of a <a href="../../PIRL/PVL/Parser.html#STRING_CONTINUATION_DELIMITER"><code>STRING_CONTINUATION_DELIMITER</code></a> as the last character before the new
line sequence causes the string continuation delimiter and all
characters up to the next non-whitespace character to be removed from
the string; i.e. the string continues on the next line after any
whitespace.
<P>
By default string continuation is enabled. However, the default is
controlled by the <a href="../../PIRL/PVL/Parser.html#String_Continuation_Default"><code>String_Continuation_Default</code></a> value.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>continuation</code> - true if string continuation is to be enabled;
false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Get_Quoted_String()"><code>Get_Quoted_String()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>Verbatim_Strings(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="String_Continuation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>String_Continuation</h4>
<pre>public boolean String_Continuation()</pre>
<div class="block">Tests if the Parser will recognize multi-line string continuation.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if quoted string conintuation will be recognized; false
otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#String_Continuation(boolean)"><code>String_Continuation(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Crosshatch_Comments(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Crosshatch_Comments</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Crosshatch_Comments(boolean crosshatch_comments)</pre>
<div class="block">Enable or disable recognition of crosshatch comments.
A Crosshatch comment begins with the <a href="../../PIRL/PVL/Parser.html#CROSSHATCH"><code><CODE>CROSSHATCH</CODE></code></a> character and extends to the end of the
current line (marked by a <a href="../../PIRL/PVL/Parser.html#LINE_BREAK"><code><CODE>LINE_BREAK</CODE></code></a> character). Crosshatch comments are never
recognized in <a href="../../PIRL/PVL/Parser.html#Strict(boolean)"><code>Strict</code></a> mode.
<P>
<B>Note</B>: Crosshatch comments are not recognized in the PVL
syntax specification. Because of their common use in configuration
files, this special extension is provided to accommodate such
applications. Be default crosshatch comments are not recognized.
<P>
By default crosshatch comments are enabled. However, the default is
controlled by the <a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments_Default"><code>Crosshatch_Comments_Default</code></a> value.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>crosshatch_comments</code> - true if crosshatch comments are to
be recognized; false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd></dl>
</li>
</ul>
<a name="Crosshatch_Comments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Crosshatch_Comments</h4>
<pre>public boolean Crosshatch_Comments()</pre>
<div class="block">Tests if crosshatch comments will be recognized.
<P>
Regardless of this test, crosshatch comments are never recognized
in <a href="../../PIRL/PVL/Parser.html#Strict(boolean)"><code>Strict</code></a> mode.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if crosshatch comments will be recognized; false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments(boolean)"><code>Crosshatch_Comments(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="All_Values_Strings(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>All_Values_Strings</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> All_Values_Strings(boolean all_values_strings)</pre>
<div class="block">Enable or disable treating all values as strings.
<P>
When enabled, and <a href="../../PIRL/PVL/Parser.html#Strict(boolean)"><code>strict</code></a> syntax rules are
not enabled, all PVL parameter values will be parsed as <a href="../../PIRL/PVL/Value.html#STRING"><code>Strings</code></a>; no other Value <a href="../../PIRL/PVL/Value.html#Type()"><code>Type</code></a> will
be generated. This may be useful in cases where, for example, a
<a href="../../PIRL/PVL/Value.html#NUMERIC"><code>numeric</code></a> Type Value would be generated from a
PVL value representation that can not be converted to a binary value
with sufficient precision, or where unquoted PVL value representations
that would otherwise be expected to be <a href="../../PIRL/PVL/Value.html#IDENTIFIER"><code>identifiers</code></a> happen to contain all numeric digit characters.
<P>
By default treating all values as strings is disabled. However the
default is controlled by the <a href="../../PIRL/PVL/Parser.html#All_Values_Strings_Default"><code>All_Values_Strings_Default</code></a> value.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>all_values_strings</code> - true if all Values are to be generated
as <a href="../../PIRL/PVL/Value.html#STRING"><code>Value.STRING</code></a> Types; false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd></dl>
</li>
</ul>
<a name="All_Values_Strings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>All_Values_Strings</h4>
<pre>public boolean All_Values_Strings()</pre>
<div class="block">Tests if the Parser will treat all values as strings.
<P>
Regardless of this test, treating all values as strings will not
be enforced if <a href="../../PIRL/PVL/Parser.html#Strict(boolean)"><code>Strict</code></a> mode is enabled.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the Parser will treat all values as strings; false
otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#All_Values_Strings(boolean)"><code>All_Values_Strings(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Warning()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Warning</h4>
<pre>public <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a> Warning()</pre>
<div class="block">Gets the current warning status.
<P>
When conditions are encountered that are unusual enough to warrant
attention, but not an error condition that would prevent successful
processing which would cause an exception to be thrown, a warning
condition is registered. The warning is in the form of a
PVL_Exception that was not thrown. The current warning status is
either the <a href="../../PIRL/PVL/Parser.html#First_Warning(boolean)"><code><CODE>First_Warning</CODE></code></a> or the <a href="../../PIRL/PVL/Parser.html#Last_Warning(boolean)"><code><CODE>Last_Warning</CODE></code></a> since a <a href="../../PIRL/PVL/Parser.html#Reset_Warning()"><code><CODE>Reset_Warning</CODE></code></a>.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current warning status as a PVL_Exception object,
or null if no warning condition is registered.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL"><code>PVL_Exception</code></a>,
<a href="../../PIRL/PVL/Parser.html#First_Warning(boolean)"><code>First_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Last_Warning(boolean)"><code>Last_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Reset_Warning()"><code>Reset_Warning()</code></a></dd></dl>
</li>
</ul>
<a name="Reset_Warning()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Reset_Warning</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Reset_Warning()</pre>
<div class="block">Clears any warning status so that the <CODE>Warning</CODE> method
will return null until the next warning condition occurs.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Warning()"><code>Warning()</code></a></dd></dl>
</li>
</ul>
<a name="First_Warning(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>First_Warning</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> First_Warning(boolean first)</pre>
<div class="block">Enables or disables returning the first warning that occurs as the
current warning status.
The first warning is one that occurs when the current warning
status is null.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>first</code> - true to enable returning the first warning status;
false to return the last warning that occurred as the current
warning status.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Parser.html#First_Warning()"><code>First_Warning()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Reset_Warning()"><code>Reset_Warning()</code></a></dd></dl>
</li>
</ul>
<a name="First_Warning()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>First_Warning</h4>
<pre>public <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a> First_Warning()</pre>
<div class="block">Returns the first warning since the last <CODE>Reset_Warning</CODE>.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The first warning status as a PVL_Exception object,
or null if no warning condition is registered.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL"><code>PVL_Exception</code></a>,
<a href="../../PIRL/PVL/Parser.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Parser.html#First_Warning(boolean)"><code>First_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Reset_Warning()"><code>Reset_Warning()</code></a></dd></dl>
</li>
</ul>
<a name="Last_Warning(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Last_Warning</h4>
<pre>public <a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL">Parser</a> Last_Warning(boolean last)</pre>
<div class="block">Enables or disables returning the last warning that occurs as the
current warning status.
The last warning is the most recent one regarless of any previous
warning conditions that may have occured without an intervening
<CODE>Reset_Warning</CODE>.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>last</code> - true to enable returning the last warning status;
false to return the first warning condition that occurred as
the current warning status.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Parser.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Last_Warning()"><code>Last_Warning()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Reset_Warning()"><code>Reset_Warning()</code></a></dd></dl>
</li>
</ul>
<a name="Last_Warning()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Last_Warning</h4>
<pre>public <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a> Last_Warning()</pre>
<div class="block">Returns the last warning since a <CODE>Reset_Warning</CODE>.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The last warning status as a PVL_Exception object,
or null if no warning condition is registered.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL"><code>PVL_Exception</code></a>,
<a href="../../PIRL/PVL/Parser.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Last_Warning(boolean)"><code>Last_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Reset_Warning()"><code>Reset_Warning()</code></a></dd></dl>
</li>
</ul>
<a name="Get()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get</h4>
<pre>public <a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a> Get()
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets as many Parameters as possible.
<P>
When the source of PVL statements is a Reader, then an aggregate
Parameter named <a href="../../PIRL/PVL/Parser.html#CONTAINER_NAME"><code><CODE>CONTAINER_NAME</CODE></code></a>
will be provided to contain all the Parameters found (zero or
more). If this Parser was created with a String as the source of
PVL statements, then a container Parameter will only be provided if
more than one Paramter is found: the single Parameter found, or an
empty <CODE>UNKNOWN</CODE> Parameter if nothing is found.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A Parameter containing everything found from the input source.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - If an unrecoverable problem occurred while
parsing the input source.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Add_To(PIRL.PVL.Parameter)"><code>Add_To(Parameter)</code></a>,
<a href="../../PIRL/Strings/String_Buffer_Reader.html#String_Source()"><code>String_Buffer_Reader.String_Source()</code></a></dd></dl>
</li>
</ul>
<a name="Add_To(PIRL.PVL.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Add_To</h4>
<pre>public <a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a> Add_To(<a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a> The_Aggregate)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Adds to a Parameter all Parameters found from the input source.
Any Paramter added that is itself an <CODE>AGGREGATE</CODE> classification
will recursively invoke this method on the new aggregate Parameter.
<P>
While the source of PVL statements is not empty and <a href="../../PIRL/PVL/Parser.html#Get_Parameter()"><code><CODE>Get_Parameter</CODE></code></a> can assemble a
Parameter from the source, each new Parameter is <a href="../../PIRL/PVL/Parameter.html#Add(PIRL.PVL.Parameter)"><code><CODE>Add</CODE></code></a>ed to the specified
Parameter's aggregate list. <B>Note</B>: Parameters having
<CODE>END</CODE> classifications are not added, instead they stop
the addition of Parameters to the current aggregate list; additions
will continue with the parent of the current aggregate on returning
from recursive method invocations. However, if an
<CODE>END_PVL</CODE> Parameter is encountered no more Parameters
will be added regardless of the recursion level.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>The_Aggregate</code> - The aggregate Parameter to which to add
new Parameters from the input source.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The_Aggregate Parameter.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>BAD_ARGUMENT</CODE>
<DD>The_Aggregate Parameter is actually an
<CODE>ASSIGNMENT</CODE> with a non-null Value.
<DT><CODE>AGGREGATE_CLOSURE_MISMATCH</CODE>
<DD>In <CODE>Strict</CODE> mode, when an
<CODE>END_AGGREGATE</CODE> Parameter does not match the
specific classification of the Parameter containing the
aggregate list. This is only a <CODE>Warning</CODE> when
<CODE>Strict</CODE> mode is not enabled.
<DT>Others are possible during parsing.
</DL></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parameter.html#AGGREGATE"><code>Parameter.AGGREGATE</code></a>,
<a href="../../PIRL/Strings/String_Buffer_Reader.html#Is_Empty()"><code>String_Buffer_Reader.Is_Empty()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Get_Parameter()"><code>Get_Parameter()</code></a>,
<a href="../../PIRL/PVL/Parameter.html#Add(PIRL.PVL.Parameter)"><code>Parameter.Add(Parameter)</code></a>,
<a href="../../PIRL/PVL/Parameter.html#END"><code>Parameter.END</code></a>,
<a href="../../PIRL/PVL/Parameter.html#END_AGGREGATE"><code>Parameter.END_AGGREGATE</code></a>,
<a href="../../PIRL/PVL/Parameter.html#END_PVL"><code>Parameter.END_PVL</code></a></dd></dl>
</li>
</ul>
<a name="Get_Parameter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get_Parameter</h4>
<pre>public <a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a> Get_Parameter()
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets a Parameter from the source of PVL statements.
<P>
First, <a href="../../PIRL/PVL/Parser.html#Get_Comments()"><code><CODE>Get_Comments</CODE></code></a> is used to
to collect any and all comment sequences preceeding the parameter
proper as the Parameter's <CODE>Comments</CODE>.
<P>
The next sequence of non-<a href="../../PIRL/PVL/Parser.html#WHITESPACE"><code><CODE>WHITESPACE</CODE></code></a> characters is taken to be the Parameter's
<CODE>Name</CODE>. If the sequence is quoted (i.e. starts with a
<a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>TEXT_DELIMITER</CODE></code></a> or <a href="../../PIRL/PVL/Parser.html#SYMBOL_DELIMITER"><code><CODE>SYMBOL_DELIMITER</CODE></code></a>), then the name is
all characters within the quotes. Otherwise it is all characters up
to but not including the next <a href="../../PIRL/PVL/Parser.html#PARAMETER_NAME_DELIMITER"><code><CODE>PARAMETER_NAME_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>STATEMENT_END_DELIMITER</CODE></code></a>,
whitespace character, or comment sequence. The name is checked for
any <a href="../../PIRL/PVL/Parser.html#Bad_Character(java.lang.String)"><code><CODE>Bad_Character</CODE></code></a> and
a <CODE>Warning</CODE> will be registered (exception thrown in
<CODE>Strict</CODE> mode) if one is found. If
<CODE>Verbatim_Strings</CODE> is not enabled, then all character
escape sequences in the name are replaced with their corresponding
special characters.
<P>
If the name is associated with a <a href="../../PIRL/PVL/Parser.html#Special_Classification(java.lang.String)"><code><CODE>Special_Classification</CODE></code></a>, then the Parameter is given
that classification; otherwise it is tentatively classified as a
<CODE>TOKEN</CODE>.
<P>
If, after any whitespace or comments following the Parameter name,
a <a href="../../PIRL/PVL/Parser.html#PARAMETER_NAME_DELIMITER"><code><CODE>PARAMETER_NAME_DELIMITER</CODE></code></a> is found, then the <a href="../../PIRL/PVL/Parser.html#Get_Value()"><code><CODE>Get_Value</CODE></code></a> method is used to obtain the
expected Parameter Value. If the Parameter had been given the
<CODE>TOKEN</CODE> classification, then the classification is
upgraded to <CODE>ASSIGNMENT</CODE>. If, however, the Parameter had
been given an <CODE>AGGREGATE</CODE> classification as a result of
its special name, and the Value obtained is a <CODE>STRING</CODE>
type, then the Parameter's name is changed to the Value String; if,
in this case, the Value found is not a <CODE>STRING</CODE> type a
<CODE>Warning</CODE> will be registered (exception thrown in
<CODE>Strict</CODE> mode).
<P>
Having assembled a valid Parameter, the <CODE>Next_Location</CODE>
in the input stream is moved forward past any whitespace or
<CODE>STATEMENT_END_DELIMITER</CODE>.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The next Parameter assembled from the input stream, or null
if no Parameter can be assembled because the input stream is
empty.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>ILLEGAL_SYNTAX</CODE>
<DD><CODE>Strict</CODE> mode is enabled and the Parameter
name was quoted.
<DT><CODE>RESERVED_CHARACTER</CODE>
<DD>The Parameter name contained a bad character and
<CODE>Strict</CODE> mode is enabled.
<DT><CODE>GROUP_VALUE</CODE>
<DD>The Value obtained for an <CODE>AGGREGATE</CODE> Parameter
is not a <CODE>STRING</CODE> type.
<DT><CODE>FILE_IO</CODE>
<DD>If an IOException occurred in the String_Buffer_Reader.
</DL></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Get_Comments()"><code>Get_Comments()</code></a>,
<a href="../../PIRL/PVL/Parameter.html#Comments()"><code>Parameter.Comments()</code></a>,
<a href="../../PIRL/PVL/Parameter.html#Name()"><code>Parameter.Name()</code></a>,
<a href="../../PIRL/PVL/Parser.html#translate_from_escape_sequences(PIRL.Strings.String_Buffer)"><code>translate_from_escape_sequences(String_Buffer)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Special_Classification(java.lang.String)"><code>Special_Classification(String)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Get_Value()"><code>Get_Value()</code></a></dd></dl>
</li>
</ul>
<a name="Get_Comments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get_Comments</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Get_Comments()
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets the next sequence of comments from the source of PVL statements
as a single comment String.
After skipping over any whitespace, the next characters must start
a comment sequence or nothing (null) is returned.
<P>
A PVL comment uses C-style conventions: It starts after the <a href="../../PIRL/PVL/Parser.html#COMMENT_START_DELIMITERS"><code><CODE>COMMENT_START_DELIMITERS</CODE></code></a>
and ends before the <a href="../../PIRL/PVL/Parser.html#COMMENT_END_DELIMITERS"><code><CODE>COMMENT_END_DELIMITERS</CODE></code></a>. A comment without the closing
<CODE>COMMENT_END_DELIMITERS</CODE> will result in a
<CODE>MISSING_COMMENT_END</CODE> exception in <CODE>Strict</CODE>
mode; otherwise a <CODE>Warning</CODE> is registered and the next
line break, <a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>STATEMENT_END_DELIMITER</CODE></code></a>, or the end of the input
stream is taken as the end of the comment. <B>Note</B>: Though an
effort is made to recover from encountering an unending comment,
this will only be effective when no other normally closed comment
occurs in the input stream (if a normally closed comment does occur
after an unclosed comment, the latter will be taken as the end of
the former), and in this case the input stream will have been read
into memory until it is empty.
<P>
Sequential comments, with nothing but white space intervening, are
accumulated with a single new-line ('\n') chararacter separating
them in the resulting String that is returned. In
<CODE>Strict</CODE> mode comments that wrap across line breaks
cause an exception. When <CODE>Verbatim_Strings</CODE> are not
enabled whitespace is trimmed from the end of each comment (but not
the beginning), and escape sequences are translated into their
corresponding special characters.
<P>
If any comments are found the <CODE>Next_Location</CODE> of the
input stream is moved to the position immediately following the
last comment.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A String containing the sequence of comments found, or null
if no comment occurs before the next PVL item or the end of input.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>ILLEGAL_SYNTAX</CODE>
<DD><CODE>Strict</CODE> mode is enabled and a comment
continues on more than one line.
<DT><CODE>MISSING_COMMENT_END</CODE>
<DD>A comment does not have
<CODE>COMMENT_END_DELIMITERS</CODE> and <CODE>Strict</CODE>
mode is enabled. If <CODE>Strict</CODE> is not enabled and
a line or statement delimiter can not be found, then the
exception is thrown.
<DT><CODE>FILE_IO</CODE>
<DD>If an IOException occurred in the String_Buffer_Reader.
</DL></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>Verbatim_Strings(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Get_Value()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get_Value</h4>
<pre>public <a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a> Get_Value()
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets a Value from the source of PVL statements.
<P>
If the next character, after skipping any whitespace and comments,
is a <a href="../../PIRL/PVL/Parser.html#SET_START_DELIMITER"><code><CODE>SET_START_DELIMITER</CODE></code></a>
or <a href="../../PIRL/PVL/Parser.html#SEQUENCE_START_DELIMITER"><code><CODE>SEQUENCE_START_DELIMITER</CODE></code></a> the Value being assembled is
typed as a <CODE>SET</CODE> or <CODE>SEQUENCE</CODE>, respectively,
and the <CODE>Next_Location</CODE> in the input stream is moved
over the character; otherwise the Value is tentatively typed as a
<CODE>SET</CODE>, and the <CODE>Next_Location</CODE> is not moved.
<P>
Now a cycle is entered to obtain as many sequential datum values as
are available. The first step is to skip any whitespace and
comments and test the character that is found. If the character is
a <a href="../../PIRL/PVL/Parser.html#SET_END_DELIMITER"><code><CODE>SET_END_DELIMITER</CODE></code></a> or
<a href="../../PIRL/PVL/Parser.html#SEQUENCE_END_DELIMITER"><code><CODE>SEQUENCE_END_DELIMITER</CODE></code></a>,
then the <CODE>Next_Location</CODE> in the input stream is moved
over the character and <CODE>Get_Units</CODE> is used to set the
<CODE>ARRAY</CODE> Value's units description before ending the
datum cycle. If the character is a <a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>STATEMENT_END_DELIMITER</CODE></code></a> the datum cycle ends. A
reserved <a href="../../PIRL/PVL/Parser.html#PARAMETER_NAME_DELIMITER"><code><CODE>PARAMETER_NAME_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#PARAMETER_VALUE_DELIMITER"><code><CODE>PARAMETER_VALUE_DELIMITER</CODE></code></a>,
<a href="../../PIRL/PVL/Parser.html#UNITS_START_DELIMITER"><code><CODE>UNITS_START_DELIMITER</CODE></code></a>,
<a href="../../PIRL/PVL/Parser.html#UNITS_END_DELIMITER"><code><CODE>UNITS_END_DELIMITER</CODE></code></a>, or
<a href="../../PIRL/PVL/Parser.html#NUMBER_BASE_DELIMITER"><code><CODE>NUMBER_BASE_DELIMITER</CODE></code></a>
character here is an <CODE>ILLEGAL_SYNTAX</CODE> exception. For any
other character the <CODE>Next_Location</CODE> is moved forward to
its position as a possible datum.
<P>
When the character at this location is a <a href="../../PIRL/PVL/Parser.html#SET_START_DELIMITER"><code><CODE>SET_START_DELIMITER</CODE></code></a> or <a href="../../PIRL/PVL/Parser.html#SEQUENCE_START_DELIMITER"><code><CODE>SEQUENCE_START_DELIMITER</CODE></code></a>
this method is called recursively to get a subarray as the datum.
Otherwise the <CODE>Get_Datum</CODE> method is used to get a basic
value followed by the <CODE>Get_Units</CODE> method to get any
units description for the new datum. If no datum is obtained the
datum cycle ends, otherwise the new datum is added to the Vector of
Value's being accumulated for this new Value.
<P>
After skipping any whitespace and comments the next character is
checked. A reserved <a href="../../PIRL/PVL/Parser.html#PARAMETER_NAME_DELIMITER"><code><CODE>PARAMETER_NAME_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#UNITS_START_DELIMITER"><code><CODE>UNITS_START_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#UNITS_END_DELIMITER"><code><CODE>UNITS_END_DELIMITER</CODE></code></a>, or <a href="../../PIRL/PVL/Parser.html#NUMBER_BASE_DELIMITER"><code><CODE>NUMBER_BASE_DELIMITER</CODE></code></a>
character here is an <CODE>ILLEGAL_SYNTAX</CODE> exception. A
<a href="../../PIRL/PVL/Parser.html#SET_START_DELIMITER"><code><CODE>SET_START_DELIMITER</CODE></code></a> or
<a href="../../PIRL/PVL/Parser.html#SEQUENCE_START_DELIMITER"><code><CODE>SEQUENCE_START_DELIMITER</CODE></code></a> character will also generate
an <CODE>ILLEGAL_SYNTAX</CODE> exception, but if
<CODE>Strict</CODE> mode is not enabled this will just be
registered as a <CODE>Warning</CODE> and the
<CODE>Next_Location</CODE> will be moved to the character's
position before continuing the datum cycle from the beginning. If
the character is a <a href="../../PIRL/PVL/Parser.html#PARAMETER_VALUE_DELIMITER"><code><CODE>PARAMETER_VALUE_DELIMITER</CODE></code></a> the
<CODE>Next_Location</CODE> is moved over the character and the
datum cycle returns to the beginning. For a <a href="../../PIRL/PVL/Parser.html#SET_END_DELIMITER"><code><CODE>SET_END_DELIMITER</CODE></code></a> or <a href="../../PIRL/PVL/Parser.html#SEQUENCE_END_DELIMITER"><code><CODE>SEQUENCE_END_DELIMITER</CODE></code></a>, if
the character does not correspond to the delimiter that began the
array an <CODE>ARRAY_CLOSURE_MISMATCH</CODE> <CODE>Warning</CODE>
is registered (this exception is thrown in <CODE>Strict</CODE>
mode). Then the <CODE>Next_Location</CODE> is moved over the
character and the <CODE>Get_Units</CODE> method is used to set this
Value's units description before ending the datum cycle. Any other
character also causes the datum cycle to end.
<P>
After the datum cycle has collected as many Values as possible, if
this new Value was not begun with a <a href="../../PIRL/PVL/Parser.html#SET_START_DELIMITER"><code><CODE>SET_START_DELIMITER</CODE></code></a> or <a href="../../PIRL/PVL/Parser.html#SEQUENCE_START_DELIMITER"><code><CODE>SEQUENCE_START_DELIMITER</CODE></code></a>
and the accumulated Values Vector containins less than two Values
then the initial tentative <CODE>SET</CODE> type does not apply. In
this case an empty accumlated Values Vector results in this new
Value being an <CODE>UNNOWN</CODE> type (i.e. it is empty). When
only one Value was collected it is the new Value that is returned.
When two or more Values were collected the Vector containing them
is set as the data of this <CODE>ARRAY</CODE> Value.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The next Value assembled from the input stream, or null if
no Value can be assembled because the input stream is empty.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>ILLEGAL_SYNTAX</CODE>
<DD>A misplaced reserved character was found.
<DT><CODE>ARRAY_CLOSURE_MISMATCH</CODE>
<DD>The delimiter character ending an array of Values
does not correspond to the one that began the array.
<DT><CODE>FILE_IO</CODE>
<DD>If an IOException occurred in the String_Buffer_Reader.
</DL></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Value.html#set_type(int)"><code>Value.set_type(int)</code></a>,
<a href="../../PIRL/PVL/Value.html#Units(java.lang.String)"><code>Value.Units(String)</code></a>,
<a href="../../PIRL/PVL/Parser.html#Get_Datum(PIRL.PVL.Value)"><code>Get_Datum(Value)</code></a></dd></dl>
</li>
</ul>
<a name="Get_Datum(PIRL.PVL.Value)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get_Datum</h4>
<pre>public <a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a> Get_Datum(<a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a> The_Value)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets a datum from the source of PVL statements.
<P>
After skipping any whitespace or comments, the next character is
checked to determine the type of datum to parse. For a <a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>STATEMENT_END_DELIMITER</CODE></code></a>
nothing happens. A reserved <a href="../../PIRL/PVL/Parser.html#PARAMETER_NAME_DELIMITER"><code><CODE>PARAMETER_NAME_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#PARAMETER_VALUE_DELIMITER"><code><CODE>PARAMETER_VALUE_DELIMITER</CODE></code></a>,
<a href="../../PIRL/PVL/Parser.html#SET_START_DELIMITER"><code><CODE>SET_START_DELIMITER</CODE></code></a>,
<a href="../../PIRL/PVL/Parser.html#SET_END_DELIMITER"><code><CODE>SET_END_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#SEQUENCE_START_DELIMITER"><code><CODE>SEQUENCE_START_DELIMITER</CODE></code></a>,
<a href="../../PIRL/PVL/Parser.html#SEQUENCE_END_DELIMITER"><code><CODE>SEQUENCE_END_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#UNITS_START_DELIMITER"><code><CODE>UNITS_START_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#UNITS_END_DELIMITER"><code><CODE>UNITS_END_DELIMITER</CODE></code></a>, or <a href="../../PIRL/PVL/Parser.html#NUMBER_BASE_DELIMITER"><code><CODE>NUMBER_BASE_DELIMITER</CODE></code></a> character here is an
<CODE>ILLEGAL_SYNTAX</CODE> exception. For a <a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>TEXT_DELIMITER</CODE></code></a> or <a href="../../PIRL/PVL/Parser.html#SYMBOL_DELIMITER"><code><CODE>SYMBOL_DELIMITER</CODE></code></a> the <CODE>Get_Quoted_String</CODE>
method is used to set the datum of the Value and its type is set to
<CODE>TEXT</CODE> or <CODE>SYMBOL</CODE> respectively.
<P>
For any ordinary character the substring up to, but not including,
the next <a href="../../PIRL/PVL/Parser.html#WHITESPACE"><code><CODE>WHITESPACE</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#PARAMETER_VALUE_DELIMITER"><code><CODE>PARAMETER_VALUE_DELIMITER</CODE></code></a>,
<a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>STATEMENT_END_DELIMITER</CODE></code></a>,
<a href="../../PIRL/PVL/Parser.html#COMMENT_START_DELIMITERS"><code><CODE>COMMENT_START_DELIMITERS</CODE></code></a>,
any of the SET/SEQUENCE/UNITS START/END delimiters, or the end of
the input stream is used for parsing a datum. If
<CODE>Verbatim_Strings</CODE> is not enabled, then all escape
sequences in the substring are converted to their special character
equivalents.
<P>
The datum substring is first assumed to represent a number. If the
substring contains a <a href="../../PIRL/PVL/Parser.html#NUMBER_BASE_DELIMITER"><code><CODE>NUMBER_BASE_DELIMITER</CODE></code></a> ('#') the number is presumed to
be in radix base notation:
<P>
<BLOCKQUOTE>
[<B><I>sign</I></B>]<B><I>base</I>#<I>value</I>#</B>
</BLOCKQUOTE>
<P>
In this case the initial base integer is obtained using the
<CODE>Integer.parseInt</CODE> method and becomes the Value's
<CODE>Base</CODE>, and the value number is obtained using the
<CODE>Long.parseLong</CODE> method with the base argument specified
and becomes the Value's datum. The sign is applied to the value
number. The Value becomes type <CODE>INTEGER</CODE>. Without the
<CODE>NUMBER_BASE_DELIMITER</CODE> the datum substring is taken to
be in decimal notation. If this number conversion fails, then the
<CODE>Double.valueOf</CODE> method is tried on the datum substring
to produce a type <CODE>REAL</CODE> Value.
<P>
<B>N.B.</B>: If treating <a href="../../PIRL/PVL/Parser.html#All_Values_Strings(boolean)"><code>all values
as strings</code></a> has been enabled, and <a href="../../PIRL/PVL/Parser.html#Strict(boolean)"><code>Strict</code></a> mode
is not enabled, then the value is not assumed to be a number; it is
always taken as string.
<P>
If parsing the datum substring as a number fails, then the Value is
a <CODE>STRING</CODE> and its datum is the substring. If the
substring contains one of the <a href="../../PIRL/PVL/Parser.html#DATE_TIME_DELIMITERS"><code><CODE>DATE_TIME_DELIMITERS</CODE></code></a> the Value is given the
<CODE>DATE_TIME</CODE> type. Otherwise it is the
<CODE>IDENTIFIER</CODE> type. The datum substring is also checked
for a <CODE>Bad_Character</CODE> with a <CODE>Warning</CODE> being
registered (exception thrown in <CODE>Strict</CODE> mode) if one is
found.
<P>
Once a datum has been given to the Value the
<CODE>Next_Location</CODE> in the input stream is moved to the
position immediately following the datum substring.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>The_Value</code> - The Value to which the next datum is to be applied.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The_Value, or null if the input stream is empty.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>ILLEGAL_SYNTAX</CODE>
<DD>A misplaced reserved character was found.
<DT><CODE>RESERVED_CHARACTER</CODE>
<DD>A <CODE>STRING</CODE> Value contains a reserved
character.
<DT><CODE>FILE_IO</CODE>
<DD>If an IOException occurred in the String_Buffer_Reader.
</DL></dd><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Integer.html?is-external=true#parseInt(java.lang.String)" title="class or interface in java.lang"><code>Integer.parseInt(String)</code></a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Long.html?is-external=true#parseLong(java.lang.String, int)" title="class or interface in java.lang"><code>Long.parseLong(String, int)</code></a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Double.html?is-external=true#valueOf(java.lang.String)" title="class or interface in java.lang"><code>Double.valueOf(String)</code></a>,
<a href="../../PIRL/PVL/Value.html#set_data(java.lang.Object)"><code>Value.set_data(Object)</code></a>,
<a href="../../PIRL/PVL/Value.html#Base(int)"><code>Value.Base(int)</code></a>,
<a href="../../PIRL/PVL/Value.html#set_type(int)"><code>Value.set_type(int)</code></a>,
<a href="../../PIRL/PVL/Parser.html#translate_from_escape_sequences(PIRL.Strings.String_Buffer)"><code>translate_from_escape_sequences(String_Buffer)</code></a></dd></dl>
</li>
</ul>
<a name="Get_Units()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get_Units</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Get_Units()
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets a units description String from the source of PVL statements.
<P>
After skipping over any whitespace, the next character must start a
units description sequence or nothing (null) is returned. A units
description sequence starts after a <a href="../../PIRL/PVL/Parser.html#UNITS_START_DELIMITER"><code><CODE>UNITS_START_DELIMITER</CODE></code></a> and ends before a <a href="../../PIRL/PVL/Parser.html#UNITS_END_DELIMITER"><code><CODE>UNITS_END_DELIMITER</CODE></code></a>. A units
description sequence without the closing
<CODE>UNITS_END_DELIMITER</CODE> will result in a
<CODE>MISSING_UNITS_END</CODE> exception in <CODE>Strict</CODE>
mode; otherwise a <CODE>Warning</CODE> is registered and the next
<a href="../../PIRL/PVL/Parser.html#PARAMETER_VALUE_DELIMITER"><code><CODE>PARAMETER_VALUE_DELIMITER</CODE></code></a>, any of the
SET/SEQUENCE/UNITS START/END delimiters, <a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>STATEMENT_END_DELIMITER</CODE></code></a>, or
the end of the input stream is taken as the end of the units
description. <B>Note</B>: Though an effort is made to recover from
encountering an unending units description, this will only be
effective when no other normally closed units descripiton occurs in
the input stream (if a normally closed units descripiton does occur
after an unclosed units description, the latter will be taken as
the end of the former), and in this case the input stream will have
been read into memory until it is empty.
<P>
Sequential comments, with nothing but white space intervening, are
accumulated with a single new-line ('\n') chararacter separating
them in the resulting String that is returned. In
<CODE>Strict</CODE> mode comments that wrap across line breaks
cause an exception. When <CODE>Verbatim_Strings</CODE> are not
enabled whitespace is trimmed from the end of each comment (but not
the beginning), and escape sequences are translated into their
corresponding special characters.
<P>
If a units descripiton is found the <CODE>Next_Location</CODE> of the
input stream is moved to the position immediately following it. The
units description is trimmed of leading and trailing whitespace.
If <CODE>Verbatim_Strings</CODE> is not enabled, then all comment
sequences are removed from the units description String, all whitespace
sequences are collapsed to a single space (' ') character, and
escape sequences are substituted for their corresponding special
characters.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A units description String, or null if no units description
occurs before the next PVL item or the end of input.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>MISSING_UNITS_END</CODE>
<DD>A units description does not have a
<CODE>UNITS_END_DELIMITER</CODE>.
<DT><CODE>FILE_IO</CODE>
<DD>If an IOException occurred in the String_Buffer_Reader.
</DL></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>Verbatim_Strings(boolean)</code></a>,
<a href="../../PIRL/PVL/Parser.html#translate_from_escape_sequences(PIRL.Strings.String_Buffer)"><code>translate_from_escape_sequences(String_Buffer)</code></a></dd></dl>
</li>
</ul>
<a name="Get_Quoted_String()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get_Quoted_String</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Get_Quoted_String()
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets a quoted String from the source of PVL statements.
<P>
The next non-whitespace character is taken to be the "quote"
character. The characters following the first quote character up to
but not including the next, non-escaped (not preceeded by a
backslash, '\') quote character are the quoted string. If the
closing quote character can not be found, then a
<CODE>MISSING_QUOTE_END</CODE> <CODE>Warning</CODE> will be
registered (the exception will be thrown in <CODE>Strict</CODE>
mode) and the quoted string will end at the end of the input
stream. <B>Note</B>: The lack of a closing quote character will
cause the entire input stream to be read into memory until it is
emtpy. The <CODE>Next_Location</CODE> is moved to the position
immediately following the last quote character.
<P>
If <CODE>Verbatim_Strings</CODE> is not enabled then line break
sequences (one or more sequential line breaks) and any surrounding
whitespace (whitespace ending the last line and beginning the next
line) are replaced with a single space (' ') character. If, however,
<CODE>String_Continuation</CODE> is enabled and the last
non-whitespace character before the line break sequence is a <a href="../../PIRL/PVL/Parser.html#STRING_CONTINUATION_DELIMITER"><code><CODE>STRING_CONTINUATION_DELIMITER</CODE></code></a> then no space remains
(i.e. the string ending with the last non-whitespace character on the
last line is continued with the first non-whitspace character on the
next line). In addition, escape sequences are translated to their
corresponding special characters. Sequences of characters bracketed
by <a href="../../PIRL/PVL/Parser.html#VERBATIM_STRING_DELIMITERS"><code><CODE>VERBATIM_STRING_DELIMITERS</CODE></code></a> are taken verbatim; they are
subject to neither end of line treatment nor escape sequence
translation.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A String, or null if no non-whitespace character occurs
before the end of input.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>MISSING_QUOTE_END</CODE>
<DD>A closing quote was not found in the input stream.
<DT><CODE>FILE_IO</CODE>
<DD>If an IOException occurred in the String_Buffer_Reader.
</DL></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Verbatim_Strings(boolean)"><code>Verbatim_Strings(boolean)</code></a>,
<a href="../../PIRL/PVL/Parser.html#String_Continuation(boolean)"><code>String_Continuation(boolean)</code></a>,
<a href="../../PIRL/Strings/String_Buffer.html#escape_to_special()"><code>String_Buffer.escape_to_special()</code></a></dd></dl>
</li>
</ul>
<a name="skip_whitespace_and_comments(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skip_whitespace_and_comments</h4>
<pre>public long skip_whitespace_and_comments(long location)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Gets the next location in the PVL source stream following any
sequence of whitespace and/or comments.
A <a href="../../PIRL/PVL/Parser.html#STATEMENT_CONTINUATION_DELIMITER"><code><CODE>STATEMENT_CONTINUATION_DELIMITER</CODE></code></a> and any <a href="../../PIRL/PVL/Parser.html#Crosshatch_Comments(boolean)"><code>Crosshatch_Comments</code></a> (if enabled) are
included in the whitespace category. <B>Note</B>: As with the
<CODE>Get_Comments</CODE> method, a comment without a closing
sequence is taken to end and the next line break, <a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>STATEMENT_END_DELIMITER</CODE></code></a>, or
the end of the input stream; but this condition will cause the
entire input stream to be read into memory.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - The starting location from which to skip over
whitespace and comments.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The location of the next character after any whitespace or
comments.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code> - <DL>
<DT><CODE>MISSING_COMMENT_END</CODE>
<DD>A comment does not have
<CODE>COMMENT_END_DELIMITERS</CODE> and <CODE>Strict</CODE>
mode is enabled.
<DT><CODE>FILE_IO</CODE>
<DD>If an IOException occurred in the String_Buffer_Reader.
</DL></dd></dl>
</li>
</ul>
<a name="translate_from_escape_sequences(PIRL.Strings.String_Buffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translate_from_escape_sequences</h4>
<pre>public static <a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a> translate_from_escape_sequences(<a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a> string)</pre>
<div class="block">Translates escape sequences in a String_Buffer to their
corresponding special characters.
The <a href="../../PIRL/Strings/String_Buffer.html#escape_to_special()"><code><CODE>escape_to_special</CODE></code></a> method is used to translate escape
sequences to special characters. However the occurance of <a href="../../PIRL/PVL/Parser.html#VERBATIM_STRING_DELIMITERS"><code><CODE>VERBATIM_STRING_DELIMITERS</CODE></code></a> starts a sequence of
characters that are taken verbatim (they are not translated) up to
the next <CODE>VERBATIM_STRING_DELIMITERS</CODE> or the end of the
string (the <CODE>VERBATIM_STRING_DELIMITERS</CODE> are dropped).
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>string</code> - The String_Buffer to be translated.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The translated String_Buffer.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/String_Buffer.html#escape_to_special()"><code>String_Buffer.escape_to_special()</code></a></dd></dl>
</li>
</ul>
<a name="Bad_Character(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Bad_Character</h4>
<pre>public static int Bad_Character(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> string)</pre>
<div class="block">Checks a String for any bad character.
A bad character is one of the <a href="../../PIRL/PVL/Parser.html#RESERVED_CHARACTERS"><code><CODE>RESERVED_CHARACTERS</CODE></code></a> or a non-printable character.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>string</code> - The String to check.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The index of the first bad character found in the string,
or -1 if no bad characters were found.</dd></dl>
</li>
</ul>
<a name="isprint(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isprint</h4>
<pre>public static boolean isprint(char character)</pre>
<div class="block">Tests if a character is printable: in the ASCII range from the
space character (' ') to the tilde character ('~') inclusive.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>character</code> - The char to test.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the character is printable; false otherwise.</dd></dl>
</li>
</ul>
<a name="Special_Classification(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Special_Classification</h4>
<pre>public static int Special_Classification(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
<div class="block">Gets the Parameter classification code corresponding to the
specified special Parameter name String.
The special Parameter names and their classification codes are:
<P>
<I>Begin_Object</I> or <I>BeginObject</I> - <CODE>BEGIN_OBJECT</CODE><BR>
<I>Object</I> - <CODE>OBJECT</CODE><BR>
<I>End_Object</I> or <I>EndObject</I> - <CODE>END_OBJECT</CODE><BR>
<I>Begin_Group</I> or <I>BeginGroup</I> - <CODE>BEGIN_GROUP</CODE><BR>
<I>Group</I> - <CODE>GROUP</CODE><BR>
<I>End_Group</I> or <I>EndGroup</I> - <CODE>END_GROUP</CODE><BR>
<I>End</I> - <CODE>END_PVL</CODE><BR>
<P>
The names are not case sensitive.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - A String that may be a special Parameter name.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the Parameter classification code associated with the
special Parameter name; or -1 if the name is not a special
Parameter name.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL"><code>Parameter</code></a></dd></dl>
</li>
</ul>
<a name="Special_Name(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Special_Name</h4>
<pre>public static <a href="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> Special_Name(int classification)</pre>
<div class="block">Gets the special Parameter name String for the specified Parameter
classification code.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classification</code> - A Parameter classification code int.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The special Parameter name String associated with the
classification code; or null if the classification code is not
associated with a special Parameter name.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html#Special_Classification(java.lang.String)"><code>Special_Classification(String)</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/PVL/Parser.html" target="_top">Frames</a></li>
<li><a href="Parser.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|