Package com.helger.commons.log

Class InMemoryLogger

java.lang.Object

com.helger.commons.log.InMemoryLogger

All Implemented Interfaces:

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

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

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

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
InMemoryLogger()

Method Summary

Modifier and Type	Method	Description
protected LogMessage	createLogMessage(IErrorLevel 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)
ICommonsList<LogMessage>	getAllMessages()
void	info(Serializable aMsg)
void	info(Serializable aMsg, Throwable t)
boolean	isEmpty()
Iterator<LogMessage>	iterator()
void	log(IErrorLevel eErrorLevel, Serializable aMsg)
void	log(IErrorLevel eErrorLevel, Serializable aMsg, Throwable t)
protected void	onAddLogMessage(LogMessage aLogMessage)	Callback method that is invoked after a message was added.
EChange	removeAll()	Reset the contents of the element to the after-construction state.
int	size()
void	success(Serializable aMsg)
void	success(Serializable aMsg, Throwable t)
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

Methods inherited from interface com.helger.commons.collection.impl.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstIndex, findFirstMapped, findFirstMapped, findLastIndex, forEachBreakable, forEachByIndex, forEachThrowing, getCount, getCount

Methods inherited from interface com.helger.commons.error.level.IHasErrorLevels

containsAtLeastOneError, containsAtLeastOneFailure, containsAtLeastOneSuccess, containsAtLeastOneWarningOrError, containsNoError, containsNoFailure, containsNoSuccess, containsOnlyError, containsOnlyFailure, containsOnlySuccess, getErrorCount, getFailureCount, getMostSevereErrorLevel, getSuccessCount

Methods inherited from interface com.helger.commons.lang.IHasSize

isNotEmpty

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

InMemoryLogger

public InMemoryLogger()

Method Detail

createLogMessage

@Nullable
@OverrideOnDemand
protected LogMessage createLogMessage(@Nonnull
                                      IErrorLevel 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
                IErrorLevel eErrorLevel,
                @Nonnull
                Serializable aMsg)

log

public void log(@Nonnull
                IErrorLevel 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)

info

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

success

public void success(@Nonnull
                    Serializable aMsg)

success

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

getAllMessages

@Nonnull
@ReturnsMutableCopy
public ICommonsList<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(), IHasSize.isNotEmpty()

removeAll

@Nonnull
public EChange removeAll()

Description copied from interface: IClearable

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

Specified by:

removeAll 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