/usr/share/doc/libexcalibur-logkit-java/api/org/apache/log/format/PatternFormatter.html is in libexcalibur-logkit-java-doc 2.0-11.
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 | <!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_65) on Wed Oct 22 09:04:12 UTC 2014 -->
<title>PatternFormatter</title>
<meta name="date" content="2014-10-22">
<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="PatternFormatter";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PatternFormatter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log/format/Formatter.html" title="interface in org.apache.log.format"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/log/format/PatternFormatter.PatternRun.html" title="class in org.apache.log.format"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log/format/PatternFormatter.html" target="_top">Frames</a></li>
<li><a href="PatternFormatter.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">org.apache.log.format</div>
<h2 title="Class PatternFormatter" class="title">Class PatternFormatter</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>org.apache.log.format.PatternFormatter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/log/format/Formatter.html" title="interface in org.apache.log.format">Formatter</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/log/format/ExtendedPatternFormatter.html" title="class in org.apache.log.format">ExtendedPatternFormatter</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">PatternFormatter</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>
implements <a href="../../../../org/apache/log/format/Formatter.html" title="interface in org.apache.log.format">Formatter</a></pre>
<div class="block">This formater formats the LogEvents according to a input pattern
string.
<p>
The format of each pattern element can be
<code>%[+|-][#[.#]]{field:subformat}</code>.
</p>
<ul>
<li><p>The <code>+|-</code> indicates left or right justify.
</p></li>
<li><p>The <code>#.#</code> indicates the minimum and maximum
size of output. You may omit the values and the field will be
formatted without size restriction.<br />
You may specify <code>#</code>, or <code>#.</code> to only
define the minimum size.<br />
You may specify <code>.#</code> to only define the maximum
size.
</p></li>
<li><p><code>field</code> indicates which field is to be output and must be
one of properties of LogEvent. The following fields are
currently supported:
<table border="0" cellpadding="4" cellspacing="0">
<tr>
<td><b>category</b></td>
<td>Category value of the logging event.</td>
</tr><tr>
<td><b>context</b></td>
<td>Context value of the logging event.</td>
</tr><tr>
<td><b>message</b></td>
<td>Message value of the logging event.</td>
</tr><tr>
<td><b>time</b></td>
<td>Time value of the logging event.</td>
</tr><tr>
<td><b>rtime</b></td>
<td>Relative time value of the logging event.</td>
</tr><tr>
<td><b>throwable</b></td>
<td>Throwable value of the logging event.</td>
</tr><tr>
<td><b>priority</b></td>
<td>Priority value of the logging event.</td>
</tr><tr>
<td><b>thread</b></td>
<td>Name of the thread which logged the event.</td>
</tr>
</table>
</p></li>
<li><p><code>subformat</code> indicates a particular subformat to
use on the specified field, and is currently only supported by:
<table border="0" cellpadding="4" cellspacing="0">
<tr>
<td><b>context</b></td>
<td>Specifies the context map parameter name.</td>
</tr><tr>
<td><b>time</b></td>
<td>Specifies the pattern to be pass to
<a href="/usr/share/doc/default-jdk-doc/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code>SimpleDateFormat</code></a> to format the time.</td>
</tr>
</table>
</p></li>
</ul>
<p>A simple example of a typical PatternFormatter format would be:
<pre><code>
%{time} %5.5{priority}[%-10.10{category}]: %{message}
</code></pre>
</p><p>
This would produce a line like:
<pre><code>
1000928827905 DEBUG [ junit]: Sample message
</code></pre>
</p><p>
The format string specifies that the logger should first print the
time value of the log event without size restriction, then the
priority of the log event with a minimum and maximum size of 5,
then the category of the log event right justified with a minimum
and maximum size of 10, followed by the message of the log event
without any size restriction.
</p></div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>CVS $Revision: 1.42 $ $Date: 2004/02/28 11:31:24 $</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>, Peter Donald, <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>, <a href="mailto:leif@tanukisoftware.com">Leif Mortenson</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>protected static class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.PatternRun.html" title="class in org.apache.log.format">PatternFormatter.PatternRun</a></strong></code> </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>private 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="../../../../org/apache/log/format/PatternFormatter.html#EOL">EOL</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="/usr/share/doc/default-jdk-doc/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#m_date">m_date</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../org/apache/log/format/PatternFormatter.PatternRun.html" title="class in org.apache.log.format">PatternFormatter.PatternRun</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#m_formatSpecification">m_formatSpecification</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="/usr/share/doc/default-jdk-doc/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#m_simpleDateFormat">m_simpleDateFormat</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#MAX_TYPE">MAX_TYPE</a></strong></code>
<div class="block">The maximum value used for TYPEs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#SPACE_1">SPACE_1</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#SPACE_16">SPACE_16</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#SPACE_2">SPACE_2</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#SPACE_4">SPACE_4</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#SPACE_8">SPACE_8</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_CATEGORY">TYPE_CATEGORY</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_CATEGORY_STR">TYPE_CATEGORY_STR</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_CONTEXT">TYPE_CONTEXT</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_CONTEXT_STR">TYPE_CONTEXT_STR</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_MESSAGE">TYPE_MESSAGE</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_MESSAGE_STR">TYPE_MESSAGE_STR</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_PRIORITY">TYPE_PRIORITY</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_PRIORITY_STR">TYPE_PRIORITY_STR</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_RELATIVE_TIME">TYPE_RELATIVE_TIME</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_RELATIVE_TIME_STR">TYPE_RELATIVE_TIME_STR</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_TEXT">TYPE_TEXT</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_THREAD">TYPE_THREAD</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_THREAD_STR">TYPE_THREAD_STR</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_THROWABLE">TYPE_THROWABLE</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_THROWABLE_STR">TYPE_THROWABLE_STR</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#TYPE_TIME">TYPE_TIME</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private 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="../../../../org/apache/log/format/PatternFormatter.html#TYPE_TIME_STR">TYPE_TIME_STR</a></strong></code> </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="../../../../org/apache/log/format/PatternFormatter.html#PatternFormatter(java.lang.String)">PatternFormatter</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> pattern)</code>
<div class="block">Creation of a new patter formatter baseed on a supplied pattern.</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>private int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#addPatternRun(java.util.Stack,%20char[],%20int)">addPatternRun</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a> stack,
char[] pattern,
int index)</code>
<div class="block">Extract and build a pattern from input string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#addTextRun(java.util.Stack,%20char[],%20int)">addTextRun</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a> stack,
char[] pattern,
int index)</code>
<div class="block">Extract and build a text run from input string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#append(java.lang.StringBuffer,%20int,%20int,%20boolean,%20java.lang.String)">append</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> sb,
int minSize,
int maxSize,
boolean rightJustify,
<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> output)</code>
<div class="block">Utility to append a string to buffer given certain constraints.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#appendWhiteSpace(java.lang.StringBuffer,%20int)">appendWhiteSpace</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> sb,
int length)</code>
<div class="block">Append a certain number of whitespace characters to a StringBuffer.</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="../../../../org/apache/log/format/PatternFormatter.html#format(org.apache.log.LogEvent)">format</a></strong>(<a href="../../../../org/apache/log/LogEvent.html" title="class in org.apache.log">LogEvent</a> event)</code>
<div class="block">Format the event according to the pattern.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#formatPatternRun(org.apache.log.LogEvent,%20org.apache.log.format.PatternFormatter.PatternRun)">formatPatternRun</a></strong>(<a href="../../../../org/apache/log/LogEvent.html" title="class in org.apache.log">LogEvent</a> event,
<a href="../../../../org/apache/log/format/PatternFormatter.PatternRun.html" title="class in org.apache.log.format">PatternFormatter.PatternRun</a> run)</code>
<div class="block">Formats a single pattern run (can be extended in subclasses).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getCategory(java.lang.String,%20java.lang.String)">getCategory</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> category,
<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> format)</code>
<div class="block">Utility method to format category.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getContextMap(org.apache.log.ContextMap,%20java.lang.String)">getContextMap</a></strong>(<a href="../../../../org/apache/log/ContextMap.html" title="class in org.apache.log">ContextMap</a> map,
<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> format)</code>
<div class="block">Utility method to format context map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getMessage(java.lang.String,%20java.lang.String)">getMessage</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> message,
<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> format)</code>
<div class="block">Utility method to format message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getPriority(org.apache.log.Priority,%20java.lang.String)">getPriority</a></strong>(<a href="../../../../org/apache/log/Priority.html" title="class in org.apache.log">Priority</a> priority,
<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> format)</code>
<div class="block">Get formatted priority string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getRTime(long,%20java.lang.String)">getRTime</a></strong>(long time,
<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> format)</code>
<div class="block">Utility method to format relative time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getStackTrace(java.lang.Throwable,%20java.lang.String)">getStackTrace</a></strong>(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> throwable,
<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> format)</code>
<div class="block">Utility method to format stack trace.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getThread(java.lang.String)">getThread</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> format)</code>
<div class="block">Get formatted thread string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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="../../../../org/apache/log/format/PatternFormatter.html#getTime(long,%20java.lang.String)">getTime</a></strong>(long time,
<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> format)</code>
<div class="block">Utility method to format time.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#getTypeIdFor(java.lang.String)">getTypeIdFor</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> type)</code>
<div class="block">Retrieve the type-id for a particular string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log/format/PatternFormatter.html#parse(java.lang.String)">parse</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> patternString)</code>
<div class="block">Parse the input pattern and build internal data structures.</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,%20int)" 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="TYPE_TEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_TEXT</h4>
<pre>private static final int TYPE_TEXT</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_TEXT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_CATEGORY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_CATEGORY</h4>
<pre>private static final int TYPE_CATEGORY</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_CATEGORY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_CONTEXT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_CONTEXT</h4>
<pre>private static final int TYPE_CONTEXT</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_CONTEXT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_MESSAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_MESSAGE</h4>
<pre>private static final int TYPE_MESSAGE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_MESSAGE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_TIME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_TIME</h4>
<pre>private static final int TYPE_TIME</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_TIME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_RELATIVE_TIME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_RELATIVE_TIME</h4>
<pre>private static final int TYPE_RELATIVE_TIME</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_RELATIVE_TIME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_THROWABLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_THROWABLE</h4>
<pre>private static final int TYPE_THROWABLE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_THROWABLE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_PRIORITY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_PRIORITY</h4>
<pre>private static final int TYPE_PRIORITY</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_PRIORITY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_THREAD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_THREAD</h4>
<pre>private static final int TYPE_THREAD</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_THREAD">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="MAX_TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_TYPE</h4>
<pre>protected static final int MAX_TYPE</pre>
<div class="block">The maximum value used for TYPEs. Subclasses can define their own TYPEs
starting at <code>MAX_TYPE + 1</code>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.MAX_TYPE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_CATEGORY_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_CATEGORY_STR</h4>
<pre>private 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> TYPE_CATEGORY_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_CATEGORY_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_CONTEXT_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_CONTEXT_STR</h4>
<pre>private 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> TYPE_CONTEXT_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_CONTEXT_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_MESSAGE_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_MESSAGE_STR</h4>
<pre>private 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> TYPE_MESSAGE_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_MESSAGE_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_TIME_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_TIME_STR</h4>
<pre>private 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> TYPE_TIME_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_TIME_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_RELATIVE_TIME_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_RELATIVE_TIME_STR</h4>
<pre>private 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> TYPE_RELATIVE_TIME_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_RELATIVE_TIME_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_THROWABLE_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_THROWABLE_STR</h4>
<pre>private 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> TYPE_THROWABLE_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_THROWABLE_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_PRIORITY_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_PRIORITY_STR</h4>
<pre>private 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> TYPE_PRIORITY_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_PRIORITY_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_THREAD_STR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_THREAD_STR</h4>
<pre>private 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> TYPE_THREAD_STR</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.TYPE_THREAD_STR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SPACE_16">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPACE_16</h4>
<pre>private 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> SPACE_16</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.SPACE_16">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SPACE_8">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPACE_8</h4>
<pre>private 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> SPACE_8</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.SPACE_8">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SPACE_4">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPACE_4</h4>
<pre>private 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> SPACE_4</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.SPACE_4">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SPACE_2">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPACE_2</h4>
<pre>private 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> SPACE_2</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.SPACE_2">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SPACE_1">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPACE_1</h4>
<pre>private 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> SPACE_1</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.log.format.PatternFormatter.SPACE_1">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="EOL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EOL</h4>
<pre>private 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> EOL</pre>
</li>
</ul>
<a name="m_formatSpecification">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_formatSpecification</h4>
<pre>private <a href="../../../../org/apache/log/format/PatternFormatter.PatternRun.html" title="class in org.apache.log.format">PatternFormatter.PatternRun</a>[] m_formatSpecification</pre>
</li>
</ul>
<a name="m_simpleDateFormat">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_simpleDateFormat</h4>
<pre>private <a href="/usr/share/doc/default-jdk-doc/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a> m_simpleDateFormat</pre>
</li>
</ul>
<a name="m_date">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>m_date</h4>
<pre>private final <a href="/usr/share/doc/default-jdk-doc/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> m_date</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PatternFormatter(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PatternFormatter</h4>
<pre>public PatternFormatter(<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> pattern)</pre>
<div class="block">Creation of a new patter formatter baseed on a supplied pattern.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pattern</code> - the patter</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="addPatternRun(java.util.Stack, char[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPatternRun</h4>
<pre>private int addPatternRun(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a> stack,
char[] pattern,
int index)</pre>
<div class="block">Extract and build a pattern from input string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stack</code> - the stack on which to place patterns</dd><dd><code>pattern</code> - the input string</dd><dd><code>index</code> - the start of pattern run</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of characters in pattern run</dd></dl>
</li>
</ul>
<a name="addTextRun(java.util.Stack, char[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTextRun</h4>
<pre>private int addTextRun(<a href="/usr/share/doc/default-jdk-doc/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a> stack,
char[] pattern,
int index)</pre>
<div class="block">Extract and build a text run from input string.
It does special handling of '\n' and '\t' replaceing
them with newline and tab.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stack</code> - the stack on which to place runs</dd><dd><code>pattern</code> - the input string</dd><dd><code>index</code> - the start of the text run</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of characters in run</dd></dl>
</li>
</ul>
<a name="append(java.lang.StringBuffer, int, int, boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre>private void append(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> sb,
int minSize,
int maxSize,
boolean rightJustify,
<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> output)</pre>
<div class="block">Utility to append a string to buffer given certain constraints.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sb</code> - the StringBuffer</dd><dd><code>minSize</code> - the minimum size of output (0 to ignore)</dd><dd><code>maxSize</code> - the maximum size of output (0 to ignore)</dd><dd><code>rightJustify</code> - true if the string is to be right justified in it's box.</dd><dd><code>output</code> - the input string</dd></dl>
</li>
</ul>
<a name="appendWhiteSpace(java.lang.StringBuffer, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendWhiteSpace</h4>
<pre>private void appendWhiteSpace(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> sb,
int length)</pre>
<div class="block">Append a certain number of whitespace characters to a StringBuffer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sb</code> - the StringBuffer</dd><dd><code>length</code> - the number of spaces to append</dd></dl>
</li>
</ul>
<a name="format(org.apache.log.LogEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</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> format(<a href="../../../../org/apache/log/LogEvent.html" title="class in org.apache.log">LogEvent</a> event)</pre>
<div class="block">Format the event according to the pattern.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/log/format/Formatter.html#format(org.apache.log.LogEvent)">format</a></code> in interface <code><a href="../../../../org/apache/log/format/Formatter.html" title="interface in org.apache.log.format">Formatter</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>event</code> - the event</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted output</dd></dl>
</li>
</ul>
<a name="formatPatternRun(org.apache.log.LogEvent, org.apache.log.format.PatternFormatter.PatternRun)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatPatternRun</h4>
<pre>protected <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> formatPatternRun(<a href="../../../../org/apache/log/LogEvent.html" title="class in org.apache.log">LogEvent</a> event,
<a href="../../../../org/apache/log/format/PatternFormatter.PatternRun.html" title="class in org.apache.log.format">PatternFormatter.PatternRun</a> run)</pre>
<div class="block">Formats a single pattern run (can be extended in subclasses).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>run</code> - the pattern run to format.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted result.</dd></dl>
</li>
</ul>
<a name="getCategory(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCategory</h4>
<pre>protected <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> getCategory(<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> category,
<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> format)</pre>
<div class="block">Utility method to format category.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the category string</dd><dd><code>format</code> - ancilliary format parameter - allowed to be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted string</dd></dl>
</li>
</ul>
<a name="getPriority(org.apache.log.Priority, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPriority</h4>
<pre>protected <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> getPriority(<a href="../../../../org/apache/log/Priority.html" title="class in org.apache.log">Priority</a> priority,
<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> format)</pre>
<div class="block">Get formatted priority string.</div>
</li>
</ul>
<a name="getThread(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThread</h4>
<pre>protected <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> getThread(<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> format)</pre>
<div class="block">Get formatted thread string.</div>
</li>
</ul>
<a name="getContextMap(org.apache.log.ContextMap, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextMap</h4>
<pre>protected <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> getContextMap(<a href="../../../../org/apache/log/ContextMap.html" title="class in org.apache.log">ContextMap</a> map,
<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> format)</pre>
<div class="block">Utility method to format context map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the context map</dd><dd><code>format</code> - ancilliary format parameter - allowed to be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted string</dd></dl>
</li>
</ul>
<a name="getMessage(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre>protected <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> getMessage(<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> message,
<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> format)</pre>
<div class="block">Utility method to format message.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message string</dd><dd><code>format</code> - ancilliary format parameter - allowed to be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted string</dd></dl>
</li>
</ul>
<a name="getStackTrace(java.lang.Throwable, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStackTrace</h4>
<pre>protected <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> getStackTrace(<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> throwable,
<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> format)</pre>
<div class="block">Utility method to format stack trace.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>throwable</code> - the throwable instance</dd><dd><code>format</code> - ancilliary format parameter - allowed to be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted string</dd></dl>
</li>
</ul>
<a name="getRTime(long, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRTime</h4>
<pre>protected <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> getRTime(long time,
<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> format)</pre>
<div class="block">Utility method to format relative time.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - the time</dd><dd><code>format</code> - ancilliary format parameter - allowed to be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted string</dd></dl>
</li>
</ul>
<a name="getTime(long, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTime</h4>
<pre>protected <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> getTime(long time,
<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> format)</pre>
<div class="block">Utility method to format time.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - the time</dd><dd><code>format</code> - ancilliary format parameter - allowed to be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the formatted string</dd></dl>
</li>
</ul>
<a name="getTypeIdFor(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeIdFor</h4>
<pre>protected int getTypeIdFor(<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> type)</pre>
<div class="block">Retrieve the type-id for a particular string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the string</dd>
<dt><span class="strong">Returns:</span></dt><dd>the type-id</dd></dl>
</li>
</ul>
<a name="parse(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parse</h4>
<pre>protected final void parse(<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> patternString)</pre>
<div class="block">Parse the input pattern and build internal data structures.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>patternString</code> - the pattern</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PatternFormatter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log/format/Formatter.html" title="interface in org.apache.log.format"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/log/format/PatternFormatter.PatternRun.html" title="class in org.apache.log.format"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log/format/PatternFormatter.html" target="_top">Frames</a></li>
<li><a href="PatternFormatter.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 ======= -->
<p class="legalCopy"><small>Copyright © 2003-2004 The Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>
|