net.minecrell.terminalconsole

Class MinecraftFormattingConverter

java.lang.Object

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

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

net.minecrell.terminalconsole.MinecraftFormattingConverter

All Implemented Interfaces:

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

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

Replaces Minecraft formatting codes in the result of a pattern with appropriate ANSI escape codes. The implementation will only replace valid color codes using the section sign (§).

The MinecraftFormattingConverter can be only used together with TerminalConsoleAppender to detect if the current console supports color output. When running in an unsupported environment, it will automatically strip all formatting codes instead.

TerminalConsoleAppender.ANSI_OVERRIDE_PROPERTY may be used to force the use of ANSI colors even in unsupported environments. As an alternative, KEEP_FORMATTING_PROPERTY may be used to keep the raw Minecraft formatting codes.

Example usage: %minecraftFormatting{%message}
It can be configured to always strip formatting codes from the message: %minecraftFormatting{%message}{strip}

See Also:

Formatting Codes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEEP_FORMATTING_PROPERTY System property that allows disabling the replacement of Minecraft formatting codes entirely, keeping them in the console output.

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	MinecraftFormattingConverter(java.util.List<org.apache.logging.log4j.core.pattern.PatternFormatter> formatters, boolean strip) Construct the converter.

Method Summary

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

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

format, handlesThrowable, 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

KEEP_FORMATTING_PROPERTY

public static final java.lang.String KEEP_FORMATTING_PROPERTY

System property that allows disabling the replacement of Minecraft formatting codes entirely, keeping them in the console output. For some applications they might be easier and more accurate for parsing in applications like certain control panels.

If this system property is not set, or set to any value except true, all Minecraft formatting codes will be replaced or stripped from the console output.

See Also:

Constant Field Values

Constructor Detail

MinecraftFormattingConverter

protected MinecraftFormattingConverter(java.util.List<org.apache.logging.log4j.core.pattern.PatternFormatter> formatters,
                                       boolean strip)

Construct the converter.

Parameters:

formatters - The pattern formatters to generate the text to manipulate

strip - If true, the converter will strip all formatting codes

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

newInstance

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

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

Parameters:

config - The current configuration

options - The pattern options

Returns:

The new instance

See Also:

MinecraftFormattingConverter