blob: 442e87d551f29d8b09c89500f95197232772e8fb [file] [log] [blame]
package org.apache.logging.log4j.core;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.message.Message;
import java.util.Map;
import java.util.Stack;
/**
*
*/
public interface LogEvent {
/**
* Get level.
* @return level.
*/
Level getLevel();
/**
* Get logger name.
* @return logger name, may be null.
*/
String getLoggerName();
/**
* Get source of logging request.
* @return source of logging request, may be null.
*/
StackTraceElement getSource();
/**
* Get the message associated with the event.
*
* @return message.
*/
Message getMessage();
/**
* Get the Marker associated with the event.
* @return Marker
*/
Marker getMarker();
/**
* Get thread name.
* @return thread name, may be null.
* @doubt guess this could go into a thread context object too.
* (RG) Why?
*/
String getThreadName();
/**
* Get event time in milliseconds since 1970.
* @return milliseconds since 1970.
*/
long getMillis();
/**
* Get throwable associated with logging request.
* @return throwable, may be null.
*/
Throwable getThrown();
/**
* Get the MDC data;
*
* @return A copy of the Mapped Diagnostic Context or null.
* @doubt as mentioned elsewhere, think MDC and NDC should be combined into a thread context object.
* (RG) Still to do.
*/
Map<String, Object> getContextMap();
/**
* Get the NDC data;
*
* @return A copy of the Nested Diagnostic Context of null;
* @doubt as mentioned elsewhere, think MDC and NDC should be combined into a thread context object.
* (RG) Still to do.
*/
Stack<String> getContextStack();
}