org.apache.log
Class LogEvent

java.lang.Object
  extended by org.apache.log.LogEvent
All Implemented Interfaces:
java.io.Serializable

public final class LogEvent
extends java.lang.Object
implements java.io.Serializable

This class encapsulates each individual log event. LogEvents usually originate at a Logger and are routed to LogTargets.

Author:
Avalon Development Team, Peter Donald
See Also:
Serialized Form

Field Summary
private  java.lang.String m_category
           
private  ContextMap m_contextMap
           
private  java.lang.String m_message
           
private  Priority m_priority
           
private  java.lang.Throwable m_throwable
           
private  long m_time
           
private static long START_TIME
           
 
Constructor Summary
LogEvent()
           
 
Method Summary
 java.lang.String getCategory()
          Get the category that LogEvent relates to.
 ContextMap getContextMap()
          Get ContextMap associated with LogEvent
 java.lang.String getMessage()
          Get the message associated with event.
 Priority getPriority()
          Get Priority for LogEvent.
 long getRelativeTime()
          Get the time of the log event relative to start of application.
 java.lang.Throwable getThrowable()
          Get throwabe instance associated with event.
 long getTime()
          Get the absolute time of the log event.
private  java.lang.Object readResolve()
          Helper method that replaces deserialized priority with correct singleton.
 void setCategory(java.lang.String category)
          Set the LogEvent category.
 void setContextMap(ContextMap contextMap)
          Set the ContextMap for this LogEvent.
 void setMessage(java.lang.String message)
          Set the message for LogEvent.
 void setPriority(Priority priority)
          Set the priority of LogEvent.
 void setThrowable(java.lang.Throwable throwable)
          Set the throwable for LogEvent.
 void setTime(long time)
          Set the absolute time of LogEvent.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

START_TIME

private static final long START_TIME

m_category

private java.lang.String m_category

m_message

private java.lang.String m_message

m_throwable

private java.lang.Throwable m_throwable

m_time

private long m_time

m_priority

private Priority m_priority

m_contextMap

private ContextMap m_contextMap
Constructor Detail

LogEvent

public LogEvent()
Method Detail

getPriority

public final Priority getPriority()
Get Priority for LogEvent.

Returns:
the LogEvent Priority

setPriority

public final void setPriority(Priority priority)
Set the priority of LogEvent.

Parameters:
priority - the new LogEvent priority

getContextMap

public final ContextMap getContextMap()
Get ContextMap associated with LogEvent

Returns:
the ContextMap

setContextMap

public final void setContextMap(ContextMap contextMap)
Set the ContextMap for this LogEvent.

Parameters:
contextMap - the context map

getCategory

public final java.lang.String getCategory()
Get the category that LogEvent relates to.

Returns:
the name of category

getMessage

public final java.lang.String getMessage()
Get the message associated with event.

Returns:
the message

getThrowable

public final java.lang.Throwable getThrowable()
Get throwabe instance associated with event.

Returns:
the Throwable

getTime

public final long getTime()
Get the absolute time of the log event.

Returns:
the absolute time

getRelativeTime

public final long getRelativeTime()
Get the time of the log event relative to start of application.

Returns:
the time

setCategory

public final void setCategory(java.lang.String category)
Set the LogEvent category.

Parameters:
category - the category

setMessage

public final void setMessage(java.lang.String message)
Set the message for LogEvent.

Parameters:
message - the message

setThrowable

public final void setThrowable(java.lang.Throwable throwable)
Set the throwable for LogEvent.

Parameters:
throwable - the instance of Throwable

setTime

public final void setTime(long time)
Set the absolute time of LogEvent.

Parameters:
time - the time

readResolve

private java.lang.Object readResolve()
                              throws java.io.ObjectStreamException
Helper method that replaces deserialized priority with correct singleton.

Returns:
the singleton version of object
Throws:
java.io.ObjectStreamException - if an error occurs