Class StyleConverter

java.lang.Object

org.apache.logging.log4j.core.pattern.AbstractPatternConverter

org.apache.logging.log4j.core.pattern.LogEventPatternConverter

org.apache.logging.log4j.core.pattern.StyleConverter

All Implemented Interfaces:

AnsiConverter, PatternConverter

@Plugin(name="style",
        category="Converter")
public final class StyleConverter
extends LogEventPatternConverter
implements AnsiConverter

Style pattern converter. Adds ANSI color styling to the result of the enclosed pattern.

To disable ANSI output unconditionally, specify an additional option disableAnsi=true, or to disable ANSI output if no console is detected, specify option noConsoleNoAnsi=true.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	defaultStyle
private final boolean	noAnsi
private final List<PatternFormatter>	patternFormatters
private final String	style

Fields inherited from class AbstractPatternConverter

LOGGER

Fields inherited from interface PatternConverter

CATEGORY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StyleConverter(List<PatternFormatter> patternFormatters, String style, boolean noAnsi)	Constructs the converter.

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, StringBuilder toAppendTo)	Formats an event into a string buffer.
boolean	handlesThrowable()	Tests whether this pattern converter is renders a Throwable.
static StyleConverter	newInstance(Configuration config, String[] options)	Gets an instance of the class.
String	toString()	Returns a String suitable for debugging.

Methods inherited from class LogEventPatternConverter

emptyVariableOutput, format, isVariable

Methods inherited from class AbstractPatternConverter

getName, getStyleClass

Methods inherited from class Object

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

Field Details

patternFormatters

private final List<PatternFormatter> patternFormatters

noAnsi

private final boolean noAnsi

style

private final String style

defaultStyle

private final String defaultStyle

Constructor Details

StyleConverter

private StyleConverter(List<PatternFormatter> patternFormatters,
 String style,
 boolean noAnsi)

Constructs the converter.

Parameters:

patternFormatters - The PatternFormatters to generate the text to manipulate.

style - The style that should encapsulate the pattern.

noAnsi - If true, do not output ANSI escape codes.

Method Details

newInstance

public static StyleConverter newInstance(Configuration config,
 String[] options)

Gets an instance of the class.

Parameters:

config - The current Configuration.

options - pattern options, may be null. If first element is "short", only the first line of the throwable will be formatted.

Returns:

instance of class.

format

public void format(LogEvent event,
 StringBuilder toAppendTo)

Formats an event into a string buffer.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format, may not be null.

toAppendTo - string buffer to which the formatted event will be appended. May not be null.

handlesThrowable

public boolean handlesThrowable()

Description copied from class: LogEventPatternConverter

Tests whether this pattern converter is renders a Throwable.

The PatternParser checks this flag when processing the alwaysWriteExceptions option: if no converter in the pattern handles throwables, the parser automatically appends a converter to ensure exceptions are still written.

Overrides:

handlesThrowable in class LogEventPatternConverter

Returns:

true if this converter consumes and renders a Throwable, false otherwise

toString

public String toString()

Returns a String suitable for debugging.

Overrides:

toString in class Object

Returns:

a String suitable for debugging.