net.minecrell.terminalconsole

Class HighlightErrorConverter

java.lang.Object

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

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

net.minecrell.terminalconsole.HighlightErrorConverter

All Implemented Interfaces:

org.apache.logging.log4j.core.pattern.PatternConverter

@Plugin(name="highlightError",
        category="Converter")
public final class HighlightErrorConverter
extends org.apache.logging.log4j.core.pattern.LogEventPatternConverter

A simplified version of HighlightConverter that uses TerminalConsoleAppender to detect if Ansi escape codes can be used to highlight errors and warnings in the console.

If configured, it will mark all logged errors with a red color and all warnings with a yellow color. It can be only used together with TerminalConsoleAppender.

TerminalConsoleAppender.ANSI_OVERRIDE_PROPERTY may be used to force the use of ANSI colors even in unsupported environments.

Example usage: %highlightError{%level: %message}

Field Summary

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 and Description
protected	HighlightErrorConverter(java.util.List<org.apache.logging.log4j.core.pattern.PatternFormatter> formatters) Construct the converter.

Method Summary

Modifier and Type	Method and Description
void	format(org.apache.logging.log4j.core.LogEvent event, java.lang.StringBuilder toAppendTo)
boolean	handlesThrowable()
static @Nullable HighlightErrorConverter	newInstance(org.apache.logging.log4j.core.config.Configuration config, java.lang.String[] options) Gets a new instance of the HighlightErrorConverter with the specified options.

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

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

Constructor Detail

HighlightErrorConverter

protected HighlightErrorConverter(java.util.List<org.apache.logging.log4j.core.pattern.PatternFormatter> formatters)

Construct the converter.

Parameters:

formatters - The pattern formatters to generate the text to highlight

Method Detail

format

public void format(org.apache.logging.log4j.core.LogEvent event,
                   java.lang.StringBuilder toAppendTo)

Specified by:

format in class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

handlesThrowable

public boolean handlesThrowable()

Overrides:

handlesThrowable in class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

newInstance

public static @Nullable HighlightErrorConverter newInstance(org.apache.logging.log4j.core.config.Configuration config,
                                                            java.lang.String[] options)

Gets a new instance of the HighlightErrorConverter with the specified options.

Parameters:

config - The current configuration

options - The pattern options

Returns:

The new instance