org.xwiki.logging.event

Class LogEvent

java.lang.Object

org.xwiki.logging.event.LogEvent

All Implemented Interfaces:

Serializable, Event

Direct Known Subclasses:

BeginLogEvent, EndLogEvent

public class LogEvent
extends Object
implements Event, Serializable

Sent when logger is called.

The event also send the following parameters:

• source: the name of the associated logger
• data: null

Since:

3.2M1

Version:

$Id: aecf3a6c98b8d7cd4244b3d8900e3c319cf92903 $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Marker	MARKER_BEGIN The marker to use to indicate that we start a group of logs.
static org.slf4j.Marker	MARKER_END The marker to use to indicate that we stop a group of logs.

Constructor Summary

Constructors

Constructor and Description
LogEvent() Matches any LogEvent.
LogEvent(LogEvent logEvent)
LogEvent(LogLevel level, String message, Object[] argumentArray, Throwable throwable)
LogEvent(org.slf4j.Marker marker, LogLevel level, String message, Object[] argumentArray, Throwable throwable)
LogEvent(org.slf4j.Marker marker, LogLevel level, String message, Object[] argumentArray, Throwable throwable, long timeStamp)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
Object[]	getArgumentArray()
String	getFormattedMessage()
LogLevel	getLevel()
org.slf4j.Marker	getMarker()
String	getMessage()
List<String>	getMessageElements()
Throwable	getThrowable()
long	getTimeStamp()
String	getTranslationKey()
int	hashCode()
void	log(org.slf4j.Logger targetLogger) Copy the stored log into a passed Logger.
boolean	matches(Object otherEvent)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MARKER_BEGIN

public static final org.slf4j.Marker MARKER_BEGIN

The marker to use to indicate that we start a group of logs.

MARKER_END

public static final org.slf4j.Marker MARKER_END

The marker to use to indicate that we stop a group of logs.

Constructor Detail

LogEvent

public LogEvent()

Matches any LogEvent.

LogEvent

public LogEvent(LogEvent logEvent)

Parameters:

logEvent - the log event to copy

Since:

5.4M1

LogEvent

public LogEvent(LogLevel level,
        String message,
        Object[] argumentArray,
        Throwable throwable)

Parameters:

level - the log level

message - the log message

argumentArray - the event arguments to insert in the message

throwable - the throwable associated to the event

LogEvent

public LogEvent(org.slf4j.Marker marker,
        LogLevel level,
        String message,
        Object[] argumentArray,
        Throwable throwable)

Parameters:

marker - the log marker

level - the log level

message - the log message

argumentArray - the event arguments to insert in the message

throwable - the throwable associated to the event

Since:

4.3M

LogEvent

public LogEvent(org.slf4j.Marker marker,
        LogLevel level,
        String message,
        Object[] argumentArray,
        Throwable throwable,
        long timeStamp)

Parameters:

marker - the log marker

level - the log level

message - the log message

argumentArray - the event arguments to insert in the message

throwable - the throwable associated to the event

timeStamp - the number of milliseconds elapsed from 1/1/1970 until logging event was created.

Since:

6.4M1

Method Detail

log

public void log(org.slf4j.Logger targetLogger)

Copy the stored log into a passed Logger.

Parameters:

targetLogger - the logger where to copy the stored log

Since:

5.3M1

getMarker

public org.slf4j.Marker getMarker()

Returns:

the log marker

Since:

4.3M1

getLevel

public LogLevel getLevel()

Returns:

the log level

getMessage

public String getMessage()

Returns:

the log message

getArgumentArray

public Object[] getArgumentArray()

Returns:

the event arguments to insert in the message

getThrowable

public Throwable getThrowable()

Returns:

the throwable associated to the event

getTimeStamp

public long getTimeStamp()

Returns:

the number of milliseconds elapsed from 1/1/1970 until logging event was created

getFormattedMessage

public String getFormattedMessage()

Returns:

the formated version of the message

getMessageElements

public List<String> getMessageElements()

Returns:

the log message cut in peaces

Since:

4.2M1

getTranslationKey

public String getTranslationKey()

Returns:

the translation key associated to the log

Since:

5.0M2

matches

public boolean matches(Object otherEvent)

Specified by:

matches in interface Event

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object