Class 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.
    • Field Detail

      • timeStamp

        public final long timeStamp
        The number of milliseconds elapsed from 1/1/1970 until logging event was created.
    • Constructor Detail

      • LoggingEvent

        public LoggingEvent()
        Constructs a new instance.
      • LoggingEvent

        public LoggingEvent​(String fqnOfCategoryClass,
                            Category logger,
                            long timeStamp,
                            Level level,
                            Object message,
                            String threadName,
                            ThrowableInformation throwable,
                            String ndc,
                            LocationInfo info,
                            Map properties)
        Create new instance.
        Parameters:
        fqnOfCategoryClass - Fully qualified class name of Logger implementation.
        logger - The logger generating this event.
        timeStamp - the timestamp of this logging event
        level - The level of this event.
        message - The message of this event.
        threadName - thread name
        throwable - The throwable of this event.
        ndc - Nested diagnostic context
        info - Location info
        properties - MDC properties
        Since:
        1.2.15
      • LoggingEvent

        public LoggingEvent​(String fqnOfCategoryClass,
                            Category logger,
                            long timeStamp,
                            Priority level,
                            Object message,
                            Throwable throwable)
        Instantiate a LoggingEvent from the supplied parameters.

        Except timeStamp all the other fields of LoggingEvent are filled when actually needed.

        Parameters:
        logger - The logger generating this event.
        timeStamp - the timestamp of this logging event
        level - The level of this event.
        message - The message of this event.
        throwable - The throwable of this event.
      • LoggingEvent

        public LoggingEvent​(String fqnOfCategoryClass,
                            Category logger,
                            Priority level,
                            Object message,
                            Throwable throwable)
        Instantiate a LoggingEvent from the supplied parameters.

        Except timeStamp all the other fields of LoggingEvent are filled when actually needed.

        Parameters:
        logger - The logger generating this event.
        level - The level of this event.
        message - The message of this event.
        throwable - The throwable of this event.
    • Method Detail

      • getStartTime

        public static long getStartTime()
        Returns the time when the application started, in milliseconds elapsed since 01.01.1970.
        Returns:
        the JVM start time.
      • getFQNOfLoggerClass

        public String getFQNOfLoggerClass()
      • getLevel

        public Level getLevel()
        Return the level of this event. Use this form instead of directly accessing the level field.
        Returns:
        Always returns null.
      • getLocationInformation

        public LocationInfo getLocationInformation()
        Set the location information for this logging event. The collected information is cached for future use.
        Returns:
        Always returns null.
      • getLogger

        public Category getLogger()
        Gets the logger of the event. Use should be restricted to cloning events.
        Returns:
        Always returns null.
        Since:
        1.2.15
      • getLoggerName

        public String getLoggerName()
        Return the name of the logger. Use this form instead of directly accessing the categoryName field.
        Returns:
        Always returns null.
      • getMDCCopy

        public void getMDCCopy()
        Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.
      • 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.

        Returns:
        Always returns null.
        Since:
        1.1
      • getNDC

        public String getNDC()
      • getProperties

        public Map getProperties()
      • getPropertyKeySet

        public Set getPropertyKeySet()
      • getRenderedMessage

        public String getRenderedMessage()
      • 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.

        Returns:
        Always returns null.
        Since:
        1.1
      • getThrowableStrRep

        public String[] getThrowableStrRep()
        Return this event's throwable's string[] representaion.
        Returns:
        Always returns null.
      • getTimeStamp

        public long getTimeStamp()
      • removeProperty

        public Object removeProperty​(String propName)
      • setProperty

        public void setProperty​(String propName,
                                String propValue)