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

Class AbstractStyleNameConverter.White

java.lang.Object

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

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

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

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

All Implemented Interfaces:

PatternConverter

Enclosing class:

AbstractStyleNameConverter

@Plugin(name="white",
        category="Converter")
public static final class AbstractStyleNameConverter.White
extends AbstractStyleNameConverter

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.pattern.AbstractStyleNameConverter

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	NAME	White

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

Constructor	Description
White(List<PatternFormatter> formatters, String styling)	Constructs the converter.

Method Summary

Modifier and Type	Method	Description
static AbstractStyleNameConverter.White	newInstance(Configuration config, String[] options)	Gets an instance of the class (called via reflection).

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

getName, getStyleClass

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

format, newInstance

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

format, handlesThrowable, isVariable

Methods inherited from class java.lang.Object

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

Field Detail

NAME

protected static final String NAME

White

See Also:

Constant Field Values

Constructor Detail

White

public White(List<PatternFormatter> formatters,
             String styling)

Constructs the converter. This constructor must be public.

Parameters:

formatters - The PatternFormatters to generate the text to manipulate.

styling - The styling that should encapsulate the pattern.

Method Detail

newInstance

public static AbstractStyleNameConverter.White newInstance(Configuration config,
                                                           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