Class LogEvent

java.lang.Object
org.apache.log.LogEvent
All Implemented Interfaces:
Serializable
public final class LogEvent extends Object implements 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:

  • Field Details

    • START_TIME

      private static final long START_TIME

    • m_category

      private String m_category
      The category that this LogEvent concerns. (Must not be null)

    • m_message

      private String m_message
      The message to be logged. (Must not be null)

    • m_throwable

      private Throwable m_throwable
      The exception that caused LogEvent if any. (May be null)

    • m_time

      private long m_time
      The time in millis that LogEvent occurred

    • m_priority

      private Priority m_priority
      The priority of LogEvent. (Must not be null)

    • m_contextMap

      private ContextMap m_contextMap
      The context map associated with LogEvent. (May be null).

  • Constructor Details

    • LogEvent

      public LogEvent()

  • Method Details

    • 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 String getCategory()
      Get the category that LogEvent relates to.
      Returns:
      the name of category

    • getMessage

      public final String getMessage()
      Get the message associated with event.
      Returns:
      the message

    • getThrowable

      public final 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(String category)
      Set the LogEvent category.
      Parameters:
      category - the category

    • setMessage

      public final void setMessage(String message)
      Set the message for LogEvent.
      Parameters:
      message - the message

    • setThrowable

      public final void setThrowable(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 Object readResolve() throws ObjectStreamException
      Helper method that replaces deserialized priority with correct singleton.
      Returns:
      the singleton version of object
      Throws:
      ObjectStreamException - if an error occurs