org.apache.logging.log4j.core.layout
Class PatternLayout

java.lang.Object
  org.apache.logging.log4j.core.layout.AbstractLayout<String>
      org.apache.logging.log4j.core.layout.AbstractStringLayout
          org.apache.logging.log4j.core.layout.PatternLayout

All Implemented Interfaces:

Layout<String>

public final class PatternLayout
extends AbstractStringLayout

A flexible layout configurable with pattern string. The goal of this class is to format a LogEvent and return the results. The format of the result depends on the conversion pattern.

The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern is composed of literal text and format control expressions called conversion specifiers. See the Log4j Manual for details on the supported pattern converters.

Field Summary

static String	DEFAULT_CONVERSION_PATTERN Default pattern string for log output.
static String	KEY Key to identify pattern converters.
static String	SIMPLE_CONVERSION_PATTERN A simple pattern.
static String	TTCC_CONVERSION_PATTERN A conversion pattern equivalent to the TTCCCLayout.

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

footer, header, LOGGER

Method Summary

static PatternLayout	createLayout(String pattern, Configuration config, RegexReplacement replace, String charsetName) Create a pattern layout.
static PatternParser	createPatternParser(Configuration config) Create a PatternParser.
Map<String,String>	getContentFormat() PatternLayout's content format is specified by: Key: "structured" Value: "false" Key: "formatType" Value: "conversion" (format uses the keywords supported by OptionConverter) Key: "format" Value: provided "conversionPattern" param
void	setConversionPattern(String conversionPattern) Set the ConversionPattern option.
String	toSerializable(LogEvent event) Formats a logging event to a writer.
String	toString()

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout

getCharset, getContentType, toByteArray

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

getFooter, getHeader, setFooter, setHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CONVERSION_PATTERN

public static final String DEFAULT_CONVERSION_PATTERN

Default pattern string for log output. Currently set to the string "%m%n" which just prints the application supplied message.

See Also:

Constant Field Values

TTCC_CONVERSION_PATTERN

public static final String TTCC_CONVERSION_PATTERN

A conversion pattern equivalent to the TTCCCLayout. Current value is %r [%t] %p %c %x - %m%n.

See Also:

Constant Field Values

SIMPLE_CONVERSION_PATTERN

public static final String SIMPLE_CONVERSION_PATTERN

A simple pattern. Current value is %d [%t] %p %c - %m%n.

See Also:

Constant Field Values

KEY

public static final String KEY

Key to identify pattern converters.

See Also:

Constant Field Values

Method Detail

setConversionPattern

public void setConversionPattern(String conversionPattern)

Set the ConversionPattern option. This is the string which controls formatting and consists of a mix of literal content and conversion specifiers.

Parameters:

conversionPattern - conversion pattern.

getContentFormat

public Map<String,String> getContentFormat()

PatternLayout's content format is specified by:

Key: "structured" Value: "false"

Key: "formatType" Value: "conversion" (format uses the keywords supported by OptionConverter)

Key: "format" Value: provided "conversionPattern" param

Returns:

Map of content format keys supporting PatternLayout

toSerializable

public String toSerializable(LogEvent event)

Formats a logging event to a writer.

Parameters:

event - logging event to be formatted.

Returns:

The event formatted as a String.

createPatternParser

public static PatternParser createPatternParser(Configuration config)

Create a PatternParser.

Parameters:

config - The Configuration.

Returns:

The PatternParser.

toString

public String toString()

Overrides:

toString in class Object

createLayout

public static PatternLayout createLayout(String pattern,
                                         Configuration config,
                                         RegexReplacement replace,
                                         String charsetName)

Create a pattern layout.

Parameters:

pattern - The pattern. If not specified, defaults to DEFAULT_CONVERSION_PATTERN.

config - The Configuration. Some Converters require access to the Interpolator.

replace - A Regex replacement String.

charsetName - The character set.

Returns:

The PatternLayout.