/usr/share/doc/libpirl-java/api/PIRL/PVL/Lister.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 | <!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>Lister</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="Lister";
}
//-->
</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/Invalid_Map_Syntax.html" title="class in PIRL.PVL"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/PVL/Parameter.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/Lister.html" target="_top">Frames</a></li>
<li><a href="Lister.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 Lister" class="title">Class Lister</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>PIRL.PVL.Lister</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Lister</span>
extends <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></pre>
<div class="block">A <I>Lister</I> writes PVL syxtax.
<P>
A <I>Lister</I> complements a <I>Parser</I> in that the latter
interprets Parameter Value Language (PVL) syntax from a Reader into
<I>Parameter</I> and <I>Value</I> objects, while the former
generates PVL syntax to a Writer.
<P></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Parser.html" title="class in PIRL.PVL"><code>Parser</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/Lister.html#First_Warning_Default">First_Warning_Default</a></strong></code>
<div class="block">The default for returning the <a href="../../PIRL/PVL/Lister.html#First_Warning(boolean)"><code>first
warning</code></a> (or <a href="../../PIRL/PVL/Lister.html#Last_Warning(boolean)"><code>last warning</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/Lister.html#ID">ID</a></strong></code>
<div class="block">Class name and version identification.</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/Lister.html#INDENT">INDENT</a></strong></code>
<div class="block">The indent character(s).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Indent_Arrays_Default">Indent_Arrays_Default</a></strong></code>
<div class="block">The default for applying <a href="../../PIRL/PVL/Lister.html#Indent_Arrays(boolean)"><code>array indenting</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Indent_Level_Default">Indent_Level_Default</a></strong></code>
<div class="block">The default <a href="../../PIRL/PVL/Lister.html#Indent_Level(int)"><code>statement base indent level</code></a>
(none if negative).</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/Lister.html#NEW_LINE">NEW_LINE</a></strong></code>
<div class="block">The platform's native line separator (newline) String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Strict_Default">Strict_Default</a></strong></code>
<div class="block">The default for enforcing <a href="../../PIRL/PVL/Lister.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/Lister.html#Verbatim_Strings_Default">Verbatim_Strings_Default</a></strong></code>
<div class="block"><a href="../../PIRL/PVL/Lister.html#Verbatim_Strings(boolean)"><code>Verbatim strings</code></a> default.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </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/Lister.html#Lister()">Lister</a></strong>()</code>
<div class="block">Creates a Lister with the default (System.out) destination for PVL
statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Lister.html#Lister(java.io.File)">Lister</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 Lister using a File as the destination for PVL
statements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Lister.html#Lister(java.io.OutputStream)">Lister</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output_stream)</code>
<div class="block">Creates a Lister using an OutputStream as the destination for PVL
statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/PVL/Lister.html#Lister(java.io.Writer)">Lister</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer)</code>
<div class="block">Creates a Lister using a Writer as the destination for 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/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.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/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.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/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Get_Writer()">Get_Writer</a></strong>()</code>
<div class="block">Gets the current destination for Lister characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Indent_Arrays()">Indent_Arrays</a></strong>()</code>
<div class="block">Tests if Array Values will be indented.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Indent_Arrays(boolean)">Indent_Arrays</a></strong>(boolean indent)</code>
<div class="block">Enables or disables indenting of Array Value listings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Indent_Level()">Indent_Level</a></strong>()</code>
<div class="block">Gets the current base indent level.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Indent_Level(int)">Indent_Level</a></strong>(int level)</code>
<div class="block">Sets the base indenting level when listing PVL statements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Indent(boolean)">Indent</a></strong>(boolean indent)</code>
<div class="block">Enables or disables indenting of PVL statement listings.</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/Lister.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/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.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/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.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/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Set_Writer(java.io.File)">Set_Writer</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">Sets the Writer where the Lister will send characters by constructing
a FileWriter from the specified File and wrapping this in a BufferedWriter
for efficiency.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Set_Writer(java.io.OutputStream)">Set_Writer</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output_stream)</code>
<div class="block">Sets the Writer where the Lister will send characters by
constructing an OutputStreamWriter from the specified OutputStream
and wrapping this in a BufferedWriter for efficiency.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Set_Writer(java.io.Writer)">Set_Writer</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer)</code>
<div class="block">Sets the Writer where the Lister will send characters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Strict()">Strict</a></strong>()</code>
<div class="block">Tests if the Lister will enforce strict PVL syntax rules.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Strict(boolean)">Strict</a></strong>(boolean strict)</code>
<div class="block">Enables or disables strict PVL syntax rules in the Lister.</div>
</td>
</tr>
<tr class="altColor">
<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/Lister.html#translate_to_escape_sequences(PIRL.Strings.String_Buffer)">translate_to_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 special characters in a String_Buffer to their
corresponding escape sequences.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Verbatim_Strings()">Verbatim_Strings</a></strong>()</code>
<div class="block">Tests if verbatim strings mode is enabled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.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="rowColor">
<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/Lister.html#Warning()">Warning</a></strong>()</code>
<div class="block">Gets the current warning status.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Write_Comments(java.lang.String)">Write_Comments</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> comments)</code>
<div class="block">Writes a PVL comments sequence at the current indent level.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Write_Comments(java.lang.String, int)">Write_Comments</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> comments,
int level)</code>
<div class="block">Writes a PVL comments sequence.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Write(PIRL.PVL.Parameter)">Write</a></strong>(<a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a> parameter)</code>
<div class="block">Writes the Parameter in PVL syntax.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/PVL/Lister.html#Write(PIRL.PVL.Value)">Write</a></strong>(<a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a> value)</code>
<div class="block">Writes the Value in PVL syntax.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#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#toString()" title="class or interface in java.lang">toString</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="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.Lister.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/Lister.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/Lister.html#Verbatim_Strings(boolean)"><code>Verbatim strings</code></a> default.</div>
</li>
</ul>
<a name="Indent_Level_Default">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Indent_Level_Default</h4>
<pre>public static int Indent_Level_Default</pre>
<div class="block">The default <a href="../../PIRL/PVL/Lister.html#Indent_Level(int)"><code>statement base indent level</code></a>
(none if negative).</div>
</li>
</ul>
<a name="Indent_Arrays_Default">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Indent_Arrays_Default</h4>
<pre>public static boolean Indent_Arrays_Default</pre>
<div class="block">The default for applying <a href="../../PIRL/PVL/Lister.html#Indent_Arrays(boolean)"><code>array indenting</code></a>.</div>
</li>
</ul>
<a name="INDENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INDENT</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> INDENT</pre>
<div class="block">The indent character(s).
<P>
This String is written once for each <a href="../../PIRL/PVL/Lister.html#Indent_Level(int)"><code>indent level</code></a>. The default value is the tab character. A
suitable alternative could be four space characters.</div>
</li>
</ul>
<a name="NEW_LINE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NEW_LINE</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> NEW_LINE</pre>
<div class="block">The platform's native line separator (newline) String.
<P>
This String is obtained from System.getProperty ("line.separator"),
or "\n" is used if the System property can't be obtained.</div>
</li>
</ul>
<a name="First_Warning_Default">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>First_Warning_Default</h4>
<pre>public static boolean First_Warning_Default</pre>
<div class="block">The default for returning the <a href="../../PIRL/PVL/Lister.html#First_Warning(boolean)"><code>first
warning</code></a> (or <a href="../../PIRL/PVL/Lister.html#Last_Warning(boolean)"><code>last warning</code></a>).</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Lister(java.io.Writer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Lister</h4>
<pre>public Lister(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer)</pre>
<div class="block">Creates a Lister using a Writer as the destination for PVL statements.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - The Writer destination for characters.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Set_Writer(java.io.Writer)"><code>Set_Writer(Writer)</code></a></dd></dl>
</li>
</ul>
<a name="Lister(java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Lister</h4>
<pre>public Lister(<a href="/usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output_stream)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a></pre>
<div class="block">Creates a Lister using an OutputStream as the destination for PVL
statements.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output_stream</code> - The OutputStream destination for 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_Writer</CODE></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Set_Writer(java.io.OutputStream)"><code>Set_Writer(OutputStream)</code></a></dd></dl>
</li>
</ul>
<a name="Lister(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Lister</h4>
<pre>public Lister(<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 Lister using a File as the destination for PVL
statements.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The File destination for 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_Writer</CODE></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Set_Writer(java.io.File)"><code>Set_Writer(File)</code></a></dd></dl>
</li>
</ul>
<a name="Lister()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Lister</h4>
<pre>public Lister()</pre>
<div class="block">Creates a Lister with the default (System.out) destination for PVL
statements.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="Set_Writer(java.io.Writer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Set_Writer</h4>
<pre>public <a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a> Set_Writer(<a href="/usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> writer)</pre>
<div class="block">Sets the Writer where the Lister will send characters.
<P>
<b>N.B.</b>: The US-ASCII character encoding is used.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - The Writer destination for Lister output. If null,
then a BufferedWriter constructed from an OutputStreamWriter
using System.out is provided.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Lister.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the <a href="../../PIRL/PVL/Parser.html#CHARACTER_ENCODING"><code>Parser.CHARACTER_ENCODING</code></a>
(US-ASCII) is not supported.</dd></dl>
</li>
</ul>
<a name="Get_Writer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Get_Writer</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> Get_Writer()</pre>
<div class="block">Gets the current destination for Lister characters.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current Writer for the Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Set_Writer(java.io.Writer)"><code>Set_Writer(Writer)</code></a></dd></dl>
</li>
</ul>
<a name="Set_Writer(java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Set_Writer</h4>
<pre>public <a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a> Set_Writer(<a href="/usr/share/doc/default-jdk-doc/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output_stream)</pre>
<div class="block">Sets the Writer where the Lister will send characters by
constructing an OutputStreamWriter from the specified OutputStream
and wrapping this in a BufferedWriter for efficiency.
<P>
<b>N.B.</b>: The US-ASCII character encoding is used.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output_stream</code> - The OutputStream destination for Lister
output. If null, System.out is used.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Lister.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the <a href="../../PIRL/PVL/Parser.html#CHARACTER_ENCODING"><code>Parser.CHARACTER_ENCODING</code></a>
(US-ASCII) is not supported.</dd></dl>
</li>
</ul>
<a name="Set_Writer(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Set_Writer</h4>
<pre>public <a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a> Set_Writer(<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">Sets the Writer where the Lister will send characters by constructing
a FileWriter from the specified File and wrapping this in a BufferedWriter
for efficiency.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The File destination for Lister output.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Lister.</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 FILE_IO error condition will occur if the
File refers to a directory or a file for which write permission
is not provided. Any other IOException that occurs while
constructing the FileWriter will also be converted into a
PVL_Exception.FILE_IO exception.</dd></dl>
</li>
</ul>
<a name="Strict(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Strict</h4>
<pre>public <a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a> Strict(boolean strict)</pre>
<div class="block">Enables or disables strict PVL syntax rules in the Lister.
<P>
The default is controlled by the <a href="../../PIRL/PVL/Lister.html#Strict_Default"><code>Strict_Default</code></a> value.
<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 Lister.</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 Lister will enforce strict PVL syntax rules.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the Lister 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/Lister.html" title="class in PIRL.PVL">Lister</a> Verbatim_Strings(boolean verbatim)</pre>
<div class="block">Enable or disable verbatim quoted strings.
<P>
Verbatim strings are listed exactly as they occur.
<P>
With verbatim strings disabled Parameter names, <CODE>STRING</CODE>
Values, and units description strings will have special characters
translated to escape sequences. However, in this case those
sections of these strings that are bracketed by <a href="../../PIRL/PVL/Parser.html#VERBATIM_STRING_DELIMITERS"><code><CODE>VERBATIM_STRING_DELIMITERS</CODE></code></a> will not be translated,
though the <CODE>VERBATIM_STRING_DELIMITERS</CODE> will be removed.
<P>
The default is controlled by the <a href="../../PIRL/PVL/Lister.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 strings are to be written verbatim;
false if special character translation is to be applied.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#translate_to_escape_sequences(PIRL.Strings.String_Buffer)"><code>translate_to_escape_sequences(String_Buffer)</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 verbatim strings mode is enabled.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if verbatim strings mode is enabled; false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Verbatim_Strings(boolean)"><code>Verbatim_Strings(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Indent_Level(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Indent_Level</h4>
<pre>public <a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a> Indent_Level(int level)</pre>
<div class="block">Sets the base indenting level when listing PVL statements.
<P>
The default base level is 0. However, the default is controlled by
the <a href="../../PIRL/PVL/Lister.html#Indent_Level_Default"><code>Indent_Level_Default</code></a> value. Aggregate Parameter
contents and subarrays of array Values are idented an additional
level from their containing statement listing. If the base level is
negative, indenting is disabled.
<P>
The default base level is 0. However, the default is controlled by the
<a href="../../PIRL/PVL/Lister.html#Indent_Level_Default"><code>Indent_Level_Default</code></a> value.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - The base indenting level.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Indent(boolean)"><code>Indent(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.html#Indent_Arrays(boolean)"><code>Indent_Arrays(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Indent_Level()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Indent_Level</h4>
<pre>public int Indent_Level()</pre>
<div class="block">Gets the current base indent level.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current base indent level.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Indent_Level(int)"><code>Indent_Level(int)</code></a></dd></dl>
</li>
</ul>
<a name="Indent(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Indent</h4>
<pre>public <a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a> Indent(boolean indent)</pre>
<div class="block">Enables or disables indenting of PVL statement listings.
<P>
When enabling indenting, if indenting was previously disabled
the default (0) base level is set. However, if indenting was
previously enabled the current level remains unchanged.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indent</code> - true to enable indenting; false to disable it.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Indent_Level(int)"><code>Indent_Level(int)</code></a></dd></dl>
</li>
</ul>
<a name="Indent_Arrays(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Indent_Arrays</h4>
<pre>public <a href="../../PIRL/PVL/Lister.html" title="class in PIRL.PVL">Lister</a> Indent_Arrays(boolean indent)</pre>
<div class="block">Enables or disables indenting of Array Value listings.
<P>
Normally indenting of Array Values is controlled by the indent
level of PVL statement listings; with the listing of the Array, and
each Array Value within the Array, starting on the next line at the
next indent level. If indenting for PVL statements (i.e. Aggregate
Parameters) is disabled, Arrays will be indented from level 0.
However, Array indenting may be disabled even though PVL statement
indenting remains enabled, in which case all Values of an Array
will be written on one line.
<P>
The default is controlled by the <a href="../../PIRL/PVL/Lister.html#Indent_Arrays_Default"><code>Indent_Arrays_Default</code></a> value.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indent</code> - true to enable Array indenting; false to disable
it.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Indent(boolean)"><code>Indent(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.html#Indent_Level(int)"><code>Indent_Level(int)</code></a></dd></dl>
</li>
</ul>
<a name="Indent_Arrays()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Indent_Arrays</h4>
<pre>public boolean Indent_Arrays()</pre>
<div class="block">Tests if Array Values will be indented.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if Arrays Values will be indented; false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Indent_Arrays(boolean)"><code>Indent_Arrays(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/Lister.html#First_Warning(boolean)"><code><CODE>First_Warning</CODE></code></a> or the <a href="../../PIRL/PVL/Lister.html#Last_Warning(boolean)"><code><CODE>Last_Warning</CODE></code></a> since a <a href="../../PIRL/PVL/Lister.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/Lister.html#First_Warning(boolean)"><code>First_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.html#Last_Warning(boolean)"><code>Last_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.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/Lister.html" title="class in PIRL.PVL">Lister</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.
<P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.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/Lister.html" title="class in PIRL.PVL">Lister</a> First_Warning(boolean first)</pre>
<div class="block">Enables or disables returning the first warning that occurs as the
current warning status.
<P>
The first warning is one that occurs when the current warning
status is null. If the use of the first warning is disabled the
last warning that occurred will be returned instead. The default is
to use the first warning. However, the default is controlled by the
<a href="../../PIRL/PVL/Lister.html#First_Warning_Default"><code>First_Warning_Default</code></a> value.
<P>
<B>N.B.</B>: Enabling the return of the first warning is the same
as disabling the <a href="../../PIRL/PVL/Lister.html#Last_Warning(boolean)"><code>return of the last
warning</code></a>.
<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 Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Last_Warning(boolean)"><code>Last_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Lister.html#First_Warning()"><code>First_Warning()</code></a>,
<a href="../../PIRL/PVL/Lister.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/Lister.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Lister.html#First_Warning(boolean)"><code>First_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.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/Lister.html" title="class in PIRL.PVL">Lister</a> Last_Warning(boolean last)</pre>
<div class="block">Enables or disables returning the last warning that occurs as the
current warning status.
<P>
The last warning is the most recent one that ocurred, regardless of
any previous warning conditions that may have occured, without an
intervening <CODE>Reset_Warning</CODE>.
<P>
<B>N.B.</B>: Enabling the return of the last warning is the same
as disabling the <a href="../../PIRL/PVL/Lister.html#First_Warning(boolean)"><code>return of the first
warning</code></a>.
<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 Lister.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#First_Warning(boolean)"><code>First_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Lister.html#Last_Warning()"><code>Last_Warning()</code></a>,
<a href="../../PIRL/PVL/Lister.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/Lister.html#Warning()"><code>Warning()</code></a>,
<a href="../../PIRL/PVL/Lister.html#Last_Warning(boolean)"><code>Last_Warning(boolean)</code></a>,
<a href="../../PIRL/PVL/Lister.html#Reset_Warning()"><code>Reset_Warning()</code></a></dd></dl>
</li>
</ul>
<a name="Write(PIRL.PVL.Parameter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public int Write(<a href="../../PIRL/PVL/Parameter.html" title="class in PIRL.PVL">Parameter</a> parameter)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes the Parameter in PVL syntax.
<P>
The PVL syntax that is written follows this pattern:
<P>
<BLOCKQUOTE><B>
<I>Comments</I><BR>
<I>Name</I> = <I>Value</I>
</B></BLOCKQUOTE>
<P>
The comments string, if there is one, is written by the
<CODE>Write_Comments</CODE> method.
<P>
The Parameter's name is written next beginning on a new line. If
indenting is enabled, the name will be preceeded by the current
indent count number of horizontal tab characters. The name String
itself is usually provided by the Parameter's <CODE>Name</CODE>
method. However, if the Parser's <CODE>Special_Name</CODE> method
determines that the Parameter's classification is associated with a
special name (as it is for all aggregate and <CODE>END</CODE>
Parameters), then that will be written instead. Unless <a href="../../PIRL/PVL/Lister.html#Verbatim_Strings(boolean)"><code><CODE>Verbatim_Strings</CODE></code></a> are enabled,
escape sequences are substituted for special (format control)
characters and <a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>Parser.TEXT_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#SYMBOL_DELIMITER"><code><CODE>Parser.SYMBOL_DELIMITER</CODE></code></a> and backslash ('\')
characters are escaped (with a preceding backslash character). If
the name contains <a href="../../PIRL/PVL/Parser.html#WHITESPACE"><code>whitespace</code></a> or <a href="../../PIRL/PVL/Parser.html#RESERVED_CHARACTERS"><code>reserved</code></a> characters or is empty then it
will be quoted (with <a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>Parser.TEXT_DELIMITER</CODE></code></a> characters). <B>Note</B>: When
<CODE>Strict</CODE> PVL has been specified, Parameter's that begin
an aggregate list will have the special name
<CODE>BEGIN_GROUP</CODE> or <CODE>BEGIN_OBJECT</CODE>, otherwise
the <CODE>BEGIN_</CODE> portion will not be included.
<P>
The Parameter's value is written next, if the Parameter is not a
token or classified as <CODE>UNKNOWN</CODE>. It is preceeded by the
<a href="../../PIRL/PVL/Parser.html#PARAMETER_NAME_DELIMITER"><code>equals</code></a> character surrounded
by space characters. For an assignment, the <CODE>Write
Value)</CODE> method completes the output of a parameter, including
any line termination, and the method returns. If there is no Value,
an empty quoted String is written by default. For aggregates, the
name of the Parameter is its value; i.e. in this case the special
name for the specific classification substitutes for the usual
name, and the usual name appears as the value (yes, this seems
strange, but take it up with the committee that wrote the
specification for the PVL syntax).
<P>
The Parameter line is completed by writing a new-line character.
However, if <CODE>Strict</CODE> PVL has been specified, then the
<a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>Parser.STATEMENT_END_DELIMITER</CODE></code></a> character followed by
the <a href="../../PIRL/PVL/Parser.html#LINE_BREAK"><code><CODE>Parser.LINE_BREAK</CODE></code></a>
sequence is written instead.
<P>
When the Parameter being written is an aggregate, the indent level
(if indenting is enabled) is incremented and then each Parameter in
the aggregate list is recursively written. At the end of the list
the indent level is decremented (if indenting is enabled) and an
<CODE>END_GROUP</CODE> or <CODE>END_OBJECT</CODE> Parameter,
corresponding to the classification of the aggregate containing the
list, is written. If an <CODE>END</CODE> Parameter is encountered
in the aggregate list, then the list is terminated at that point.
If an <CODE>END_PVL</CODE> Parameter is encountered, then the
current list is terminated as well as the lists of all containing
aggregates; i.e. all Parameter lists end at that point.
<P>
As a special case, when the Parameter being written is an aggregate
with the name <a href="../../PIRL/PVL/Parser.html#CONTAINER_NAME"><code><CODE>Parser.CONTAINER_NAME</CODE></code></a> this "container" Parameter is
not written, but the Parameters in it's aggregate list are written
normally. This special case only applies to the first Parameter
inspected by the <CODE>Write (Parameter)</CODE> method, not
aggregate list entries; i.e. only the top of the hierarchy is
considered as a potential special case.
<P>
Normally the special <CODE>END_PVL</CODE> Parameter is not written
at the end of the listing. This is so that several Parameters can
be written to a file before the application provides the
<CODE>END_PVL</CODE> Parameter formally expected at the end of a
PVL sequence. However, when the Parameter being written is the top
of the output hierarchy and has the special
<CODE>Parser.CONTAINER_NAME</CODE>, then the <CODE>END_PVL</CODE>
Parameter is automatically provided to reflect the end of the
container's parameters; i.e. what is written should be logically
the equivalent to what was read by the Parser.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - The Parameter to write.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The total number of bytes written.</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>If an element in an aggregate list is not a Parameter.
</DL></dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - From the Writer's <CODE>write</CODE> method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Write_Comments(java.lang.String, int)"><code>Write_Comments(String, int)</code></a>,
<a href="../../PIRL/PVL/Parameter.html#Name()"><code>Parameter.Name()</code></a>,
<a href="../../PIRL/PVL/Parser.html#Special_Name(int)"><code>Parser.Special_Name(int)</code></a>,
<a href="../../PIRL/PVL/Lister.html#translate_to_escape_sequences(PIRL.Strings.String_Buffer)"><code>translate_to_escape_sequences(String_Buffer)</code></a>,
<a href="../../PIRL/PVL/Lister.html#Write(PIRL.PVL.Value)"><code>Write(Value)</code></a></dd></dl>
</li>
</ul>
<a name="Write_Comments(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write_Comments</h4>
<pre>public int Write_Comments(<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> comments,
int level)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes a PVL comments sequence.
<P>
Normally comments are attached to a Parameter with the
<CODE>Comments</CODE> method and they are written as part of the
Parameter. Comments may be inserted virtually anywhere in a PVL
listing, and this method is provided for such ad hoc commenting.
<P>
Comments are delimited by <a href="../../PIRL/PVL/Parser.html#COMMENT_START_DELIMITERS"><code>Parser.COMMENT_START_DELIMITERS</code></a> and <a href="../../PIRL/PVL/Parser.html#COMMENT_END_DELIMITERS"><code>Parser.COMMENT_END_DELIMITERS</code></a>
(C-style) sequences. When <CODE>Strict</CODE> PVL syntax is
specified each line of the comments String (a line being delmited
by a new-line character) is separated into individual single line
comments. Otherwise the comments String is simply output between
the start and end sequences as-is.
<P>
If indenting is enabled each comment start sequence will be
preceeded by the current indent count number of horizontal tab
characters. Unless <CODE>Strict</CODE> syntax has been specified,
the comment end sequence is preceeded by a new-line character and
any indenting. If indenting is enabled the end of the comments
sequence is completed by writing a new-line character, or the
<a href="../../PIRL/PVL/Parser.html#LINE_BREAK"><code><CODE>Parser.LINE_BREAK</CODE></code></a> sequence
for <CODE>Strict</CODE> PVL.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comments</code> - The String to be written in a comments sequence.
If comments is null, nothing is written.</dd><dd><code>level</code> - The indent level to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The total number of bytes written.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - From the OutputStream <CODE>write</CODE> method.</dd></dl>
</li>
</ul>
<a name="Write_Comments(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write_Comments</h4>
<pre>public int Write_Comments(<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> comments)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes a PVL comments sequence at the current indent level.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comments</code> - The String to be written in a comments sequence.
If comments is null, nothing is written.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The total number of bytes written.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - From the Writer's <CODE>write</CODE> method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#Write_Comments(java.lang.String, int)"><code>Write_Comments(String, int)</code></a></dd></dl>
</li>
</ul>
<a name="Write(PIRL.PVL.Value)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Write</h4>
<pre>public int Write(<a href="../../PIRL/PVL/Value.html" title="class in PIRL.PVL">Value</a> value)
throws <a href="../../PIRL/PVL/PVL_Exception.html" title="class in PIRL.PVL">PVL_Exception</a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes the Value in PVL syntax.
<P>
The PVL syntax that is written follows this pattern:
<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 Value datum is always written. If the Value is the
<CODE>UNKNOWN</CODE> type then an empty <CODE>SYMBOL</CODE> type is
provided by default. If the datum is a <CODE>STRING</CODE> type and
<a href="../../PIRL/PVL/Lister.html#Verbatim_Strings(boolean)"><code><CODE>Verbatim_Strings</CODE></code></a> are
disabled, escape sequences are substituted for special (format
control) characters and <a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>Parser.TEXT_DELIMITER</CODE></code></a>, <a href="../../PIRL/PVL/Parser.html#SYMBOL_DELIMITER"><code><CODE>Parser.SYMBOL_DELIMITER</CODE></code></a> and backslash ('\')
characters are escaped (with a preceding backslash character). If
the string contains <a href="../../PIRL/PVL/Parser.html#WHITESPACE"><code>whitespace</code></a> or <a href="../../PIRL/PVL/Parser.html#RESERVED_CHARACTERS"><code>reserved</code></a> characters or is empty then it
will be quoted (with <a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>Parser.TEXT_DELIMITER</CODE></code></a> characters).
<P>
If the Value is an <CODE>ARRAY</CODE> type then the appropriate
enclosure start character (<a href="../../PIRL/PVL/Parser.html#SET_START_DELIMITER"><code><CODE>Parser.SET_START_DELIMITER</CODE></code></a> or <a href="../../PIRL/PVL/Parser.html#SEQUENCE_START_DELIMITER"><code><CODE>Parser.SEQUENCE_START_DELIMITER</CODE></code></a>) is written before
each Value in the array Vector is recursively written by this
method with a space and <a href="../../PIRL/PVL/Parser.html#PARAMETER_VALUE_DELIMITER"><code><CODE>Parser.PARAMETER_VALUE_DELIMITER</CODE></code></a> separation. After
all the array Vector Values have been written the appropriate
enclosure end character (<a href="../../PIRL/PVL/Parser.html#SET_END_DELIMITER"><code><CODE>Parser.SET_END_DELIMITER</CODE></code></a> or <a href="../../PIRL/PVL/Parser.html#SEQUENCE_END_DELIMITER"><code><CODE>Parser.SEQUENCE_END_DELIMITER</CODE></code></a>) is written.
<P>
After each Value is written, whether a single datum or an array, it
is followed by any units description String (preceeded by a space
character and enclosed in PVL syntax characters (<a href="../../PIRL/PVL/Parser.html#UNITS_START_DELIMITER"><code><CODE>Parser.UNITS_START_DELIMITER</CODE></code></a> and <a href="../../PIRL/PVL/Parser.html#UNITS_END_DELIMITER"><code><CODE>Parser.UNITS_END_DELIMITER</CODE></code></a>).
<P>
Array indenting may be enabled. In this mode each nested array is
written on separate lines indented by tab characters to its nesting
level. Each subarray starts a new line and increments the nesting
level. The end of a subarray is followed by a new-line and the
nesting level is decremented before continuing a previous array
level (but not if there is no previous array level or the previous
level has no more Values). The start of an array at level 0 is not
given indent treatment.
<P>
In <CODE>Strict</CODE> mode new-line sequences are the <a href="../../PIRL/PVL/Parser.html#LINE_BREAK"><code><CODE>Parser.LINE_BREAK</CODE></code></a> characters;
normally the native new-line (the line.separator System property)
is used. Also, <CODE>Strict</CODE> mode results in the <a href="../../PIRL/PVL/Parser.html#STATEMENT_END_DELIMITER"><code><CODE>Parser.STATEMENT_END_DELIMITER</CODE></code></a> character preceeding
the usual new-line that completes the Value output.
<P>
If an unenclosed <CODE>STRING</CODE> type datum contains any of the
<a href="../../PIRL/PVL/Parser.html#RESERVED_CHARACTERS"><code><CODE>Parser.RESERVED_CHARACTERS</CODE></code></a> then a warning status is
set (and thrown in <CODE>Strict</CODE> mode). These characters have
special meaning in the PVL syntax so writing values containing them
could confuse a PVL parser that reads them. Unless strict mode is
in effect, the string is enclosed in <a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>Parser.TEXT_DELIMITER</CODE></code></a> characters to protect them from
inappropriate interpretation.
<P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The Value to write.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The total number of bytes written.</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>If an element in an array is not a Value.
<DT><CODE>ILLEGAL_SYNTAX</CODE>
<DD>If a PVL reserved character was found in an unenclosed
<CODE>STRING</CODE> datum during <CODE>Strict</CODE> writing.
</DL></dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - From the OutputStream <CODE>write</CODE> method.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/PVL/Lister.html#translate_to_escape_sequences(PIRL.Strings.String_Buffer)"><code>translate_to_escape_sequences(String_Buffer)</code></a></dd></dl>
</li>
</ul>
<a name="translate_to_escape_sequences(PIRL.Strings.String_Buffer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>translate_to_escape_sequences</h4>
<pre>public static <a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a> translate_to_escape_sequences(<a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings">String_Buffer</a> string)</pre>
<div class="block">Translates special characters in a String_Buffer to their
corresponding escape sequences.
<P>
In addition to the special characters translated by the <a href="../../PIRL/Strings/String_Buffer.html#special_to_escape()"><code><CODE>special_to_escape</CODE></code></a>
method, the <a href="../../PIRL/PVL/Parser.html#TEXT_DELIMITER"><code><CODE>TEXT_DELIMITER</CODE></code></a> and <a href="../../PIRL/PVL/Parser.html#SYMBOL_DELIMITER"><code><CODE>SYMBOL_DELIMITER</CODE></code></a> characters are also escaped. 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
and including the next <CODE>VERBATIM_STRING_DELIMITERS</CODE> or
the end of the string.
<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#special_to_escape()"><code>String_Buffer.special_to_escape()</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/Invalid_Map_Syntax.html" title="class in PIRL.PVL"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/PVL/Parameter.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/Lister.html" target="_top">Frames</a></li>
<li><a href="Lister.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>
|