Package org.apache.logging.log4j.core.pattern

Class EncodingPatternConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.EncodingPatternConverter

All Implemented Interfaces:

PatternConverter

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

Converter that encodes the output from a pattern using a specified format. Supported formats include HTML (default) and JSON.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	EncodingPatternConverter.EscapeFormat

Field Summary

Fields

Modifier and Type	Field	Description
private EncodingPatternConverter.EscapeFormat	escapeFormat
private java.util.List<PatternFormatter>	formatters

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	EncodingPatternConverter(java.util.List<PatternFormatter> formatters, EncodingPatternConverter.EscapeFormat escapeFormat)	Private constructor.

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, java.lang.StringBuilder toAppendTo)	Formats an event into a string buffer.
boolean	handlesThrowable()	Normally pattern converters are not meant to handle Exceptions although few pattern converters might.
static EncodingPatternConverter	newInstance(Configuration config, java.lang.String[] options)	Creates an EncodingPatternConverter using a pattern string and an optional escape format.

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

format, 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

Field Detail

formatters

private final java.util.List<PatternFormatter> formatters

escapeFormat

private final EncodingPatternConverter.EscapeFormat escapeFormat

Constructor Detail

EncodingPatternConverter

private EncodingPatternConverter(java.util.List<PatternFormatter> formatters,
                                 EncodingPatternConverter.EscapeFormat escapeFormat)

Private constructor.

Parameters:

formatters - the PatternFormatters to generate the text to manipulate.

escapeFormat - the escape format strategy to use for encoding output of formatters

Method Detail

handlesThrowable

public boolean handlesThrowable()

Description copied from class: LogEventPatternConverter

Normally pattern converters are not meant to handle Exceptions although few pattern converters might.

By examining the return values for this method, the containing layout will determine whether it handles throwables or not.

Overrides:

handlesThrowable in class LogEventPatternConverter

Returns:

true if this PatternConverter handles throwables

newInstance

public static EncodingPatternConverter newInstance(Configuration config,
                                                   java.lang.String[] options)

Creates an EncodingPatternConverter using a pattern string and an optional escape format.

Parameters:

config - the current Configuration

options - first option is the nested pattern format; second option is the escape format (optional)

Returns:

instance of pattern converter.

format

public void format(LogEvent event,
                   java.lang.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.