Interface LogFormatter.LevelFormatter

All Superinterfaces:

LogFormatter

All Known Implementing Classes:

LogFormatter.NoopFormatter

Enclosing interface:

LogFormatter

public static sealed interface LogFormatter.LevelFormatter
extends LogFormatter
permits LogFormatter.NoopFormatter (not exhaustive)

Formats a System.Logger.Level.

Nested Class Summary

Nested classes/interfaces inherited from interface LogFormatter

LogFormatter.Builder, LogFormatter.EventFormatter, LogFormatter.KeyValueNullStrategy, LogFormatter.LevelFormatter, LogFormatter.NoopFormatter, LogFormatter.PostProcessor, LogFormatter.StandardPostProcessor, LogFormatter.StaticFormatter, LogFormatter.ThrowableFormatter, LogFormatter.TimestampFormatter

Modifier and Type	Interface	Description
static final class	LogFormatter.Builder	Log formatter builder that is composed of other formatters.
static interface	LogFormatter.EventFormatter	Generic event formatting that is lambda friendly.
static enum	LogFormatter.KeyValueNullStrategy	Controls how a null key value is written by key values formatters, see KeyValuesFormatterBuilder.nullStrategy(KeyValueNullStrategy).
static interface	LogFormatter.LevelFormatter	Formats a System.Logger.Level.
static enum	LogFormatter.NoopFormatter	A special formatter that will do nothing.
static interface	LogFormatter.PostProcessor	Rewrites the text a formatter has just written for an event, for example to prefix every line or to escape line breaks.
static enum	LogFormatter.StandardPostProcessor	The built in post processors, selected by their lowercase names.
static final record	LogFormatter.StaticFormatter	A special formatter that will append static text.
static interface	LogFormatter.ThrowableFormatter	Formats a throwable.
static interface	LogFormatter.TimestampFormatter	Formats event timestamps.

Method Summary

Modifier and Type	Method	Description
default void	format(StringBuilder output, LogEvent event)	Formats a log event.
void	formatLevel(StringBuilder output, System.Logger.Level level)	Formats the level.
default String	formatLevel(System.Logger.Level level)	Formats a level.
static LogFormatter.LevelFormatter	of()	Default implementation calls toString(Level)
static LogFormatter.LevelFormatter	ofRightPadded()	Default implementation calls rightPadded(Level)
static String	rightPadded(System.Logger.Level level)	Turns a Level into a SLF4J like level String that is all upper case and same length with right padding.
static String	toString(System.Logger.Level level)	Turns a Level into a SLF4J like level String that is all upper case.

Methods inherited from interface LogFormatter

isNoop

Modifier and Type	Method	Description
default boolean	isNoop()	Ask the formatter if will do anything.

Method Details

formatLevel

void formatLevel(StringBuilder output,
 System.Logger.Level level)

Formats the level.

Parameters:

output - buffer.

level - level.

format

default void format(StringBuilder output,
 LogEvent event)

Description copied from interface: LogFormatter

Formats a log event.

Specified by:

format in interface LogFormatter

Parameters:

output - buffer.

event - log event.

See Also:

• LogFormatter.EventFormatter

formatLevel

default String formatLevel(System.Logger.Level level)

Formats a level.

Parameters:

level - level

Returns:

formatted level as a string.

of

static LogFormatter.LevelFormatter of()

Default implementation calls toString(Level)

Returns:

formatter.

ofRightPadded

static LogFormatter.LevelFormatter ofRightPadded()

Default implementation calls rightPadded(Level)

Returns:

formatter.

toString

static String toString(System.Logger.Level level)

Turns a Level into a SLF4J like level String that is all upper case. System.Logger.Level.ALL is "TRACE", System.Logger.Level.OFF is "ERROR" and System.Logger.Level.WARNING is "WARN".

Parameters:

level - system logger level.

Returns:

upper case string of level.

rightPadded

static String rightPadded(System.Logger.Level level)

Turns a Level into a SLF4J like level String that is all upper case and same length with right padding. System.Logger.Level.ALL is "TRACE", System.Logger.Level.OFF is "ERROR" and System.Logger.Level.WARNING is "WARN".

Parameters:

level - system logger level.

Returns:

upper case string of level.