public class LoggingEvent
extends java.lang.Object
implements java.io.Serializable
LoggingEvent
instance
is created. This instance is passed around to the different log4j
components.
This class is of concern to those wishing to extend log4j.
Modifier and Type | Field and Description |
---|---|
java.lang.String |
categoryName
Deprecated.
This field will be marked as private in future
releases. Please do not access it directly. Use the
getLoggerName() method instead. |
java.lang.String |
fqnOfCategoryClass
Fully qualified name of the calling category class.
|
Priority |
level
Deprecated.
This field will be marked as private in future
releases. Please do not access it directly. Use the
getLevel() method instead. |
long |
timeStamp
The number of milliseconds elapsed from 1/1/1970 until logging event
was created.
|
Constructor and Description |
---|
LoggingEvent(java.lang.String fqnOfCategoryClass,
Category logger,
long timeStamp,
Priority level,
java.lang.Object message,
java.lang.Throwable throwable)
Instantiate a LoggingEvent from the supplied parameters.
|
LoggingEvent(java.lang.String fqnOfCategoryClass,
Category logger,
Priority level,
java.lang.Object message,
java.lang.Throwable throwable)
Instantiate a LoggingEvent from the supplied parameters.
|
Modifier and Type | Method and Description |
---|---|
Level |
getLevel()
Return the level of this event.
|
LocationInfo |
getLocationInformation()
Set the location information for this logging event.
|
java.lang.String |
getLoggerName()
Return the name of the logger.
|
java.lang.Object |
getMDC(java.lang.String key)
Returns the the context corresponding to the
key
parameter. |
void |
getMDCCopy()
Obtain a copy of this thread's MDC prior to serialization or
asynchronous logging.
|
java.lang.Object |
getMessage()
Return the message for this logging event.
|
java.lang.String |
getNDC()
This method returns the NDC for this event.
|
java.lang.String |
getRenderedMessage() |
static long |
getStartTime()
Returns the time when the application started, in milliseconds
elapsed since 01.01.1970.
|
java.lang.String |
getThreadName() |
ThrowableInformation |
getThrowableInformation()
Returns the throwable information contained within this
event.
|
java.lang.String[] |
getThrowableStrRep()
Return this event's throwable's string[] representaion.
|
public final transient java.lang.String fqnOfCategoryClass
public final java.lang.String categoryName
getLoggerName()
method instead.The category (logger) name.
public transient Priority level
getLevel()
method instead. This field should not be accessed directly. You shoud use the
getLevel()
method instead.
public final long timeStamp
public LoggingEvent(java.lang.String fqnOfCategoryClass, Category logger, Priority level, java.lang.Object message, java.lang.Throwable throwable)
Except timeStamp
all the other fields of
LoggingEvent
are filled when actually needed.
logger
- The logger generating this event.level
- The level of this event.message
- The message of this event.throwable
- The throwable of this event.public LoggingEvent(java.lang.String fqnOfCategoryClass, Category logger, long timeStamp, Priority level, java.lang.Object message, java.lang.Throwable throwable)
Except timeStamp
all the other fields of
LoggingEvent
are filled when actually needed.
logger
- The logger generating this event.timeStamp
- the timestamp of this logging eventlevel
- The level of this event.message
- The message of this event.throwable
- The throwable of this event.public LocationInfo getLocationInformation()
public Level getLevel()
level
field.public java.lang.String getLoggerName()
categoryName
field.public java.lang.Object getMessage()
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.
public java.lang.String getNDC()
NDC.get()
method
should never be called directly.public java.lang.Object getMDC(java.lang.String key)
key
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 MDC
is used.
Note that both the local MDC copy and the current thread's MDC are searched.
public void getMDCCopy()
public java.lang.String getRenderedMessage()
public static long getStartTime()
public java.lang.String getThreadName()
public ThrowableInformation getThrowableInformation()
null
if there is no such information.
Note that the Throwable
object contained within a
ThrowableInformation
does not survive serialization.
public java.lang.String[] getThrowableStrRep()
Copyright 2000-2005 Apache Software Foundation.