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

Class JAnsiTextRenderer

java.lang.Object

org.apache.logging.log4j.core.pattern.JAnsiTextRenderer

All Implemented Interfaces:

TextRenderer

public final class JAnsiTextRenderer
extends Object
implements TextRenderer

Renders an input as ANSI escaped output.

Uses the JLine AnsiRenderer syntax to render a message into an ANSI escaped string.

The default syntax for embedded ANSI codes is:

   @|code(,code)* text|@
 

For example, to render the message "Hello" in green, use:

   @|green Hello|@
 

To render the message "Hello" in bold and red, use:

   @|bold,red Warning!|@
 

You can also define custom style names in the configuration with the syntax:

 %message{ansi}{StyleName=value(,value)*( StyleName=value(,value)*)*}%n
 

For example:

 %message{ansi}{WarningStyle=red,bold KeyStyle=white ValueStyle=blue}%n
 

The call site can look like this:

 logger.info("@|KeyStyle {}|@ = @|ValueStyle {}|@", entry.getKey(), entry.getValue());
 

Note: this class was originally copied and then heavily modified from JAnsi/JLine AnsiRenderer, licensed under an Apache Software License, version 2.0.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BEGIN_TOKEN
private final String	beginToken
private final int	beginTokenLen
private static final int	CSI_LENGTH
(package private) static final Map<String,String>	DEFAULT_MESSAGE_STYLE_MAP
static final Map<String,String>	DefaultExceptionStyleMap
private static final String	END_TOKEN
private final String	endToken
private final int	endTokenLen
private static final Logger	LOGGER
private static final Map<String,Map<String,String>>	PREFEDINED_STYLE_MAPS
private final Map<String,String>	styleMap

Constructor Summary

Constructors

Constructor	Description
JAnsiTextRenderer(String[] formats, Map<String,String> defaultStyleMap)

Method Summary

Modifier and Type	Method	Description
private static Map.Entry<String,String>	entry(String name, AnsiEscape... codes)
Map<String,String>	getStyleMap()
private static void	merge(String escapeSequence, StringBuilder output, boolean first)
private static <V> Map<String,V>	ofEntries(Map.Entry<String,V>... entries)
void	render(StringBuilder input, StringBuilder output)	Renders input text to an output.
void	render(String input, StringBuilder output, String styleName)	Renders input text to an output.
private void	render(String input, StringBuilder output, String... styleNames)	Renders the given input with the given names which can be ANSI code names or Log4j style names.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final Logger LOGGER

DefaultExceptionStyleMap

public static final Map<String,String> DefaultExceptionStyleMap

DEFAULT_MESSAGE_STYLE_MAP

static final Map<String,String> DEFAULT_MESSAGE_STYLE_MAP

PREFEDINED_STYLE_MAPS

private static final Map<String,Map<String,String>> PREFEDINED_STYLE_MAPS

BEGIN_TOKEN

private static final String BEGIN_TOKEN

See Also:

• Constant Field Values

END_TOKEN

private static final String END_TOKEN

See Also:

• Constant Field Values

CSI_LENGTH

private static final int CSI_LENGTH

See Also:

• Constant Field Values

beginToken

private final String beginToken

beginTokenLen

private final int beginTokenLen

endToken

private final String endToken

endTokenLen

private final int endTokenLen

styleMap

private final Map<String,String> styleMap

Constructor Details

JAnsiTextRenderer

public JAnsiTextRenderer(String[] formats,
 Map<String,String> defaultStyleMap)

Method Details

entry

private static Map.Entry<String,String> entry(String name,
 AnsiEscape... codes)

ofEntries

@SafeVarargs
private static <V> Map<String,V> ofEntries(Map.Entry<String,V>... entries)

render

private void render(String input,
 StringBuilder output,
 String... styleNames)

Renders the given input with the given names which can be ANSI code names or Log4j style names.

Parameters:

input - The input to render

styleNames - ANSI code names or Log4j style names.

merge

private static void merge(String escapeSequence,
 StringBuilder output,
 boolean first)

render

public void render(String input,
 StringBuilder output,
 String styleName)
            throws IllegalArgumentException

Description copied from interface: TextRenderer

Renders input text to an output.

Specified by:

render in interface TextRenderer

Parameters:

input - The input

output - The output

styleName - The style name to use to render the input on the output.

Throws:

IllegalArgumentException

render

public void render(StringBuilder input,
 StringBuilder output)
            throws IllegalArgumentException

Description copied from interface: TextRenderer

Renders input text to an output.

Specified by:

render in interface TextRenderer

Parameters:

input - The input

output - The output

Throws:

IllegalArgumentException

getStyleMap

public Map<String,String> getStyleMap()

toString

public String toString()

Overrides:

toString in class Object