net.pwall.log

Class BasicFormatter

java.lang.Object

net.pwall.log.AbstractFormatter

net.pwall.log.BasicFormatter

All Implemented Interfaces:

LogFormatter

public class BasicFormatter
extends AbstractFormatter

A simple formatter for use with the FormattingLogger.

Author:

Peter Wall

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultNameLengthLimit Default length limit for display of logger name

Fields inherited from class net.pwall.log.AbstractFormatter

ANSI_FG_BLUE, ANSI_FG_GREEN, ANSI_FG_MAGENTA, ANSI_FG_RED, ANSI_FG_YELLOW

Constructor Summary

Constructors

Constructor and Description
BasicFormatter()

Method Summary

Modifier and Type	Method and Description
void	format(long millis, net.pwall.log.Logger logger, net.pwall.log.Level level, Object message, Throwable throwable, IntConsumer outFunction) Format a log message.
int	getNameLengthLimit() Get the length limit used for the output of the logger name.
boolean	isColouredLevel() Get the switch controlling use of colour for the display of Level.
void	setColouredLevel(boolean colouredLevel) Set the switch controlling use of colour for the display of Level.
void	setNameLengthLimit(int nameLengthLimit) Set the length limit used for the output of the logger name.

Methods inherited from class net.pwall.log.AbstractFormatter

getDayMillis, outputANSIColour, outputLevel, outputLevel5, outputLevel5Coloured, outputLevelColoured, outputNameWithLimit, outputText, outputTime

Methods inherited from class java.lang.Object

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

Field Detail

defaultNameLengthLimit

public static final int defaultNameLengthLimit

Default length limit for display of logger name

See Also:

Constant Field Values

Constructor Detail

BasicFormatter

public BasicFormatter()

Method Detail

format

public void format(long millis,
                   net.pwall.log.Logger logger,
                   net.pwall.log.Level level,
                   Object message,
                   Throwable throwable,
                   IntConsumer outFunction)

Format a log message.

Parameters:

millis - the time of the log message as milliseconds from the start of the epoch

logger - the Logger that originated the log event

level - the Level

message - the message

outFunction - the IntConsumer to use to output the message

throwable - an optional Throwable

getNameLengthLimit

public int getNameLengthLimit()

Get the length limit used for the output of the logger name.

Returns:

the length limit

setNameLengthLimit

public void setNameLengthLimit(int nameLengthLimit)

Set the length limit used for the output of the logger name. The lower limit for the length is 8.

Parameters:

nameLengthLimit - the new length limit

isColouredLevel

public boolean isColouredLevel()

Get the switch controlling use of colour for the display of Level.

Returns:

the switch controlling use of colour

setColouredLevel

public void setColouredLevel(boolean colouredLevel)

Set the switch controlling use of colour for the display of Level.

Parameters:

colouredLevel - the new switch value