com.phloc.commons.log

Class LogMessage

java.lang.Object

com.phloc.commons.log.LogMessage

All Implemented Interfaces:

IHasErrorLevel, ISeverityComparable<LogMessage>, IErrorIndicator, ISuccessIndicator, Serializable

@Immutable
public class LogMessage
extends Object
implements IHasErrorLevel, ISuccessIndicator, IErrorIndicator, ISeverityComparable<LogMessage>, Serializable

Represents a single log message.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LogMessage(EErrorLevel eLevel, Serializable aMsg, Throwable aThrowable)

Method Summary

Methods

Modifier and Type	Method and Description
EErrorLevel	getErrorLevel()
Date	getIssueDateTime()
Serializable	getMessage()
Throwable	getThrowable()
boolean	isEqualSevereThan(LogMessage aOther) Check if this object is of the same level (= equal important) than the passed object.
boolean	isError()
boolean	isFailure()
boolean	isLessOrEqualSevereThan(LogMessage aOther) Check if this object is of equal or lower level (= equally or less important) than the passed object.
boolean	isLessSevereThan(LogMessage aOther) Check if this object is of lower level (= less important) than the passed object.
boolean	isMoreOrEqualSevereThan(LogMessage aOther) Check if this object is of equal or higher level (= equally or more important) than the passed object.
boolean	isMoreSevereThan(LogMessage aOther) Check if this object is of higher level (= more important) than the passed object.
boolean	isNoError()
boolean	isSuccess()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LogMessage

public LogMessage(@Nonnull
          EErrorLevel eLevel,
          @Nonnull
          Serializable aMsg,
          @Nullable
          Throwable aThrowable)

Method Detail

getIssueDateTime

@Nonnull
@ReturnsMutableCopy
public Date getIssueDateTime()

getErrorLevel

@Nonnull
public EErrorLevel getErrorLevel()

Specified by:

getErrorLevel in interface IHasErrorLevel

Returns:

The error level of this object. May not be null.

getMessage

@Nonnull
public Serializable getMessage()

getThrowable

@Nullable
public Throwable getThrowable()

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true on success and false on failure.

isFailure

public boolean isFailure()

Specified by:

isFailure in interface ISuccessIndicator

Returns:

true on failure and false on success.

isError

public boolean isError()

Specified by:

isError in interface IErrorIndicator

Returns:

true if this level is at least EErrorLevel.ERROR or worse.

isNoError

public boolean isNoError()

Specified by:

isNoError in interface IErrorIndicator

Returns:

true if this level is below EErrorLevel.ERROR.

isEqualSevereThan

public boolean isEqualSevereThan(@Nonnull
                        LogMessage aOther)

Description copied from interface: ISeverityComparable

Check if this object is of the same level (= equal important) than the passed object.

Specified by:

isEqualSevereThan in interface ISeverityComparable<LogMessage>

Parameters:

aOther - The object to compare to.

Returns:

true if this object is equally important than the passed object!

isLessSevereThan

public boolean isLessSevereThan(@Nonnull
                       LogMessage aOther)

Description copied from interface: ISeverityComparable

Check if this object is of lower level (= less important) than the passed object.

Specified by:

isLessSevereThan in interface ISeverityComparable<LogMessage>

Parameters:

aOther - The object to compare to.

Returns:

true if this object is less important than the passed object!

isLessOrEqualSevereThan

public boolean isLessOrEqualSevereThan(@Nonnull
                              LogMessage aOther)

Description copied from interface: ISeverityComparable

Check if this object is of equal or lower level (= equally or less important) than the passed object.

Specified by:

isLessOrEqualSevereThan in interface ISeverityComparable<LogMessage>

Parameters:

aOther - The object to compare to.

Returns:

true if this object is equally or less important than the passed object!

isMoreSevereThan

public boolean isMoreSevereThan(@Nonnull
                       LogMessage aOther)

Description copied from interface: ISeverityComparable

Check if this object is of higher level (= more important) than the passed object.

Specified by:

isMoreSevereThan in interface ISeverityComparable<LogMessage>

Parameters:

aOther - The object to compare to.

Returns:

true if this object is more important than the passed object!

isMoreOrEqualSevereThan

public boolean isMoreOrEqualSevereThan(@Nonnull
                              LogMessage aOther)

Description copied from interface: ISeverityComparable

Check if this object is of equal or higher level (= equally or more important) than the passed object.

Specified by:

isMoreOrEqualSevereThan in interface ISeverityComparable<LogMessage>

Parameters:

aOther - The object to compare to.

Returns:

true if this object is equally or more important than the passed object!

toString

public String toString()

Overrides:

toString in class Object