org.apache.logging.log4j.core.pattern

Class RegexReplacement

java.lang.Object

org.apache.logging.log4j.core.pattern.RegexReplacement

@Plugin(name="replace",
        category="Core",
        printObject=true)
public final class RegexReplacement
extends java.lang.Object

Replace tokens in the LogEvent message.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	LOGGER
private java.util.regex.Pattern	pattern
private java.lang.String	substitution

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RegexReplacement(java.util.regex.Pattern pattern, java.lang.String substitution) Private constructor.

Method Summary

Modifier and Type	Method and Description
static RegexReplacement	createRegexReplacement(java.util.regex.Pattern regex, java.lang.String replacement) Create a RegexReplacement.
java.lang.String	format(java.lang.String msg) Perform the replacement.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

pattern

private final java.util.regex.Pattern pattern

substitution

private final java.lang.String substitution

Constructor Detail

RegexReplacement

private RegexReplacement(java.util.regex.Pattern pattern,
                         java.lang.String substitution)

Private constructor.

Parameters:

pattern - The Pattern.

substitution - The substitution String.

Method Detail

format

public java.lang.String format(java.lang.String msg)

Perform the replacement.

Parameters:

msg - The String to match against.

Returns:

the replacement String.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createRegexReplacement

@PluginFactory
public static RegexReplacement createRegexReplacement(@PluginAttribute(value="regex")
                                                                     java.util.regex.Pattern regex,
                                                                     @PluginAttribute(value="replacement")
                                                                     java.lang.String replacement)

Create a RegexReplacement.

Parameters:

regex - The regular expression to locate.

replacement - The replacement value.

Returns:

A RegexReplacement.