org.apache.logging.log4j.core.pattern

Class RegexReplacementConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.RegexReplacementConverter

All Implemented Interfaces:

PatternConverter

@Plugin(name="replace",
        category="Converter")
public final class RegexReplacementConverter
extends LogEventPatternConverter

Replacement pattern converter.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<PatternFormatter>	formatters
private java.util.regex.Pattern	pattern
private java.lang.String	substitution

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
private	RegexReplacementConverter(java.util.List<PatternFormatter> formatters, java.util.regex.Pattern pattern, java.lang.String substitution) Construct the converter.

Method Summary

Modifier and Type	Method and Description
void	format(LogEvent event, java.lang.StringBuilder toAppendTo) Formats an event into a string buffer.
static RegexReplacementConverter	newInstance(Configuration config, java.lang.String[] options) Gets an instance of the class.

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

pattern

private final java.util.regex.Pattern pattern

substitution

private final java.lang.String substitution

formatters

private final java.util.List<PatternFormatter> formatters

Constructor Detail

RegexReplacementConverter

private RegexReplacementConverter(java.util.List<PatternFormatter> formatters,
                                  java.util.regex.Pattern pattern,
                                  java.lang.String substitution)

Construct the converter.

Parameters:

formatters - The PatternFormatters to generate the text to manipulate.

pattern - The regular expression Pattern.

substitution - The substitution string.

Method Detail

newInstance

public static RegexReplacementConverter newInstance(Configuration config,
                                                    java.lang.String[] options)

Gets an instance of the class.

Parameters:

config - The current Configuration.

options - pattern options, may be null. If first element is "short", only the first line of the throwable will be formatted.

Returns:

instance of class.

format

public void format(LogEvent event,
                   java.lang.StringBuilder toAppendTo)

Formats an event into a string buffer.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format, may not be null.

toAppendTo - string buffer to which the formatted event will be appended. May not be null.