Package org.apache.log4j.spi

Class LoggingEvent

java.lang.Object

org.apache.log4j.spi.LoggingEvent

Direct Known Subclasses:

LogEventAdapter

public class LoggingEvent
extends Object

No-op version of Log4j 1.2 LoggingEvent. This class is not directly used by Log4j 1.x clients but is used by the Log4j 2 LogEvent adapter to be compatible with Log4j 1.x components.

Constructor Summary

Constructors

Constructor	Description
LoggingEvent()

Method Summary

Modifier and Type	Method	Description
String	getFQNOfLoggerClass()
Level	getLevel()	Return the level of this event.
LocationInfo	getLocationInformation()	Set the location information for this logging event.
Category	getLogger()	Gets the logger of the event.
String	getLoggerName()	Return the name of the logger.
Object	getMDC(String key)
void	getMDCCopy()	Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.
Object	getMessage()	Return the message for this logging event.
String	getNDC()
Map	getProperties()
String	getProperty(String key)
Set	getPropertyKeySet()
String	getRenderedMessage()
static long	getStartTime()	Returns the time when the application started, in milliseconds elapsed since 01.01.1970.
String	getThreadName()
ThrowableInformation	getThrowableInformation()	Returns the throwable information contained within this event.
String[]	getThrowableStrRep()	Return this event's throwable's string[] representaion.
long	getTimeStamp()
Object	removeProperty(String propName)
void	setProperty(String propName, String propValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoggingEvent

public LoggingEvent()

Method Detail

getLocationInformation

public LocationInfo getLocationInformation()

Set the location information for this logging event. The collected information is cached for future use.

getLevel

public Level getLevel()

Return the level of this event. Use this form instead of directly accessing the level field.

getLoggerName

public String getLoggerName()

Return the name of the logger. Use this form instead of directly accessing the categoryName field.

getFQNOfLoggerClass

public String getFQNOfLoggerClass()

getTimeStamp

public final long getTimeStamp()

getLogger

public Category getLogger()

Gets the logger of the event. Use should be restricted to cloning events.

Since:

1.2.15

getMessage

public Object getMessage()

Return the message for this logging event.

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.

Since:

1.1

getNDC

public String getNDC()

getMDC

public Object getMDC(String key)

getMDCCopy

public void getMDCCopy()

Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.

getRenderedMessage

public String getRenderedMessage()

getStartTime

public static long getStartTime()

Returns the time when the application started, in milliseconds elapsed since 01.01.1970.

getThreadName

public String getThreadName()

getThrowableInformation

public ThrowableInformation getThrowableInformation()

Returns the throwable information contained within this event. May be null if there is no such information.

Note that the Throwable object contained within a ThrowableInformation does not survive serialization.

Since:

1.1

getThrowableStrRep

public String[] getThrowableStrRep()

Return this event's throwable's string[] representaion.

setProperty

public void setProperty(String propName,
                        String propValue)

getProperty

public String getProperty(String key)

getPropertyKeySet

public Set getPropertyKeySet()

getProperties

public Map getProperties()

removeProperty

public Object removeProperty(String propName)