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.

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	Description
void	format(LogEvent event, StringBuilder toAppendTo)	Formats an event into a string buffer.
boolean	handlesThrowable()	Tests whether this pattern converter is renders a Throwable.
static EncodingPatternConverter	newInstance(Configuration config, 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

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

Method Detail

handlesThrowable

public boolean handlesThrowable()

Description copied from class: LogEventPatternConverter

Tests whether this pattern converter is renders a Throwable.

The PatternParser checks this flag when processing the alwaysWriteExceptions option: if no converter in the pattern handles throwables, the parser automatically appends a converter to ensure exceptions are still written.

Overrides:

handlesThrowable in class LogEventPatternConverter

Returns:

true if this converter consumes and renders a Throwable, false otherwise

newInstance

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