Method Detail

• getContextMap

  Map<String,String> getContextMap()

  Gets the context map (also know as Mapped Diagnostic Context or MDC).

  Returns:

  The context map, never null.

• getContextStack

  ThreadContext.ContextStack getContextStack()

  Gets the context stack (also known as Nested Diagnostic Context or NDC).

  Returns:

  The context stack, never null.

• getLoggerFqcn

  String getLoggerFqcn()

  Returns the fully qualified class name of the caller of the logging API.

  Returns:

  The fully qualified class name of the caller.

• getLevel

  Level getLevel()

  Gets the level.

  Returns:

  level.

• getLoggerName

  String getLoggerName()

  Gets the logger name.

  Returns:

  logger name, may be null.

• getMarker

  Marker getMarker()

  Gets the Marker associated with the event.

  Returns:

  Marker or null if no Marker was defined on this LogEvent

• getMessage

  Message getMessage()

  Gets the message associated with the event.

  Returns:

  message.

• getTimeMillis

  long getTimeMillis()

  Gets event time in milliseconds since midnight, January 1, 1970 UTC.

  Returns:

  milliseconds since midnight, January 1, 1970 UTC.

  See Also:

  System.currentTimeMillis()

• getSource

  StackTraceElement getSource()

  Gets the source of logging request.

  Returns:

  source of logging request, may be null.

• getThreadName

  String getThreadName()

  Gets the thread name.

  Returns:

  thread name, may be null. TODO guess this could go into a thread context object too. (RG) Why?

• getThreadId

  long getThreadId()

  Gets the thread ID.

  Returns:

  thread ID.

  Since:

  2.6

• getThreadPriority

  int getThreadPriority()

  Gets the thread priority.

  Returns:

  thread priority.

  Since:

  2.6

• getThrown

  Throwable getThrown()

  Gets throwable associated with logging request.

  Convenience method for ThrowableProxy.getThrowable();

  Returns:

  throwable, may be null.

• getThrownProxy

  ThrowableProxy getThrownProxy()

  Gets throwable proxy associated with logging request.

  Returns:

  throwable, may be null.

• isEndOfBatch

  boolean isEndOfBatch()

  Returns true if this event is the last one in a batch, false otherwise. Used by asynchronous Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient alternative to the immediateFlush=true configuration.

  Returns:

  whether this event is the last one in a batch.

• isIncludeLocation

  boolean isIncludeLocation()

  Returns whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take a StackTrace snapshot or not before handing off this event to another thread.

  Returns:

  true if the source of the logging request is required downstream, false otherwise.

  See Also:

  getSource()

• setEndOfBatch

  void setEndOfBatch(boolean endOfBatch)

  Sets whether this event is the last one in a batch. Used by asynchronous Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient alternative to the immediateFlush=true configuration.

  Parameters:

  endOfBatch - true if this event is the last one in a batch, false otherwise.

• setIncludeLocation

  void setIncludeLocation(boolean locationRequired)

  Sets whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use this flag to determine whether to take a StackTrace snapshot or not before handing off this event to another thread.

  Parameters:

  locationRequired - true if the source of the logging request is required downstream, false otherwise.

  See Also:

  getSource()

• getNanoTime

  long getNanoTime()

  Returns the value of the running Java Virtual Machine's high-resolution time source when this event was created, or a dummy value if it is known that this value will not be used downstream.

  Returns:

  The value of the running Java Virtual Machine's high-resolution time source when this event was created.

  Since:

  Log4J 2.4