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 inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

LOGGER

Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

CATEGORY

Method Summary

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

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

format, handlesThrowable

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

Method Detail

newInstance

public static RegexReplacementConverter newInstance(Configuration config,
                                                    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,
                   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.