net.pwall.log

Class AbstractLogger

java.lang.Object

net.pwall.log.AbstractLogger

All Implemented Interfaces:

net.pwall.log.Logger

Direct Known Subclasses:

ConsoleLogger, FormattingLogger, JavaLogger, Slf4jLogger

public abstract class AbstractLogger
extends Object
implements net.pwall.log.Logger

Abstract base class for Logger implementations.

Author:

Peter Wall

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLogger(String name, net.pwall.log.Level level, Clock clock) Construct an AbstractLogger with the supplied name, Level and Clock.

Method Summary

Modifier and Type	Method and Description
Clock	getClock() Get the Clock used by this AbstractLogger.
net.pwall.log.Level	getLevel() Get the minimum level to be output by this AbstractLogger.
String	getName() Get the name associated with this AbstractLogger.
protected static void	outputMultiLine(String message, Consumer<String> outputFunction) Split a line containing newline characters into separate log entries, so that malicious code can not create deceptive log lines.
void	setLevel(net.pwall.log.Level level) Set the minimum level to be output by this AbstractLogger.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.pwall.log.Logger

debug, debug, error, error, error, error, info, info, isDebugEnabled, isEnabled, isErrorEnabled, isInfoEnabled, isTraceEnabled, isWarnEnabled, log, log, setClock, trace, trace, warn, warn

Constructor Detail

AbstractLogger

protected AbstractLogger(String name,
                         net.pwall.log.Level level,
                         Clock clock)

Construct an AbstractLogger with the supplied name, Level and Clock.

Parameters:

name - the name

level - the Level

clock - the Clock

Method Detail

getName

public String getName()

Get the name associated with this AbstractLogger.

Specified by:

getName in interface net.pwall.log.Logger

Returns:

the name

getLevel

public net.pwall.log.Level getLevel()

Get the minimum level to be output by this AbstractLogger.

Specified by:

getLevel in interface net.pwall.log.Logger

Returns:

the Level

setLevel

public void setLevel(net.pwall.log.Level level)

Set the minimum level to be output by this AbstractLogger.

Specified by:

setLevel in interface net.pwall.log.Logger

Parameters:

level - the new Level

getClock

public Clock getClock()

Get the Clock used by this AbstractLogger.

Specified by:

getClock in interface net.pwall.log.Logger

Returns:

the Clock

outputMultiLine

protected static void outputMultiLine(String message,
                                      Consumer<String> outputFunction)

Split a line containing newline characters into separate log entries, so that malicious code can not create deceptive log lines.

Parameters:

message - the log message

outputFunction - an output function that takes a single line (which by now will not contain newline)