Package 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 Object

Replace tokens in the LogEvent message.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

format

public String format(String msg)

Perform the replacement.

Parameters:

msg - The String to match against.

Returns:

the replacement String.

toString

public String toString()

Overrides:

toString in class Object

createRegexReplacement

@PluginFactory
public static RegexReplacement createRegexReplacement(@PluginAttribute("regex")
                                                      Pattern regex,
                                                      @PluginAttribute("replacement")
                                                      String replacement)

Create a RegexReplacement.

Parameters:

regex - The regular expression to locate.

replacement - The replacement value.

Returns:

the new RegexReplacement instance or null if an input parameter was invalid