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 Modifier and Type Field Description private java.lang.String[]
format
Format to use when no key is provided.private static java.lang.String
JAVA_UNQUOTED
private java.lang.String
key
Name of property to output.-
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 Description private
MapPatternConverter(java.lang.String[] options, java.lang.String... format)
Private constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
format(LogEvent event, java.lang.StringBuilder toAppendTo)
Formats an event into a string buffer.static MapPatternConverter
newInstance(java.lang.String[] options)
Obtains an instance ofMapPatternConverter
.static MapPatternConverter
newInstance(java.lang.String[] options, MapMessage.MapFormat format)
Obtain an instance ofMapPatternConverter
.-
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
-
-
-
-
Field Detail
-
JAVA_UNQUOTED
private static final java.lang.String JAVA_UNQUOTED
-
key
private final java.lang.String key
Name of property to output.
-
format
private final java.lang.String[] format
Format to use when no key is provided.- Since:
- 2.11.2
- See Also:
MapMessage.MapFormat
-
-
Method Detail
-
newInstance
public static MapPatternConverter newInstance(java.lang.String[] options)
Obtains an instance ofMapPatternConverter
.- Parameters:
options
- options, may be null or first element contains name of property to format.- Returns:
- instance of
MapPatternConverter
.
-
newInstance
public static MapPatternConverter newInstance(java.lang.String[] options, MapMessage.MapFormat format)
Obtain an instance ofMapPatternConverter
.- 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, java.lang.StringBuilder toAppendTo)
Formats an event into a string buffer.- Specified by:
format
in classLogEventPatternConverter
- Parameters:
event
- event to format, may not be null.toAppendTo
- string buffer to which the formatted event will be appended. May not be null.
-
-