Top Description Fields Constructors Methods
ch.qos.logback.classic

public Class PatternLayout

extends PatternLayoutBase<ILoggingEvent>
Class Inheritance
Imports
java.util.HashMap, .Map, ch.qos.logback.classic.pattern.*, ch.qos.logback.classic.pattern.color.HighlightingCompositeConverter, ch.qos.logback.classic.spi.ILoggingEvent, ch.qos.logback.core.CoreConstants, ch.qos.logback.core.pattern.PatternLayoutBase, ch.qos.logback.core.pattern.color.*, ch.qos.logback.core.pattern.parser.Parser

A flexible layout configurable with pattern string. The goal of this class is to format a ILoggingEvent and return the results in a {#link String}. The format of the result depends on the conversion pattern.

For more information about this layout, please refer to the online manual at http://logback.qos.ch/manual/layouts.html#PatternLayout

Field Summary

Modifier and TypeField and Description
public static final Map<String, String>
CONVERTER_CLASS_TO_KEY_MAP

public static final Map<String, String>
DEFAULT_CONVERTER_MAP

public static final Map<String, String>
defaultConverterMap

Deprecated replaced by DEFAULT_CONVERTER_MAP
public static final String
HEADER_PREFIX

Inherited from ch.qos.logback.core.pattern.PatternLayoutBase:
outputPatternAsHeaderpostCompileProcessor

Constructor Summary

AccessConstructor and Description
public
PatternLayout()

Method Summary

Modifier and TypeMethod and Description
public String
doLayout(ILoggingEvent
The event to format
event)

Implements ch.qos.logback.core.Layout.doLayout.

Transform an event (of type Object) and return it as a String after appropriate formatting.
public Map<String, String>
getDefaultConverterMap()

Implements abstract ch.qos.logback.core.pattern.PatternLayoutBase.getDefaultConverterMap.

Concrete implementations of this class are responsible for elaborating the mapping between pattern words and converters.
protected String
getPresentationHeaderPrefix()

Overrides ch.qos.logback.core.pattern.PatternLayoutBase.getPresentationHeaderPrefix.

Inherited from ch.qos.logback.core.pattern.PatternLayoutBase:
getEffectiveConverterMapgetInstanceConverterMapgetPatterngetPresentationHeaderisOutputPatternAsHeadersetContextForConverterssetOutputPatternAsHeadersetPatternsetPostCompileProcessorstarttoStringwriteLoopOnConverters

Field Detail

CONVERTER_CLASS_TO_KEY_MAPback to summary
public static final Map<String, String> CONVERTER_CLASS_TO_KEY_MAP
DEFAULT_CONVERTER_MAPback to summary
public static final Map<String, String> DEFAULT_CONVERTER_MAP
defaultConverterMapback to summary
public static final Map<String, String> defaultConverterMap

Deprecated

replaced by DEFAULT_CONVERTER_MAP

HEADER_PREFIXback to summary
public static final String HEADER_PREFIX

Constructor Detail

PatternLayoutback to summary
public PatternLayout()

Method Detail

doLayoutback to summary
public String doLayout(ILoggingEvent event)

Implements ch.qos.logback.core.Layout.doLayout.

Doc from ch.qos.logback.core.Layout.doLayout.

Transform an event (of type Object) and return it as a String after appropriate formatting.

Taking in an object and returning a String is the least sophisticated way of formatting events. However, it is remarkably CPU-effective.

Parameters
event:ILoggingEvent

The event to format

Returns:String

the event formatted as a String

getDefaultConverterMapback to summary
public Map<String, String> getDefaultConverterMap()

Implements abstract ch.qos.logback.core.pattern.PatternLayoutBase.getDefaultConverterMap.

Doc from ch.qos.logback.core.pattern.PatternLayoutBase.getDefaultConverterMap.

Concrete implementations of this class are responsible for elaborating the mapping between pattern words and converters.

Returns:Map<String, String>

A map associating pattern words to the names of converter classes

getPresentationHeaderPrefixback to summary
protected String getPresentationHeaderPrefix()

Overrides ch.qos.logback.core.pattern.PatternLayoutBase.getPresentationHeaderPrefix.

Annotations
@Override