/usr/share/doc/libpirl-java/api/PIRL/Strings/Words.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 | <!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:35 UTC 2012 -->
<title>Words</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="Words";
}
//-->
</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/Strings/strip_DEBUG.html" title="class in PIRL.Strings"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Strings/Words.html" target="_top">Frames</a></li>
<li><a href="Words.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">PIRL.Strings</div>
<h2 title="Class Words" class="title">Class Words</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.Strings.Words</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Words</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">The <I>Words</I> class provides a mechanism to treat a String as a
sequence of delimited words.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/String_Buffer.html" title="class in PIRL.Strings"><code>String_Buffer</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings">Words.Word_Index</a></strong></code>
<div class="block">A <i>Word_Index</i> provides a start,end string location for a word.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="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 <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/Strings/Words.html#DEFAULT_DELIMITERS">DEFAULT_DELIMITERS</a></strong></code>
<div class="block">The default word delimiters;</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/Strings/Words.html#DEFAULT_MASK">DEFAULT_MASK</a></strong></code>
<div class="block">The default word <a href="../../PIRL/Strings/Words.html#Mask(java.lang.String)"><code>mask</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#DELIMIT_AT_QUOTE">DELIMIT_AT_QUOTE</a></strong></code>
<div class="block">Whether or not to delimit words at quotes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#End_Index">End_Index</a></strong></code>
<div class="block">The index (exclusive) in the current string where the current word ends.</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/Strings/Words.html#ID">ID</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings">Words.Word_Index</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Mark_Index">Mark_Index</a></strong></code>
<div class="block">The Word_Index the last <a href="../../PIRL/Strings/Words.html#Mark()"><code>marked</code></a> word.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#PARENTHESIZED_WORDS">PARENTHESIZED_WORDS</a></strong></code>
<div class="block">Whether or not to treat parenthesized strings as a word.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#QUOTED_WORDS">QUOTED_WORDS</a></strong></code>
<div class="block">Whether or not to treat quoted strings as a word.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Start_Index">Start_Index</a></strong></code>
<div class="block">The index in the current string where the next word starts.</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/Strings/Words.html#Words()">Words</a></strong>()</code>
<div class="block">Constructs Words with no characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../PIRL/Strings/Words.html#Words(java.lang.String)">Words</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> characters)</code>
<div class="block">Constructs Words from a String of characters.</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/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Characters(java.lang.String)">Characters</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> characters)</code>
<div class="block">Sets the String of characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Delimit_at_Quote()">Delimit_at_Quote</a></strong>()</code>
<div class="block">Test if quotes will delimit words.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Delimit_at_Quote(boolean)">Delimit_at_Quote</a></strong>(boolean enable)</code>
<div class="block">Enable or disable delimiting words at quotes.</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/Strings/Words.html#Delimiters()">Delimiters</a></strong>()</code>
<div class="block">Gets the current delimiters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Delimiters(java.lang.String)">Delimiters</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> delimiters)</code>
<div class="block">Sets the word delimiter characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Location(int)">Location</a></strong>(int location)</code>
<div class="block">Moves the word indices to a new location.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Mark()">Mark</a></strong>()</code>
<div class="block">Marks the current word location.</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/Strings/Words.html#Mask()">Mask</a></strong>()</code>
<div class="block">Gets the word mask.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Mask(java.lang.String)">Mask</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> mask)</code>
<div class="block">Sets the mask to use when words are masked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Mask(java.util.Vector)">Mask</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<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>> names)</code>
<div class="block">Words preceeded by any one of a set of names are masked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings">Words.Word_Index</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Next_Location()">Next_Location</a></strong>()</code>
<div class="block">Moves the word indices to the location of the next word.</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/Strings/Words.html#Next_Word()">Next_Word</a></strong>()</code>
<div class="block">Gets the next word.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Parenthesized_Words()">Parenthesized_Words</a></strong>()</code>
<div class="block">Test if parenthesized strings are treated as single words.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Parenthesized_Words(boolean)">Parenthesized_Words</a></strong>(boolean enable)</code>
<div class="block">Enable or disable the treatment of parenthesized strings as words.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Quoted_Words()">Quoted_Words</a></strong>()</code>
<div class="block">Test if quoted strings are treated as single words.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Quoted_Words(boolean)">Quoted_Words</a></strong>(boolean enable)</code>
<div class="block">Enable or disable the treatment of quoted strings as words.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a></code></td>
<td class="colLast"><code><strong><a href="../../PIRL/Strings/Words.html#Restore()">Restore</a></strong>()</code>
<div class="block">Restores the current word to the last marked location.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<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/Strings/Words.html#Split()">Split</a></strong>()</code>
<div class="block">Splits the remaining characters into words.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<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/Strings/Words.html#Split(int)">Split</a></strong>(int limit)</code>
<div class="block">Splits the remaining characters into words.</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/Strings/Words.html#Substring(int)">Substring</a></strong>(int start)</code>
<div class="block">Gets a substring of the characters.</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/Strings/Words.html#Substring(int, int)">Substring</a></strong>(int start,
int end)</code>
<div class="block">Gets a substring of the characters.</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/Strings/Words.html#Substring(PIRL.Strings.Words.Word_Index)">Substring</a></strong>(<a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings">Words.Word_Index</a> word_index)</code>
<div class="block">Gets a substring of the characters.</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/Strings/Words.html#toString()">toString</a></strong>()</code>
<div class="block">Gets the Words characters.</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#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>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Strings.Words.ID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="Start_Index">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Start_Index</h4>
<pre>public int Start_Index</pre>
<div class="block">The index in the current string where the next word starts.
<p>
Initially, this is the beginning (0) of the words string. This will be
-1 when there are no more words.</div>
</li>
</ul>
<a name="End_Index">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>End_Index</h4>
<pre>public int End_Index</pre>
<div class="block">The index (exclusive) in the current string where the current word ends.
<p>
This will be zero if no <a href="../../PIRL/Strings/Words.html#Next_Word()"><code>Next_Word</code></a> has been
selected. This will be -1 when there are no more words.</div>
</li>
</ul>
<a name="Mark_Index">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Mark_Index</h4>
<pre>public <a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings">Words.Word_Index</a> Mark_Index</pre>
<div class="block">The Word_Index the last <a href="../../PIRL/Strings/Words.html#Mark()"><code>marked</code></a> word.</div>
</li>
</ul>
<a name="DEFAULT_DELIMITERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_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> DEFAULT_DELIMITERS</pre>
<div class="block">The default word delimiters;
<p>
The usual whitespace characters: " \n\r\t".</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Strings.Words.DEFAULT_DELIMITERS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DEFAULT_MASK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MASK</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> DEFAULT_MASK</pre>
<div class="block">The default word <a href="../../PIRL/Strings/Words.html#Mask(java.lang.String)"><code>mask</code></a>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#PIRL.Strings.Words.DEFAULT_MASK">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="QUOTED_WORDS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>QUOTED_WORDS</h4>
<pre>public static boolean QUOTED_WORDS</pre>
<div class="block">Whether or not to treat quoted strings as a word.</div>
</li>
</ul>
<a name="DELIMIT_AT_QUOTE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELIMIT_AT_QUOTE</h4>
<pre>public static boolean DELIMIT_AT_QUOTE</pre>
<div class="block">Whether or not to delimit words at quotes.</div>
</li>
</ul>
<a name="PARENTHESIZED_WORDS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PARENTHESIZED_WORDS</h4>
<pre>public static boolean PARENTHESIZED_WORDS</pre>
<div class="block">Whether or not to treat parenthesized strings as a word.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Words(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Words</h4>
<pre>public Words(<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> characters)</pre>
<div class="block">Constructs Words from a String of characters.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>characters</code> - The String of characters containing words.</dd></dl>
</li>
</ul>
<a name="Words()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Words</h4>
<pre>public Words()</pre>
<div class="block">Constructs Words with no characters.
<p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Characters(java.lang.String)"><code>Characters(String)</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</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> toString()</pre>
<div class="block">Gets the Words characters.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><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></code> in class <code><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></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The current String of characters.</dd></dl>
</li>
</ul>
<a name="Characters(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Characters</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Characters(<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> characters)</pre>
<div class="block">Sets the String of characters.
<p>
The current location is reset to the beginning of the string.
The <a href="../../PIRL/Strings/Words.html#Mark_Index"><code>Mark_Index</code></a> is reset to (0,0).
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>characters</code> - The String of characters.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Location(int)"><code>Location(int)</code></a></dd></dl>
</li>
</ul>
<a name="Delimiters(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Delimiters</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Delimiters(<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> delimiters)</pre>
<div class="block">Sets the word delimiter characters.
<p>
A word is delimited by a contiguous sequence of characters that are
all members of the delimiters characters. Note that a sequence of
more than one the same or different characters from the delimiters
set does not result in empty words; i.e. any continguous sequence of
one or more delimiters is treated as a single word delimiter.
<p>
<b>N.B.</b>: Any character starting a special sequence should not
be included as one of the delimiter characters. If they are then
special sequence recognition will be effectively disabled.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>delimiters</code> - The String of delimiter characters. If null,
the <a href="../../PIRL/Strings/Words.html#DEFAULT_DELIMITERS"><code>DEFAULT_DELIMITERS</code></a> will be used.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Quoted_Words(boolean)"><code>Quoted_Words(boolean)</code></a>,
<a href="../../PIRL/Strings/Words.html#Parenthesized_Words(boolean)"><code>Parenthesized_Words(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Delimiters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Delimiters</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> Delimiters()</pre>
<div class="block">Gets the current delimiters.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The String of delimiter characters.</dd></dl>
</li>
</ul>
<a name="Quoted_Words(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Quoted_Words</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Quoted_Words(boolean enable)</pre>
<div class="block">Enable or disable the treatment of quoted strings as words.
<p>
The enclosing quote characters are included in the word. If there is
no matching unescaped quote character before the end of the string,
the resulting word will not have the matching closing quote character
at <a href="../../PIRL/Strings/Words.html#End_Index"><code>End_Index</code></a> - 1.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enable</code> - true if all characters within unescaped quotes
(' or ") are to be treated as a single word; false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Delimit_at_Quote(boolean)"><code>Delimit_at_Quote(boolean)</code></a>,
<a href="../../PIRL/Strings/Words.html#Next_Location()"><code>Next_Location()</code></a></dd></dl>
</li>
</ul>
<a name="Quoted_Words()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Quoted_Words</h4>
<pre>public boolean Quoted_Words()</pre>
<div class="block">Test if quoted strings are treated as single words.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if all characters within unescaped quotes (' or ") will
be treated as a single word; false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Quoted_Words(boolean)"><code>Quoted_Words(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Delimit_at_Quote(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Delimit_at_Quote</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Delimit_at_Quote(boolean enable)</pre>
<div class="block">Enable or disable delimiting words at quotes.
<p>
When unescaped quote characters are encountered they may delimit a
word even if no <a href="../../PIRL/Strings/Words.html#Delimiters(java.lang.String)"><code>delimiter character</code></a>
preceeds or follows the quote. Disabling quote delimiting causes
contiguous non-delimiter characters to be included as part of the
quoted string word. The quotes remain in the word in either case.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enable</code> - true if unescaped quote characters delimit a word;
false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Quoted_Words(boolean)"><code>Quoted_Words(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Delimit_at_Quote()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Delimit_at_Quote</h4>
<pre>public boolean Delimit_at_Quote()</pre>
<div class="block">Test if quotes will delimit words.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if unescaped quote characters delimit a word;
false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Delimit_at_Quote(boolean)"><code>Delimit_at_Quote(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Parenthesized_Words(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parenthesized_Words</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Parenthesized_Words(boolean enable)</pre>
<div class="block">Enable or disable the treatment of parenthesized strings as words.
<p>
<b>N.B.</b>: Nested parenthesized strings are included in a
parenthesized string.
<p>
The enclosing parentheses characters are included in the word. If
there is no matching unescaped closing parenthesis character
(ignoring nested parentheses) before the end of the string, the
resulting word will not have one at <a href="../../PIRL/Strings/Words.html#End_Index"><code>End_Index</code></a> - 1.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enable</code> - true if all characters within unescaped parenthesized
('(' and ')') strings are to be treated as a single word; false
otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Next_Location()"><code>Next_Location()</code></a></dd></dl>
</li>
</ul>
<a name="Parenthesized_Words()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Parenthesized_Words</h4>
<pre>public boolean Parenthesized_Words()</pre>
<div class="block">Test if parenthesized strings are treated as single words.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if all characters within unescaped parenthesized strings
will be treated as a single word; false otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Parenthesized_Words(boolean)"><code>Parenthesized_Words(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="Substring(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Substring</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> Substring(int start,
int end)</pre>
<div class="block">Gets a substring of the characters.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - The start index of the substring.</dd><dd><code>end</code> - The end index of the substring.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The substring from the start index up to, but not including,
the end index.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringBuffer.html?is-external=true#substring(int, int)" title="class or interface in java.lang"><code>StringBuffer.substring(int, int)</code></a></dd></dl>
</li>
</ul>
<a name="Substring(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Substring</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> Substring(int start)</pre>
<div class="block">Gets a substring of the characters.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - The start index of the substring.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The substring from the start index to the end of the
characters string.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringBuffer.html?is-external=true#substring(int)" title="class or interface in java.lang"><code>StringBuffer.substring(int)</code></a></dd></dl>
</li>
</ul>
<a name="Substring(PIRL.Strings.Words.Word_Index)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Substring</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> Substring(<a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings">Words.Word_Index</a> word_index)</pre>
<div class="block">Gets a substring of the characters.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>word_index</code> - A Word_Index for the substring.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The substring from the word_index.Start_Index up to, but not
including, the word_index.End_Index.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringBuffer.html?is-external=true#substring(int, int)" title="class or interface in java.lang"><code>StringBuffer.substring(int, int)</code></a></dd></dl>
</li>
</ul>
<a name="Location(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Location</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Location(int location)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></pre>
<div class="block">Moves the word indices to a new location.
<p>
The location must be within the words string.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - An index in the words string.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - If the location is not
within the words string.</dd></dl>
</li>
</ul>
<a name="Mark()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Mark</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Mark()</pre>
<div class="block">Marks the current word location.
<p>
The current <a href="../../PIRL/Strings/Words.html#Start_Index"><code>Start_Index</code></a> and <a href="../../PIRL/Strings/Words.html#End_Index"><code>End_Index</code></a> are stored
in the <a href="../../PIRL/Strings/Words.html#Mark_Index"><code>Mark_Index</code></a>.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Restore()"><code>Restore()</code></a></dd></dl>
</li>
</ul>
<a name="Restore()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Restore</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Restore()</pre>
<div class="block">Restores the current word to the last marked location.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">StringIndexOutOfBoundsException</a></code> - If the Word_Index.Start_Index
is less than zero or the Word_Index.End_Index is greater than the
number of characters available.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Mark()"><code>Mark()</code></a></dd></dl>
</li>
</ul>
<a name="Next_Location()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Next_Location</h4>
<pre>public <a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings">Words.Word_Index</a> Next_Location()</pre>
<div class="block">Moves the word indices to the location of the next word.
<p>
Beginning at the current <a href="../../PIRL/Strings/Words.html#End_Index"><code>End_Index</code></a> all <a href="../../PIRL/Strings/Words.html#Delimiters(java.lang.String)"><code>delimiter characters</code></a> are skipped to find the new
<a href="../../PIRL/Strings/Words.html#Start_Index"><code>Start_Index</code></a>. If the end of the characters string is reached
without finding a non-delimiter character then there are no more
words available. In this case both the Start_Index and End_Index will
be equal to the character string length and nothing more will be
done.
<p>
<b>N.B.</b>: Any character starting a special sequence should not
be included as one of the delimiter characters. If they are then
special sequence recognition will be effectively disabled.
<p>
The character at the Start_Index is checked to see if it starts a
special sequence. If <a href="../../PIRL/Strings/Words.html#Quoted_Words(boolean)"><code>quoted words</code></a> is
enabled either a single (') or double (") quote character will be
recognized and set as the end of sequence marker character. If <a href="../../PIRL/Strings/Words.html#Parenthesized_Words(boolean)"><code>parenthesized words</code></a> is enabled an
opening parenthesis ('(') character will be recognized and the end of
sequence marker character will be set to the closing parenthesis
(')') character. A special sequence start character is included as
part of the word.
<p>
When <a href="../../PIRL/Strings/Words.html#Delimit_at_Quote(boolean)"><code>delimit at quote</code></a> is enabled
in addition to quoted words being enabled quoted strings are
delimited as separate words even if a contiguous non-delimiter
character preceeds and/or follows the enclosing quotes. When delimit
at quote is disabled the contiguous non-delimiter characters are
treated as part of the word that includes the quoted string.
<p>
The word contains all characters up to and including an unescaped end
of sequence marker character. For a parenthesized sequence the marker
character must be at parenthesis level zero to end the sequence;
unescaped nested parentheses increase the parenthesis level. Note
that a special sequence may include what would otherwise be
considered delimiter characters, and the enclosing characters -
quotes or parentheses - are included as part of the word. If the end
of the characters string is reached before the expected marker
character is found the resulting word will be "unbalanced"; the
character at End_Index - 1 will not be the marker character.
<p>
If no end of sequence marker character has been set, then the word
will end when any unescaped delimiter character is found or the end
of the characters string is reached. If quoted words are enabled a
quote character will be recognized as a delimiter character. If
parenthesized words are enabled an opening parenthesis character will
be recognized as a delimiter character. The index of the delimiter
character becomes the new End_Index; it is not included as part of
the word.
<p>
Any character preceded by a backslash ('\') character is escaped from
any special treatment. All escaped characters are taken to be part of
the word, the backslash character included.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A Word_Index for the next word. If there are no more words
the word index will be set to the end of the characters.</dd></dl>
</li>
</ul>
<a name="Next_Word()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Next_Word</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> Next_Word()</pre>
<div class="block">Gets the next word.
<p>
The Start_Index will be moved forward from the current End_Index
over any Delimiters. Then the End_Index will be moved forward from
the Start_Index until any Delimiters are found or the end of the
string is reached.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The substring from the next Start_Index up to, but not including,
the next End_Index. If there are no more words, the empty String
will be returned.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Next_Location()"><code>Next_Location()</code></a></dd></dl>
</li>
</ul>
<a name="Split(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Split</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<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>> Split(int limit)</pre>
<div class="block">Splits the remaining characters into words.
<p>
Beginning with the <a href="../../PIRL/Strings/Words.html#Next_Word()"><code>next word</code></a>, words are
collected into a Vector in the order they occur in the string.
<p>
If the limit is 0 all available words will be returned; no delimiters
will be included in any word that is returned. If the limit is
positive (> 0) no more than limit words will be returned; the last
"word" will contain all characters, including any delimiters,
following the start of the last word (delimiters preceeding the last
word will not be included). A negative limit acts the same as a
positive limit except the last "word" will contain all characters
following the end of the previous word (delimiters preceeding the
last word will be included). Note that a limit of -1 will return all
characters from the current End_Index to the end of the the
characters string.
<p>
Less than limit words my be returned. No empty words will be
returned.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - The word limit to return.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A Vector of zero or more words.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Next_Location()"><code>Next_Location()</code></a></dd></dl>
</li>
</ul>
<a name="Split()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Split</h4>
<pre>public <a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<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>> Split()</pre>
<div class="block">Splits the remaining characters into words.
<p>
Beginning with the <a href="../../PIRL/Strings/Words.html#Next_Word()"><code>next word</code></a>, words are
collected into a Vector in the order they occur in the string.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A Vector of zero or more words.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Split(int)"><code>Split(int)</code></a></dd></dl>
</li>
</ul>
<a name="Mask(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Mask</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Mask(<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> mask)</pre>
<div class="block">Sets the mask to use when words are masked.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mask</code> - The mask String. This may be null.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Mask(java.util.Vector)"><code>Mask(Vector)</code></a></dd></dl>
</li>
</ul>
<a name="Mask()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Mask</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> Mask()</pre>
<div class="block">Gets the word mask.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The String to me used when masking words.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Mask(java.util.Vector)"><code>Mask(Vector)</code></a></dd></dl>
</li>
</ul>
<a name="Mask(java.util.Vector)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Mask</h4>
<pre>public <a href="../../PIRL/Strings/Words.html" title="class in PIRL.Strings">Words</a> Mask(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<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>> names)</pre>
<div class="block">Words preceeded by any one of a set of names are masked.
<p>
The words are searched for matches with the names. When a match is
found, the following word is replaced with the mask String. If the
mask String is null the preceeding name as well its word is
deleted.
<p>
<B>N.B.</B>: The mask string may be one of the names. The mask
substitution is never compared against the names list.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>names</code> - A Vector of names to find.</dd>
<dt><span class="strong">Returns:</span></dt><dd>This Words object.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../PIRL/Strings/Words.html#Mask(java.lang.String)"><code>Mask(String)</code></a>,
<a href="../../PIRL/Strings/Words.html#Next_Word()"><code>Next_Word()</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/Strings/strip_DEBUG.html" title="class in PIRL.Strings"><span class="strong">Prev Class</span></a></li>
<li><a href="../../PIRL/Strings/Words.Word_Index.html" title="class in PIRL.Strings"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?PIRL/Strings/Words.html" target="_top">Frames</a></li>
<li><a href="Words.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|