Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.logging.log4j.core
Class AbstractLogEvent

    java.lang.Object
      org.apache.logging.log4j.core.AbstractLogEvent

All Implemented Interfaces:
  Serializable, LogEvent

    public abstract class AbstractLogEvent

extends Object
implements LogEvent

An abstract log event implementation with default values for all methods. The setters are no-ops.

See Also:
  Serialized Form

Constructor Summary
`AbstractLogEvent()`

Method Summary
`Map<String,String>` | `getContextMap()` Returns `Collections.emptyMap()`.
`org.apache.logging.log4j.ThreadContext.ContextStack` | `getContextStack()` Gets the context stack (also known as Nested Diagnostic Context or NDC).
`org.apache.logging.log4j.Level` | `getLevel()` Gets the level.
`String` | `getLoggerFqcn()` Returns the fully qualified class name of the caller of the logging API.
`String` | `getLoggerName()` Gets the logger name.
`org.apache.logging.log4j.Marker` | `getMarker()` Gets the Marker associated with the event.
`org.apache.logging.log4j.message.Message` | `getMessage()` Gets the message associated with the event.
`StackTraceElement` | `getSource()` Gets the source of logging request.
`String` | `getThreadName()` Gets thread name.
`Throwable` | `getThrown()` Gets throwable associated with logging request.
`ThrowableProxy` | `getThrownProxy()` Gets throwable proxy associated with logging request.
`long` | `getTimeMillis()` Gets event time in milliseconds since midnight, January 1, 1970 UTC.
`boolean` | `isEndOfBatch()` Returns `true` if this event is the last one in a batch, `false` otherwise.
`boolean` | `isIncludeLocation()` Returns whether the source of the logging request is required downstream.
`void` | `setEndOfBatch(boolean endOfBatch)` Sets whether this event is the last one in a batch.
`void` | `setIncludeLocation(boolean locationRequired)` Sets whether the source of the logging request is required downstream.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AbstractLogEvent

    public AbstractLogEvent()

Method Detail

### getContextMap

    public Map<String,String> getContextMap()

  Returns `Collections.emptyMap()`.

  Specified by:
    `getContextMap` in interface `LogEvent`
  Returns:
    The context map, never `null`.

### getContextStack

    public org.apache.logging.log4j.ThreadContext.ContextStack getContextStack()

  Description copied from interface: `LogEvent`
  Gets the context stack (also known as Nested Diagnostic Context or NDC).

  Specified by:
    `getContextStack` in interface `LogEvent`
  Returns:
    The context stack, never `null`.

### getLevel

    public org.apache.logging.log4j.Level getLevel()

  Description copied from interface: `LogEvent`
  Gets the level.

  Specified by:
    `getLevel` in interface `LogEvent`
  Returns:
    level.

### getLoggerFqcn

    public String getLoggerFqcn()

  Description copied from interface: `LogEvent`
  Returns the fully qualified class name of the caller of the logging API.

  Specified by:
    `getLoggerFqcn` in interface `LogEvent`
  Returns:
    The fully qualified class name of the caller.

### getLoggerName

    public String getLoggerName()

  Description copied from interface: `LogEvent`
  Gets the logger name.

  Specified by:
    `getLoggerName` in interface `LogEvent`
  Returns:
    logger name, may be `null`.

### getMarker

    public org.apache.logging.log4j.Marker getMarker()

  Description copied from interface: `LogEvent`
  Gets the Marker associated with the event.

  Specified by:
    `getMarker` in interface `LogEvent`
  Returns:
    Marker or `null` if no Marker was defined on this LogEvent

### getMessage

    public org.apache.logging.log4j.message.Message getMessage()

  Description copied from interface: `LogEvent`
  Gets the message associated with the event.

  Specified by:
    `getMessage` in interface `LogEvent`
  Returns:
    message.

### getSource

    public StackTraceElement getSource()

  Description copied from interface: `LogEvent`
  Gets the source of logging request.

  Specified by:
    `getSource` in interface `LogEvent`
  Returns:
    source of logging request, may be null.

### getThreadName

    public String getThreadName()

  Description copied from interface: `LogEvent`
  Gets thread name.

  Specified by:
    `getThreadName` in interface `LogEvent`
  Returns:
    thread name, may be null. TODO guess this could go into a thread context object too. (RG) Why?

### getThrown

    public Throwable getThrown()

  Description copied from interface: `LogEvent`
  Gets throwable associated with logging request.

  Convenience method for `ThrowableProxy.getThrowable();`

  Specified by:
    `getThrown` in interface `LogEvent`
  Returns:
    throwable, may be null.

### getThrownProxy

    public ThrowableProxy getThrownProxy()

  Description copied from interface: `LogEvent`
  Gets throwable proxy associated with logging request.

  Specified by:
    `getThrownProxy` in interface `LogEvent`
  Returns:
    throwable, may be null.

### getTimeMillis

    public long getTimeMillis()

  Description copied from interface: `LogEvent`
  Gets event time in milliseconds since midnight, January 1, 1970 UTC.

  Specified by:
    `getTimeMillis` in interface `LogEvent`
  Returns:
    milliseconds since midnight, January 1, 1970 UTC.
  See Also:
    `System.currentTimeMillis()`

### isEndOfBatch

    public boolean isEndOfBatch()

  Description copied from interface: `LogEvent`
  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.

  Specified by:
    `isEndOfBatch` in interface `LogEvent`
  Returns:
    whether this event is the last one in a batch.

### isIncludeLocation

    public boolean isIncludeLocation()

  Description copied from interface: `LogEvent`
  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.

  Specified by:
    `isIncludeLocation` in interface `LogEvent`
  Returns:
    `true` if the source of the logging request is required downstream, `false` otherwise.
  See Also:
    `LogEvent.getSource()`

### setEndOfBatch

    public void setEndOfBatch(boolean endOfBatch)

  Description copied from interface: `LogEvent`
  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.

  Specified by:
    `setEndOfBatch` in interface `LogEvent`
  Parameters:
    `endOfBatch` - `true` if this event is the last one in a batch, `false` otherwise.

### setIncludeLocation

    public void setIncludeLocation(boolean locationRequired)

  Description copied from interface: `LogEvent`
  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.

  Specified by:
    `setIncludeLocation` in interface `LogEvent`
  Parameters:
    `locationRequired` - `true` if the source of the logging request is required downstream, `false` otherwise.
  See Also:
    `LogEvent.getSource()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.