/usr/share/doc/liblog4j1.2-java/api/org/apache/log4j/spi/LoggingEvent.html is in liblog4j1.2-java-doc 1.2.17-8.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>LoggingEvent (Log4j Version 1.2.17)</title>
<meta name="date" content="2017-10-21">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LoggingEvent (Log4j Version 1.2.17)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/LoggingEvent.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"><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. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/apache/log4j/spi/NOPLogger.html" title="class in org.apache.log4j.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/spi/LoggingEvent.html" target="_top">Frames</a></li>
<li><a href="LoggingEvent.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.spi</div>
<h2 title="Class LoggingEvent" class="title">Class LoggingEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.spi.LoggingEvent</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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">LoggingEvent</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">The internal representation of logging events. When an affirmative
decision is made to log then a <code>LoggingEvent</code> instance
is created. This instance is passed around to the different log4j
components.
<p>This class is of concern to those wishing to extend log4j.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.8.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ceki Gülcü, James P. Cakalic</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.log4j.spi.LoggingEvent">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="memberSummary" 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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#categoryName">categoryName</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">This field will be marked as private in future
releases. Please do not access it directly. Use the <a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLoggerName--"><code>getLoggerName()</code></a> method instead.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#fqnOfCategoryClass">fqnOfCategoryClass</a></span></code>
<div class="block">Fully qualified name of the calling category class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j">Priority</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#level">level</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">This field will be marked as private in future
releases. Please do not access it directly. Use the <a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLevel--"><code>getLevel()</code></a> method instead.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#timeStamp">timeStamp</a></span></code>
<div class="block">The number of milliseconds elapsed from 1/1/1970 until logging event
was created.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#LoggingEvent-java.lang.String-org.apache.log4j.Category-long-org.apache.log4j.Level-java.lang.Object-java.lang.String-org.apache.log4j.spi.ThrowableInformation-java.lang.String-org.apache.log4j.spi.LocationInfo-java.util.Map-">LoggingEvent</a></span>(java.lang.String fqnOfCategoryClass,
<a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a> logger,
long timeStamp,
<a href="../../../../org/apache/log4j/Level.html" title="class in org.apache.log4j">Level</a> level,
java.lang.Object message,
java.lang.String threadName,
<a href="../../../../org/apache/log4j/spi/ThrowableInformation.html" title="class in org.apache.log4j.spi">ThrowableInformation</a> throwable,
java.lang.String ndc,
<a href="../../../../org/apache/log4j/spi/LocationInfo.html" title="class in org.apache.log4j.spi">LocationInfo</a> info,
java.util.Map properties)</code>
<div class="block">Create new instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#LoggingEvent-java.lang.String-org.apache.log4j.Category-long-org.apache.log4j.Priority-java.lang.Object-java.lang.Throwable-">LoggingEvent</a></span>(java.lang.String fqnOfCategoryClass,
<a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a> logger,
long timeStamp,
<a href="../../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j">Priority</a> level,
java.lang.Object message,
java.lang.Throwable throwable)</code>
<div class="block">Instantiate a LoggingEvent from the supplied parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#LoggingEvent-java.lang.String-org.apache.log4j.Category-org.apache.log4j.Priority-java.lang.Object-java.lang.Throwable-">LoggingEvent</a></span>(java.lang.String fqnOfCategoryClass,
<a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a> logger,
<a href="../../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j">Priority</a> level,
java.lang.Object message,
java.lang.Throwable throwable)</code>
<div class="block">Instantiate a LoggingEvent from the supplied parameters.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getFQNOfLoggerClass--">getFQNOfLoggerClass</a></span>()</code>
<div class="block">Get the fully qualified name of the calling logger sub-class/wrapper.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/log4j/Level.html" title="class in org.apache.log4j">Level</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLevel--">getLevel</a></span>()</code>
<div class="block">Return the level of this event.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/log4j/spi/LocationInfo.html" title="class in org.apache.log4j.spi">LocationInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLocationInformation--">getLocationInformation</a></span>()</code>
<div class="block">Set the location information for this logging event.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLogger--">getLogger</a></span>()</code>
<div class="block">Gets the logger of the event.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLoggerName--">getLoggerName</a></span>()</code>
<div class="block">Return the name of the logger.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getMDC-java.lang.String-">getMDC</a></span>(java.lang.String key)</code>
<div class="block">Returns the the context corresponding to the <code>key</code>
parameter.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getMDCCopy--">getMDCCopy</a></span>()</code>
<div class="block">Obtain a copy of this thread's MDC prior to serialization or
asynchronous logging.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getMessage--">getMessage</a></span>()</code>
<div class="block">Return the message for this logging event.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getNDC--">getNDC</a></span>()</code>
<div class="block">This method returns the NDC for this event.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Map</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getProperties--">getProperties</a></span>()</code>
<div class="block">Returns the set of properties
for the event.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getProperty-java.lang.String-">getProperty</a></span>(java.lang.String key)</code>
<div class="block">Return a property for this event.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.Set</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getPropertyKeySet--">getPropertyKeySet</a></span>()</code>
<div class="block">Returns the set of the key values in the properties
for the event.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getRenderedMessage--">getRenderedMessage</a></span>()</code> </td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getStartTime--">getStartTime</a></span>()</code>
<div class="block">Returns the time when the application started, in milliseconds
elapsed since 01.01.1970.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getThreadName--">getThreadName</a></span>()</code> </td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/log4j/spi/ThrowableInformation.html" title="class in org.apache.log4j.spi">ThrowableInformation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getThrowableInformation--">getThrowableInformation</a></span>()</code>
<div class="block">Returns the throwable information contained within this
event.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getThrowableStrRep--">getThrowableStrRep</a></span>()</code>
<div class="block">Return this event's throwable's string[] representaion.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getTimeStamp--">getTimeStamp</a></span>()</code>
<div class="block">Getter for the event's time stamp.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#locationInformationExists--">locationInformationExists</a></span>()</code>
<div class="block">Check for the existence of location information without creating it
(a byproduct of calling getLocationInformation).</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#removeProperty-java.lang.String-">removeProperty</a></span>(java.lang.String propName)</code>
<div class="block">This removes the specified MDC property from the event.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/log4j/spi/LoggingEvent.html#setProperty-java.lang.String-java.lang.String-">setProperty</a></span>(java.lang.String propName,
java.lang.String propValue)</code>
<div class="block">Set value for MDC property.</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, toString, 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="fqnOfCategoryClass">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fqnOfCategoryClass</h4>
<pre>public final transient java.lang.String fqnOfCategoryClass</pre>
<div class="block">Fully qualified name of the calling category class.</div>
</li>
</ul>
<a name="categoryName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>categoryName</h4>
<pre>public final java.lang.String categoryName</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">This field will be marked as private in future
releases. Please do not access it directly. Use the <a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLoggerName--"><code>getLoggerName()</code></a> method instead.</span></div>
<div class="block"><p>The category (logger) name.</div>
</li>
</ul>
<a name="level">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>level</h4>
<pre>public transient <a href="../../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j">Priority</a> level</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">This field will be marked as private in future
releases. Please do not access it directly. Use the <a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLevel--"><code>getLevel()</code></a> method instead.</span></div>
<div class="block">Level of logging event. Level cannot be serializable because it
is a flyweight. Due to its special seralization it cannot be
declared final either.
<p> This field should not be accessed directly. You shoud use the
<a href="../../../../org/apache/log4j/spi/LoggingEvent.html#getLevel--"><code>getLevel()</code></a> method instead.</div>
</li>
</ul>
<a name="timeStamp">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>timeStamp</h4>
<pre>public final long timeStamp</pre>
<div class="block">The number of milliseconds elapsed from 1/1/1970 until logging event
was created.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="LoggingEvent-java.lang.String-org.apache.log4j.Category-org.apache.log4j.Priority-java.lang.Object-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LoggingEvent</h4>
<pre>public LoggingEvent(java.lang.String fqnOfCategoryClass,
<a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a> logger,
<a href="../../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j">Priority</a> level,
java.lang.Object message,
java.lang.Throwable throwable)</pre>
<div class="block">Instantiate a LoggingEvent from the supplied parameters.
<p>Except <a href="../../../../org/apache/log4j/spi/LoggingEvent.html#timeStamp"><code>timeStamp</code></a> all the other fields of
<code>LoggingEvent</code> are filled when actually needed.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logger</code> - The logger generating this event.</dd>
<dd><code>level</code> - The level of this event.</dd>
<dd><code>message</code> - The message of this event.</dd>
<dd><code>throwable</code> - The throwable of this event.</dd>
</dl>
</li>
</ul>
<a name="LoggingEvent-java.lang.String-org.apache.log4j.Category-long-org.apache.log4j.Priority-java.lang.Object-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LoggingEvent</h4>
<pre>public LoggingEvent(java.lang.String fqnOfCategoryClass,
<a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a> logger,
long timeStamp,
<a href="../../../../org/apache/log4j/Priority.html" title="class in org.apache.log4j">Priority</a> level,
java.lang.Object message,
java.lang.Throwable throwable)</pre>
<div class="block">Instantiate a LoggingEvent from the supplied parameters.
<p>Except <a href="../../../../org/apache/log4j/spi/LoggingEvent.html#timeStamp"><code>timeStamp</code></a> all the other fields of
<code>LoggingEvent</code> are filled when actually needed.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logger</code> - The logger generating this event.</dd>
<dd><code>timeStamp</code> - the timestamp of this logging event</dd>
<dd><code>level</code> - The level of this event.</dd>
<dd><code>message</code> - The message of this event.</dd>
<dd><code>throwable</code> - The throwable of this event.</dd>
</dl>
</li>
</ul>
<a name="LoggingEvent-java.lang.String-org.apache.log4j.Category-long-org.apache.log4j.Level-java.lang.Object-java.lang.String-org.apache.log4j.spi.ThrowableInformation-java.lang.String-org.apache.log4j.spi.LocationInfo-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LoggingEvent</h4>
<pre>public LoggingEvent(java.lang.String fqnOfCategoryClass,
<a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a> logger,
long timeStamp,
<a href="../../../../org/apache/log4j/Level.html" title="class in org.apache.log4j">Level</a> level,
java.lang.Object message,
java.lang.String threadName,
<a href="../../../../org/apache/log4j/spi/ThrowableInformation.html" title="class in org.apache.log4j.spi">ThrowableInformation</a> throwable,
java.lang.String ndc,
<a href="../../../../org/apache/log4j/spi/LocationInfo.html" title="class in org.apache.log4j.spi">LocationInfo</a> info,
java.util.Map properties)</pre>
<div class="block">Create new instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fqnOfCategoryClass</code> - Fully qualified class name
of Logger implementation.</dd>
<dd><code>logger</code> - The logger generating this event.</dd>
<dd><code>timeStamp</code> - the timestamp of this logging event</dd>
<dd><code>level</code> - The level of this event.</dd>
<dd><code>message</code> - The message of this event.</dd>
<dd><code>threadName</code> - thread name</dd>
<dd><code>throwable</code> - The throwable of this event.</dd>
<dd><code>ndc</code> - Nested diagnostic context</dd>
<dd><code>info</code> - Location info</dd>
<dd><code>properties</code> - MDC properties</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</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="getLocationInformation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocationInformation</h4>
<pre>public <a href="../../../../org/apache/log4j/spi/LocationInfo.html" title="class in org.apache.log4j.spi">LocationInfo</a> getLocationInformation()</pre>
<div class="block">Set the location information for this logging event. The collected
information is cached for future use.</div>
</li>
</ul>
<a name="getLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevel</h4>
<pre>public <a href="../../../../org/apache/log4j/Level.html" title="class in org.apache.log4j">Level</a> getLevel()</pre>
<div class="block">Return the level of this event. Use this form instead of directly
accessing the <code>level</code> field.</div>
</li>
</ul>
<a name="getLoggerName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoggerName</h4>
<pre>public java.lang.String getLoggerName()</pre>
<div class="block">Return the name of the logger. Use this form instead of directly
accessing the <code>categoryName</code> field.</div>
</li>
</ul>
<a name="getLogger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogger</h4>
<pre>public <a href="../../../../org/apache/log4j/Category.html" title="class in org.apache.log4j">Category</a> getLogger()</pre>
<div class="block">Gets the logger of the event.
Use should be restricted to cloning events.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="getMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre>public java.lang.Object getMessage()</pre>
<div class="block">Return the message for this logging event.
<p>Before serialization, the returned object is the message
passed by the user to generate the logging event. After
serialization, the returned value equals the String form of the
message possibly after object rendering.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</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">This method returns the NDC for this event. It will return the
correct content even if the event was generated in a different
thread or even on a different machine. The <a href="../../../../org/apache/log4j/NDC.html#get--"><code>NDC.get()</code></a> method
should <em>never</em> be called directly.</div>
</li>
</ul>
<a name="getMDC-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMDC</h4>
<pre>public java.lang.Object getMDC(java.lang.String key)</pre>
<div class="block">Returns the the context corresponding to the <code>key</code>
parameter. If there is a local MDC copy, possibly because we are
in a logging server or running inside AsyncAppender, then we
search for the key in MDC copy, if a value is found it is
returned. Otherwise, if the search in MDC copy returns a null
result, then the current thread's <code>MDC</code> is used.
<p>Note that <em>both</em> the local MDC copy and the current
thread's MDC are searched.</div>
</li>
</ul>
<a name="getMDCCopy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMDCCopy</h4>
<pre>public void getMDCCopy()</pre>
<div class="block">Obtain a copy of this thread's MDC prior to serialization or
asynchronous logging.</div>
</li>
</ul>
<a name="getRenderedMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenderedMessage</h4>
<pre>public java.lang.String getRenderedMessage()</pre>
</li>
</ul>
<a name="getStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartTime</h4>
<pre>public static long getStartTime()</pre>
<div class="block">Returns the time when the application started, in milliseconds
elapsed since 01.01.1970.</div>
</li>
</ul>
<a name="getThreadName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreadName</h4>
<pre>public java.lang.String getThreadName()</pre>
</li>
</ul>
<a name="getThrowableInformation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThrowableInformation</h4>
<pre>public <a href="../../../../org/apache/log4j/spi/ThrowableInformation.html" title="class in org.apache.log4j.spi">ThrowableInformation</a> getThrowableInformation()</pre>
<div class="block">Returns the throwable information contained within this
event. May be <code>null</code> if there is no such information.
<p>Note that the <code>Throwable</code> object contained within a
<a href="../../../../org/apache/log4j/spi/ThrowableInformation.html" title="class in org.apache.log4j.spi"><code>ThrowableInformation</code></a> does not survive serialization.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="getThrowableStrRep--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThrowableStrRep</h4>
<pre>public java.lang.String[] getThrowableStrRep()</pre>
<div class="block">Return this event's throwable's string[] representaion.</div>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public final void setProperty(java.lang.String propName,
java.lang.String propValue)</pre>
<div class="block">Set value for MDC property.
This adds the specified MDC property to the event.
Access to the MDC is not synchronized, so this
method should only be called when it is known that
no other threads are accessing the MDC.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propName</code> - </dd>
<dd><code>propValue</code> - </dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>public final java.lang.String getProperty(java.lang.String key)</pre>
<div class="block">Return a property for this event. The return value can be null.
Equivalent to getMDC(String) in log4j 1.2. Provided
for compatibility with log4j 1.3.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - property name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>property value or null if property not set</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="locationInformationExists--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locationInformationExists</h4>
<pre>public final boolean locationInformationExists()</pre>
<div class="block">Check for the existence of location information without creating it
(a byproduct of calling getLocationInformation).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if location information has been extracted.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="getTimeStamp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeStamp</h4>
<pre>public final long getTimeStamp()</pre>
<div class="block">Getter for the event's time stamp. The time stamp is calculated starting
from 1970-01-01 GMT.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>timestamp</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="getPropertyKeySet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyKeySet</h4>
<pre>public java.util.Set getPropertyKeySet()</pre>
<div class="block">Returns the set of the key values in the properties
for the event.
The returned set is unmodifiable by the caller.
Provided for compatibility with log4j 1.3</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Set an unmodifiable set of the property keys.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="getProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre>public java.util.Map getProperties()</pre>
<div class="block">Returns the set of properties
for the event.
The returned set is unmodifiable by the caller.
Provided for compatibility with log4j 1.3</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Set an unmodifiable map of the properties.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="getFQNOfLoggerClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFQNOfLoggerClass</h4>
<pre>public java.lang.String getFQNOfLoggerClass()</pre>
<div class="block">Get the fully qualified name of the calling logger sub-class/wrapper.
Provided for compatibility with log4j 1.3</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>fully qualified class name, may be null.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.15</dd>
</dl>
</li>
</ul>
<a name="removeProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeProperty</h4>
<pre>public java.lang.Object removeProperty(java.lang.String propName)</pre>
<div class="block">This removes the specified MDC property from the event.
Access to the MDC is not synchronized, so this
method should only be called when it is known that
no other threads are accessing the MDC.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>propName</code> - the property name to remove</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2.16</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/LoggingEvent.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"><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. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/log4j/spi/LoggerRepository.html" title="interface in org.apache.log4j.spi"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/apache/log4j/spi/NOPLogger.html" title="class in org.apache.log4j.spi"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/log4j/spi/LoggingEvent.html" target="_top">Frames</a></li>
<li><a href="LoggingEvent.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>
|