Package org.apache.logging.log4j.core.pattern

Class AbstractStyleNameConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter

All Implemented Interfaces:

PatternConverter

Direct Known Subclasses:

AbstractStyleNameConverter.Black, AbstractStyleNameConverter.Blue, AbstractStyleNameConverter.Cyan, AbstractStyleNameConverter.Green, AbstractStyleNameConverter.Magenta, AbstractStyleNameConverter.Red, AbstractStyleNameConverter.White, AbstractStyleNameConverter.Yellow

public abstract class AbstractStyleNameConverter
extends LogEventPatternConverter

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractStyleNameConverter.Black	Black style pattern converter.
static class	AbstractStyleNameConverter.Blue	Blue style pattern converter.
static class	AbstractStyleNameConverter.Cyan	Cyan style pattern converter.
static class	AbstractStyleNameConverter.Green	Green style pattern converter.
static class	AbstractStyleNameConverter.Magenta	Magenta style pattern converter.
static class	AbstractStyleNameConverter.Red	Red style pattern converter.
static class	AbstractStyleNameConverter.White	White style pattern converter.
static class	AbstractStyleNameConverter.Yellow	Yellow style pattern converter.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<PatternFormatter>	formatters
private java.lang.String	style

Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

LOGGER

Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

CATEGORY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStyleNameConverter(java.lang.String name, java.util.List<PatternFormatter> formatters, java.lang.String styling)	Constructs the converter.

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, java.lang.StringBuilder toAppendTo)	Formats an event into a string buffer.
boolean	handlesThrowable()	Tests whether this pattern converter is renders a Throwable.
protected static <T extends AbstractStyleNameConverter> T	newInstance(java.lang.Class<T> asnConverterClass, java.lang.String name, Configuration config, java.lang.String[] options)	Gets an instance of the class (called via reflection).
private static java.util.List<PatternFormatter>	toPatternFormatterList(Configuration config, java.lang.String[] options)	Creates a list of PatternFormatter from the given configuration and options or null if no pattern is supplied.

Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

emptyVariableOutput, format, isVariable

Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

getName, getStyleClass

Methods inherited from class java.lang.Object

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

Field Detail

formatters

private final java.util.List<PatternFormatter> formatters

style

private final java.lang.String style

Constructor Detail

AbstractStyleNameConverter

protected AbstractStyleNameConverter(java.lang.String name,
                                     java.util.List<PatternFormatter> formatters,
                                     java.lang.String styling)

Constructs the converter.

Parameters:

formatters - The PatternFormatters to generate the text to manipulate.

styling - The styling that should encapsulate the pattern.

Method Detail

newInstance

protected static <T extends AbstractStyleNameConverter> T newInstance(java.lang.Class<T> asnConverterClass,
                                                                      java.lang.String name,
                                                                      Configuration config,
                                                                      java.lang.String[] options)

Gets an instance of the class (called via reflection).

Parameters:

config - The current Configuration.

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

Returns:

new instance of class or null

toPatternFormatterList

private static java.util.List<PatternFormatter> toPatternFormatterList(Configuration config,
                                                                       java.lang.String[] options)

Creates a list of PatternFormatter from the given configuration and options or null if no pattern is supplied.

Parameters:

config - A configuration.

options - pattern options.

Returns:

a list of PatternFormatter from the given configuration and options or null if no pattern is supplied.

format

public void format(LogEvent event,
                   java.lang.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