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
static final Map<String,String>	DefaultExceptionStyleMap

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getStyleMap()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DefaultExceptionStyleMap

public static final Map<String,String> DefaultExceptionStyleMap

Constructor Details

JAnsiTextRenderer

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

Method Details

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