/usr/share/doc/liblog4j1.2-java/api/org/apache/log4j/lf5/LogRecord.html is in liblog4j1.2-java-doc 1.2.17-4ubuntu3.
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 | <!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_51) on Tue Mar 25 10:22:19 UTC 2014 -->
<title>LogRecord (Log4j Version 1.2.17)</title>
<meta name="date" content="2014-03-25">
<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="LogRecord (Log4j Version 1.2.17)";
}
//-->
</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/LogRecord.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 class="aboutLanguage"><em><b>Log4j 1.2.17</b><!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/lf5/LogLevelFormatException.html" title="class in org.apache.log4j.lf5"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/log4j/lf5/LogRecordFilter.html" title="interface in org.apache.log4j.lf5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/lf5/LogRecord.html" target="_top">Frames</a></li>
<li><a href="LogRecord.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.log4j.lf5</div>
<h2 title="Class LogRecord" class="title">Class LogRecord</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.lf5.LogRecord</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/log4j/lf5/Log4JLogRecord.html" title="class in org.apache.log4j.lf5">Log4JLogRecord</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">LogRecord</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">LogRecord. A LogRecord encapsulates the details of your desired log
request.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Michael J. Sikorsky, Robert Shaw</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.log4j.lf5.LogRecord">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_category">_category</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5">LogLevel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_level">_level</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_location">_location</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_message">_message</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_millis">_millis</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_ndc">_ndc</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_seqCount">_seqCount</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_sequenceNumber">_sequenceNumber</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_thread">_thread</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.Throwable</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_thrown">_thrown</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#_thrownStackTrace">_thrownStackTrace</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/log4j/lf5/LogRecord.html#LogRecord()">LogRecord</a></strong>()</code> </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>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getCategory()">getCategory</a></strong>()</code>
<div class="block">Get the category asscociated with this LogRecord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5">LogLevel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getLevel()">getLevel</a></strong>()</code>
<div class="block">Get the level of this LogRecord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getLocation()">getLocation</a></strong>()</code>
<div class="block">Get the location in code where this LogRecord originated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getMessage()">getMessage</a></strong>()</code>
<div class="block">Get the message asscociated with this LogRecord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getMillis()">getMillis</a></strong>()</code>
<div class="block">Get the event time of this record in milliseconds from 1970.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getNDC()">getNDC</a></strong>()</code>
<div class="block">Get the NDC (nested diagnostic context) for this record.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getNextId()">getNextId</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getSequenceNumber()">getSequenceNumber</a></strong>()</code>
<div class="block">Get the sequence number associated with this LogRecord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThreadDescription()">getThreadDescription</a></strong>()</code>
<div class="block">Get the thread description asscociated with this LogRecord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Throwable</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThrown()">getThrown</a></strong>()</code>
<div class="block">Get the Throwable associated with this LogRecord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThrownStackTrace()">getThrownStackTrace</a></strong>()</code>
<div class="block">Get the stack trace in a String-based format for the associated Throwable
of this LogRecord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#hasThrown()">hasThrown</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#isFatal()">isFatal</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#isSevereLevel()">isSevereLevel</a></strong>()</code>
<div class="block">Abstract method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#resetSequenceNumber()">resetSequenceNumber</a></strong>()</code>
<div class="block">Resets that sequence number to 0.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setCategory(java.lang.String)">setCategory</a></strong>(java.lang.String category)</code>
<div class="block">Set the category associated with this LogRecord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setLevel(org.apache.log4j.lf5.LogLevel)">setLevel</a></strong>(<a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5">LogLevel</a> level)</code>
<div class="block">Set the level of this LogRecord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setLocation(java.lang.String)">setLocation</a></strong>(java.lang.String location)</code>
<div class="block">Set the location in code where this LogRecord originated.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setMessage(java.lang.String)">setMessage</a></strong>(java.lang.String message)</code>
<div class="block">Set the message associated with this LogRecord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setMillis(long)">setMillis</a></strong>(long millis)</code>
<div class="block">Set the event time of this record.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setNDC(java.lang.String)">setNDC</a></strong>(java.lang.String ndc)</code>
<div class="block">Set the NDC (nested diagnostic context) for this record.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setSequenceNumber(long)">setSequenceNumber</a></strong>(long number)</code>
<div class="block">Set the sequence number assocsiated with this LogRecord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setThreadDescription(java.lang.String)">setThreadDescription</a></strong>(java.lang.String threadDescription)</code>
<div class="block">Set the thread description associated with this LogRecord.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setThrown(java.lang.Throwable)">setThrown</a></strong>(java.lang.Throwable thrown)</code>
<div class="block">Set the Throwable associated with this LogRecord.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setThrownStackTrace(java.lang.String)">setThrownStackTrace</a></strong>(java.lang.String trace)</code>
<div class="block">Set the ThrownStackTrace for the log record.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/log4j/lf5/LogRecord.html#toString()">toString</a></strong>()</code>
<div class="block">Return a String representation of this LogRecord.</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="_seqCount">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_seqCount</h4>
<pre>protected static long _seqCount</pre>
</li>
</ul>
<a name="_level">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_level</h4>
<pre>protected <a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5">LogLevel</a> _level</pre>
</li>
</ul>
<a name="_message">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_message</h4>
<pre>protected java.lang.String _message</pre>
</li>
</ul>
<a name="_sequenceNumber">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_sequenceNumber</h4>
<pre>protected long _sequenceNumber</pre>
</li>
</ul>
<a name="_millis">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_millis</h4>
<pre>protected long _millis</pre>
</li>
</ul>
<a name="_category">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_category</h4>
<pre>protected java.lang.String _category</pre>
</li>
</ul>
<a name="_thread">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_thread</h4>
<pre>protected java.lang.String _thread</pre>
</li>
</ul>
<a name="_thrownStackTrace">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_thrownStackTrace</h4>
<pre>protected java.lang.String _thrownStackTrace</pre>
</li>
</ul>
<a name="_thrown">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_thrown</h4>
<pre>protected java.lang.Throwable _thrown</pre>
</li>
</ul>
<a name="_ndc">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_ndc</h4>
<pre>protected java.lang.String _ndc</pre>
</li>
</ul>
<a name="_location">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_location</h4>
<pre>protected java.lang.String _location</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LogRecord()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LogRecord</h4>
<pre>public LogRecord()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevel</h4>
<pre>public <a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5">LogLevel</a> getLevel()</pre>
<div class="block">Get the level of this LogRecord.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The LogLevel of this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setLevel(org.apache.log4j.lf5.LogLevel)"><code>setLevel(LogLevel)</code></a>,
<a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5"><code>LogLevel</code></a></dd></dl>
</li>
</ul>
<a name="setLevel(org.apache.log4j.lf5.LogLevel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLevel</h4>
<pre>public void setLevel(<a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5">LogLevel</a> level)</pre>
<div class="block">Set the level of this LogRecord.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - The LogLevel for this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getLevel()"><code>getLevel()</code></a>,
<a href="../../../../org/apache/log4j/lf5/LogLevel.html" title="class in org.apache.log4j.lf5"><code>LogLevel</code></a></dd></dl>
</li>
</ul>
<a name="isSevereLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSevereLevel</h4>
<pre>public abstract boolean isSevereLevel()</pre>
<div class="block">Abstract method. Must be overridden to indicate what log level
to show in red.</div>
</li>
</ul>
<a name="hasThrown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasThrown</h4>
<pre>public boolean hasThrown()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if getThrown().toString() is a non-empty string.</dd></dl>
</li>
</ul>
<a name="isFatal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFatal</h4>
<pre>public boolean isFatal()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if isSevereLevel() or hasThrown() returns true.</dd></dl>
</li>
</ul>
<a name="getCategory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCategory</h4>
<pre>public java.lang.String getCategory()</pre>
<div class="block">Get the category asscociated with this LogRecord. For a more detailed
description of what a category is see setCategory().</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The category of this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setCategory(java.lang.String)"><code>setCategory(String)</code></a></dd></dl>
</li>
</ul>
<a name="setCategory(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCategory</h4>
<pre>public void setCategory(java.lang.String category)</pre>
<div class="block">Set the category associated with this LogRecord. A category represents
a hierarchical dot (".") separated namespace for messages.
The definition of a category is application specific, but a common convention
is as follows:
<p>
When logging messages
for a particluar class you can use its class name:
com.thoughtworks.framework.servlet.ServletServiceBroker.<br><br>
Futhermore, to log a message for a particular method in a class
add the method name:
com.thoughtworks.framework.servlet.ServletServiceBroker.init().
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - The category for this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getCategory()"><code>getCategory()</code></a></dd></dl>
</li>
</ul>
<a name="getMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre>public java.lang.String getMessage()</pre>
<div class="block">Get the message asscociated with this LogRecord.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The message of this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setMessage(java.lang.String)"><code>setMessage(String)</code></a></dd></dl>
</li>
</ul>
<a name="setMessage(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessage</h4>
<pre>public void setMessage(java.lang.String message)</pre>
<div class="block">Set the message associated with this LogRecord.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - The message for this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getMessage()"><code>getMessage()</code></a></dd></dl>
</li>
</ul>
<a name="getSequenceNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSequenceNumber</h4>
<pre>public long getSequenceNumber()</pre>
<div class="block">Get the sequence number associated with this LogRecord. Sequence numbers
are generally assigned when a LogRecord is constructed. Sequence numbers
start at 0 and increase with each newly constructed LogRocord.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The sequence number of this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setSequenceNumber(long)"><code>setSequenceNumber(long)</code></a></dd></dl>
</li>
</ul>
<a name="setSequenceNumber(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSequenceNumber</h4>
<pre>public void setSequenceNumber(long number)</pre>
<div class="block">Set the sequence number assocsiated with this LogRecord. A sequence number
will automatically be assigned to evey newly constructed LogRecord, however,
this method can override the value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - The sequence number.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getSequenceNumber()"><code>getSequenceNumber()</code></a></dd></dl>
</li>
</ul>
<a name="getMillis()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMillis</h4>
<pre>public long getMillis()</pre>
<div class="block">Get the event time of this record in milliseconds from 1970.
When a LogRecord is constructed the event time is set but may be
overridden by calling setMillis();</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The event time of this record in milliseconds from 1970.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setMillis(long)"><code>setMillis(long)</code></a></dd></dl>
</li>
</ul>
<a name="setMillis(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMillis</h4>
<pre>public void setMillis(long millis)</pre>
<div class="block">Set the event time of this record. When a LogRecord is constructed
the event time is set but may be overridden by calling this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>millis</code> - The time in milliseconds from 1970.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getMillis()"><code>getMillis()</code></a></dd></dl>
</li>
</ul>
<a name="getThreadDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreadDescription</h4>
<pre>public java.lang.String getThreadDescription()</pre>
<div class="block">Get the thread description asscociated with this LogRecord. When a
LogRecord is constructed, the thread description is set by calling:
Thread.currentThread().toString(). You may supply a thread description
of your own by calling the setThreadDescription(String) method.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The thread description of this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setThreadDescription(java.lang.String)"><code>setThreadDescription(String)</code></a></dd></dl>
</li>
</ul>
<a name="setThreadDescription(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThreadDescription</h4>
<pre>public void setThreadDescription(java.lang.String threadDescription)</pre>
<div class="block">Set the thread description associated with this LogRecord. When a
LogRecord is constructed, the thread description is set by calling:
Thread.currentThread().toString(). You may supply a thread description
of your own by calling this method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>threadDescription</code> - The description of the thread for this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThreadDescription()"><code>getThreadDescription()</code></a></dd></dl>
</li>
</ul>
<a name="getThrownStackTrace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThrownStackTrace</h4>
<pre>public java.lang.String getThrownStackTrace()</pre>
<div class="block">Get the stack trace in a String-based format for the associated Throwable
of this LogRecord. The stack trace in a String-based format is set
when the setThrown(Throwable) method is called.
<p>
Why do we need this method considering that we
have the getThrown() and setThrown() methods?
A Throwable object may not be serializable, however, a String representation
of it is. Users of LogRecords should generally call this method over
getThrown() for the reasons of serialization.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The Stack Trace for the asscoiated Throwable of this LogRecord.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setThrown(java.lang.Throwable)"><code>setThrown(Throwable)</code></a>,
<a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThrown()"><code>getThrown()</code></a></dd></dl>
</li>
</ul>
<a name="setThrownStackTrace(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThrownStackTrace</h4>
<pre>public void setThrownStackTrace(java.lang.String trace)</pre>
<div class="block">Set the ThrownStackTrace for the log record.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>trace</code> - A String to associate with this LogRecord</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThrownStackTrace()"><code>getThrownStackTrace()</code></a></dd></dl>
</li>
</ul>
<a name="getThrown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThrown</h4>
<pre>public java.lang.Throwable getThrown()</pre>
<div class="block">Get the Throwable associated with this LogRecord.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The LogLevel of this record.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#setThrown(java.lang.Throwable)"><code>setThrown(Throwable)</code></a>,
<a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThrownStackTrace()"><code>getThrownStackTrace()</code></a></dd></dl>
</li>
</ul>
<a name="setThrown(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThrown</h4>
<pre>public void setThrown(java.lang.Throwable thrown)</pre>
<div class="block">Set the Throwable associated with this LogRecord. When this method
is called, the stack trace in a String-based format is made
available via the getThrownStackTrace() method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thrown</code> - A Throwable to associate with this LogRecord.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThrown()"><code>getThrown()</code></a>,
<a href="../../../../org/apache/log4j/lf5/LogRecord.html#getThrownStackTrace()"><code>getThrownStackTrace()</code></a></dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Return a String representation of this LogRecord.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="getNDC()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNDC</h4>
<pre>public java.lang.String getNDC()</pre>
<div class="block">Get the NDC (nested diagnostic context) for this record.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The string representing the NDC.</dd></dl>
</li>
</ul>
<a name="setNDC(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNDC</h4>
<pre>public void setNDC(java.lang.String ndc)</pre>
<div class="block">Set the NDC (nested diagnostic context) for this record.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ndc</code> - A string representing the NDC.</dd></dl>
</li>
</ul>
<a name="getLocation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocation</h4>
<pre>public java.lang.String getLocation()</pre>
<div class="block">Get the location in code where this LogRecord originated.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The string containing the location information.</dd></dl>
</li>
</ul>
<a name="setLocation(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocation</h4>
<pre>public void setLocation(java.lang.String location)</pre>
<div class="block">Set the location in code where this LogRecord originated.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - A string containing location information.</dd></dl>
</li>
</ul>
<a name="resetSequenceNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetSequenceNumber</h4>
<pre>public static void resetSequenceNumber()</pre>
<div class="block">Resets that sequence number to 0.</div>
</li>
</ul>
<a name="getNextId()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNextId</h4>
<pre>protected static long getNextId()</pre>
</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/LogRecord.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 class="aboutLanguage"><em><b>Log4j 1.2.17</b><!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/lf5/LogLevelFormatException.html" title="class in org.apache.log4j.lf5"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/log4j/lf5/LogRecordFilter.html" title="interface in org.apache.log4j.lf5"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/lf5/LogRecord.html" target="_top">Frames</a></li>
<li><a href="LogRecord.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright 2000-2007 Apache Software Foundation.</small></p>
</body>
</html>
|