com.phloc.commons.log

Class InMemoryLogger

java.lang.Object

com.phloc.commons.log.InMemoryLogger

All Implemented Interfaces:

IHasErrorLevels, IHasSize, IClearable, Serializable, Iterable<LogMessage>

@NotThreadSafe
public class InMemoryLogger
extends Object
implements Iterable<LogMessage>, IHasSize, IClearable, IHasErrorLevels, Serializable

Keeps a set of LogMessage objects in memory, offering an API similar to SLF4J.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InMemoryLogger()

Method Summary

Methods

Modifier and Type	Method and Description
EChange	clear() Reset the contents of the element to the after-construction state.
boolean	containsAtLeastOneError() Check if this group contains at least one error or fatal error message.
boolean	containsAtLeastOneFailure() Check if this group contains at least one failure message.
boolean	containsAtLeastOneSuccess() Check if this group contains at least one success message.
boolean	containsNoError() Check if this group contains no error or fatal error message.
boolean	containsNoFailure() Check if this group contains no failure message.
boolean	containsNoSuccess() Check if this group contains no success message.
boolean	containsOnlyError() Check if this group contains only error or fatal error messages.
boolean	containsOnlyFailure() Check if this group contains only failure messages.
boolean	containsOnlySuccess() Check if this group contains only success messages.
protected LogMessage	createLogMessage(EErrorLevel eErrorLevel, Serializable aMsg, Throwable t) Override this method to create a different LogMessage object or to filter certain log messages.
void	error(Serializable aMsg)
void	error(Serializable aMsg, Throwable t)
List<LogMessage>	getAllMessages()
int	getErrorCount()
int	getFailureCount()
EErrorLevel	getMostSevereErrorLevel() Get the most severe error level within this group.
int	getSuccessCount()
void	info(Serializable aMsg)
boolean	isEmpty()
Iterator<LogMessage>	iterator()
void	log(EErrorLevel eErrorLevel, Serializable aMsg)
void	log(EErrorLevel eErrorLevel, Serializable aMsg, Throwable t)
protected void	onAddLogMessage(LogMessage aLogMessage) Callback method that is invoked after a message was added.
int	size()
String	toString()
void	warn(Serializable aMsg)
void	warn(Serializable aMsg, Throwable t)

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryLogger

public InMemoryLogger()

Method Detail

createLogMessage

@Nullable
@OverrideOnDemand
protected LogMessage createLogMessage(@Nonnull
                                                    EErrorLevel eErrorLevel,
                                                    @Nonnull
                                                    Serializable aMsg,
                                                    @Nullable
                                                    Throwable t)

Override this method to create a different LogMessage object or to filter certain log messages.

Parameters:

eErrorLevel - Error level. Never null.

aMsg - The message object. Never null.

t - An optional exception. May be null.

Returns:

The returned value. May be null in which case the message will not be logged.

onAddLogMessage

@OverrideOnDemand
protected void onAddLogMessage(@Nonnull
                                    LogMessage aLogMessage)

Callback method that is invoked after a message was added.

Parameters:

aLogMessage - The added log message. Never null.

log

public void log(@Nonnull
       EErrorLevel eErrorLevel,
       @Nonnull
       Serializable aMsg)

log

public void log(@Nonnull
       EErrorLevel eErrorLevel,
       @Nonnull
       Serializable aMsg,
       @Nullable
       Throwable t)

error

public void error(@Nonnull
         Serializable aMsg)

error

public void error(@Nonnull
         Serializable aMsg,
         @Nullable
         Throwable t)

warn

public void warn(@Nonnull
        Serializable aMsg)

warn

public void warn(@Nonnull
        Serializable aMsg,
        @Nullable
        Throwable t)

info

public void info(@Nonnull
        Serializable aMsg)

getAllMessages

@Nonnull
@ReturnsMutableCopy
public List<LogMessage> getAllMessages()

iterator

@Nonnull
public Iterator<LogMessage> iterator()

Specified by:

iterator in interface Iterable<LogMessage>

size

@Nonnegative
public int size()

Specified by:

size in interface IHasSize

Returns:

The number of contained elements. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.size()

containsOnlySuccess

public boolean containsOnlySuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains only success messages. If no item is present, false is returned.

Specified by:

containsOnlySuccess in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have the error level success, false otherwise.

containsAtLeastOneSuccess

public boolean containsAtLeastOneSuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one success message.

Specified by:

containsAtLeastOneSuccess in interface IHasErrorLevels

Returns:

true if at least one success item is present, false otherwise.

containsNoSuccess

public boolean containsNoSuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains no success message.

Specified by:

containsNoSuccess in interface IHasErrorLevels

Returns:

true if no success item is present, false otherwise.

getSuccessCount

@Nonnegative
public int getSuccessCount()

Specified by:

getSuccessCount in interface IHasErrorLevels

Returns:

The number of contained success messages. Always ≥ 0.

containsOnlyFailure

public boolean containsOnlyFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains only failure messages. If no item is present, false is returned. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsOnlyFailure in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have an error level indicating failure, false otherwise.

containsAtLeastOneFailure

public boolean containsAtLeastOneFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one failure message. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsAtLeastOneFailure in interface IHasErrorLevels

Returns:

true if at least one failure item is present, false otherwise.

containsNoFailure

public boolean containsNoFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains no failure message. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsNoFailure in interface IHasErrorLevels

Returns:

true if no failure item is present, false otherwise.

getFailureCount

@Nonnegative
public int getFailureCount()

Specified by:

getFailureCount in interface IHasErrorLevels

Returns:

The number of contained failure messages. Always ≥ 0.

containsOnlyError

public boolean containsOnlyError()

Description copied from interface: IHasErrorLevels

Check if this group contains only error or fatal error messages. If no item is present, false is returned. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsOnlyError in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have an error level indicating error or fatal error, false otherwise.

containsAtLeastOneError

public boolean containsAtLeastOneError()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one error or fatal error message. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsAtLeastOneError in interface IHasErrorLevels

Returns:

true if at least one error or fatal error item is present, false otherwise.

containsNoError

public boolean containsNoError()

Description copied from interface: IHasErrorLevels

Check if this group contains no error or fatal error message. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsNoError in interface IHasErrorLevels

Returns:

true if no error or fatal error item is present, false otherwise.

getErrorCount

@Nonnegative
public int getErrorCount()

Specified by:

getErrorCount in interface IHasErrorLevels

Returns:

The number of contained error messages. Always ≥ 0. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

getMostSevereErrorLevel

@Nonnull
public EErrorLevel getMostSevereErrorLevel()

Description copied from interface: IHasErrorLevels

Get the most severe error level within this group.

Specified by:

getMostSevereErrorLevel in interface IHasErrorLevels

Returns:

EErrorLevel.SUCCESS if no resource error is contained, the most severe contained error level otherwise.

clear

@Nonnull
public EChange clear()

Description copied from interface: IClearable

Reset the contents of the element to the after-construction state.

Specified by:

clear in interface IClearable

Returns:

EChange.CHANGED if at least one element was cleared, EChange.UNCHANGED otherwise.

toString

public String toString()

Overrides:

toString in class Object