org.apache.logging.log4j.core.pattern

Class MapPatternConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.MapPatternConverter

All Implemented Interfaces:

PatternConverter

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

Able to handle the contents of the LogEvent's MapMessage and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the Map.

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 MapPatternConverter	newInstance(String[] options) Obtains an instance of MapPatternConverter.
static MapPatternConverter	newInstance(String[] options, org.apache.logging.log4j.message.MapMessage.MapFormat format) Obtain an instance of MapPatternConverter.

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

Method Detail

newInstance

public static MapPatternConverter newInstance(String[] options)

Obtains an instance of MapPatternConverter.

Parameters:

options - options, may be null or first element contains name of property to format.

Returns:

instance of MapPatternConverter.

newInstance

public static MapPatternConverter newInstance(String[] options,
                                              org.apache.logging.log4j.message.MapMessage.MapFormat format)

Obtain an instance of MapPatternConverter.

Parameters:

options - options, may be null or first element contains name of property to format.

format - the format to use if no options are given (i.e., options is null). Ignored if options is non-null.

Returns:

instance of MapPatternConverter.

Since:

2.11.2

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.