net.pwall.log

Class AbstractFormatter

java.lang.Object

net.pwall.log.AbstractFormatter

All Implemented Interfaces:

LogFormatter

Direct Known Subclasses:

BasicFormatter

public abstract class AbstractFormatter
extends Object
implements LogFormatter

Abstract base Log Formatter. Includes static functions expected to be used by formatter classes.

Author:

Peter Wall

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANSI_FG_BLUE
static int	ANSI_FG_GREEN
static int	ANSI_FG_MAGENTA
static int	ANSI_FG_RED
static int	ANSI_FG_YELLOW

Constructor Summary

Constructors

Constructor and Description
AbstractFormatter()

Method Summary

Modifier and Type	Method and Description
static int	getDayMillis(long millis, ZoneId zoneId) Convert a time in epoch millis to millis from start of day (local time).
static void	outputANSIColour(int code, IntConsumer outFunction) Output an ANSI colour sequence.
static void	outputLevel(net.pwall.log.Level level, IntConsumer outFunction) Output the level.
static void	outputLevel5(net.pwall.log.Level level, IntConsumer outFunction) Output the level as 5 characters, using pre-configured colours and space padding where necessary.
static void	outputLevel5Coloured(net.pwall.log.Level level, IntConsumer outFunction) Output the level as 5 characters, using pre-configured colours and space padding where necessary.
static void	outputLevelColoured(net.pwall.log.Level level, IntConsumer outFunction) Output the level, using pre-configured colours.
static void	outputNameWithLimit(int limit, String name, IntConsumer outFunction) Output the logger name, with a limit on the width.
static void	outputText(CharSequence text, IntConsumer outFunction) Output text.
static void	outputTime(int dayMillis, IntConsumer outFunction) Output the time in the form hh:mm:ss.nnn, given a time as millisecond offset within a day.

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.LogFormatter

format

Field Detail

ANSI_FG_MAGENTA

public static final int ANSI_FG_MAGENTA

See Also:

Constant Field Values

ANSI_FG_BLUE

public static final int ANSI_FG_BLUE

See Also:

Constant Field Values

ANSI_FG_GREEN

public static final int ANSI_FG_GREEN

See Also:

Constant Field Values

ANSI_FG_YELLOW

public static final int ANSI_FG_YELLOW

See Also:

Constant Field Values

ANSI_FG_RED

public static final int ANSI_FG_RED

See Also:

Constant Field Values

Constructor Detail

AbstractFormatter

public AbstractFormatter()

Method Detail

outputTime

public static void outputTime(int dayMillis,
                              IntConsumer outFunction)

Output the time in the form hh:mm:ss.nnn, given a time as millisecond offset within a day. This approach minimises conversions to and from java.time classes.

Parameters:

dayMillis - the time as milliseconds in day

outFunction - the IntConsumer to use to output the value

outputLevel

public static void outputLevel(net.pwall.log.Level level,
                               IntConsumer outFunction)

Output the level.

Parameters:

level - the Level

outFunction - the IntConsumer to use to output the value

outputLevelColoured

public static void outputLevelColoured(net.pwall.log.Level level,
                                       IntConsumer outFunction)

Output the level, using pre-configured colours.

Parameters:

level - the Level

outFunction - the IntConsumer to use to output the value

outputLevel5

public static void outputLevel5(net.pwall.log.Level level,
                                IntConsumer outFunction)

Output the level as 5 characters, using pre-configured colours and space padding where necessary.

Parameters:

level - the Level

outFunction - the IntConsumer to use to output the value

outputLevel5Coloured

public static void outputLevel5Coloured(net.pwall.log.Level level,
                                        IntConsumer outFunction)

Output the level as 5 characters, using pre-configured colours and space padding where necessary.

Parameters:

level - the Level

outFunction - the IntConsumer to use to output the value

outputText

public static void outputText(CharSequence text,
                              IntConsumer outFunction)

Output text.

Parameters:

text - the text (as a CharSequence)

outFunction - the IntConsumer to use to output the text

outputNameWithLimit

public static void outputNameWithLimit(int limit,
                                       String name,
                                       IntConsumer outFunction)

Output the logger name, with a limit on the width.

Parameters:

limit - the maximum number of characters

name - the name

outFunction - the IntConsumer to use to output the name

outputANSIColour

public static void outputANSIColour(int code,
                                    IntConsumer outFunction)

Output an ANSI colour sequence.

Parameters:

code - the code in the ANSI sequence

outFunction - the IntConsumer to use to output the sequence

getDayMillis

public static int getDayMillis(long millis,
                               ZoneId zoneId)

Convert a time in epoch millis to millis from start of day (local time).

Parameters:

millis - the time in epoch millis

zoneId - the ZoneId

Returns:

the time in millis from start of day