Module ch.qos.logback.classic

Package ch.qos.logback.classic

Class PatternLayout

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.LayoutBase<E>

ch.qos.logback.core.pattern.PatternLayoutBase<ILoggingEvent>

ch.qos.logback.classic.PatternLayout

All Implemented Interfaces:

Layout<ILoggingEvent>, ContextAware, LifeCycle

public class PatternLayout
extends PatternLayoutBase<ILoggingEvent>

A flexible layout configurable with pattern string. The main method in this class is to doLayout(ILoggingEvent). It returns the results as a {#link String}. The format and contents 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

Fields

Modifier and Type	Field	Description
static Map<String,String>	CONVERTER_CLASS_TO_KEY_MAP
static Map<String,String>	DEFAULT_CONVERTER_MAP	Deprecated. replaced by DEFAULT_CONVERTER_SUPPLIER_MAP
static Map<String,Supplier<DynamicConverter>>	DEFAULT_CONVERTER_SUPPLIER_MAP
static Map<String,String>	defaultConverterMap	Deprecated. replaced by DEFAULT_CONVERTER_MAP in turn itself replaced by DEFAULT_CONVERTER_SUPPLIER_MAP
static String	HEADER_PREFIX

Fields inherited from class ch.qos.logback.core.pattern.PatternLayoutBase

outputPatternAsHeader, postCompileProcessor

Fields inherited from class ch.qos.logback.core.LayoutBase

started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
PatternLayout()

Method Summary

Modifier and Type	Method	Description
String	doLayout(ILoggingEvent event)	Transform an event (of type Object) and return it as a String after appropriate formatting.
Map<String,String>	getDefaultConverterMap()	Deprecated.
Map<String,Supplier<DynamicConverter>>	getDefaultConverterSupplierMap()	Concrete implementations of this class are responsible for elaborating the mapping between pattern words and supplying converter instances.
protected String	getPresentationHeaderPrefix()

Methods inherited from class ch.qos.logback.core.pattern.PatternLayoutBase

getEffectiveConverterMap, getInstanceConverterMap, getPattern, getPresentationHeader, isOutputPatternAsHeader, setContextForConverters, setOutputPatternAsHeader, setPattern, setPostCompileProcessor, start, toString, writeLoopOnConverters

Methods inherited from class ch.qos.logback.core.LayoutBase

getContentType, getContext, getFileFooter, getFileHeader, getPresentationFooter, isStarted, setContext, setFileFooter, setFileHeader, setPresentationFooter, setPresentationHeader, stop

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getDeclaredOrigin, getStatusManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn

Field Detail

DEFAULT_CONVERTER_SUPPLIER_MAP

public static final Map<String,Supplier<DynamicConverter>> DEFAULT_CONVERTER_SUPPLIER_MAP

DEFAULT_CONVERTER_MAP

@Deprecated
public static final Map<String,String> DEFAULT_CONVERTER_MAP

Deprecated.

replaced by DEFAULT_CONVERTER_SUPPLIER_MAP

CONVERTER_CLASS_TO_KEY_MAP

public static final Map<String,String> CONVERTER_CLASS_TO_KEY_MAP

defaultConverterMap

@Deprecated
public static final Map<String,String> defaultConverterMap

Deprecated.

replaced by DEFAULT_CONVERTER_MAP in turn itself replaced by DEFAULT_CONVERTER_SUPPLIER_MAP

HEADER_PREFIX

public static final String HEADER_PREFIX

See Also:

Constant Field Values

Constructor Detail

PatternLayout

public PatternLayout()

Method Detail

getDefaultConverterSupplierMap

public Map<String,Supplier<DynamicConverter>> getDefaultConverterSupplierMap()

Description copied from class: PatternLayoutBase

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

Specified by:

getDefaultConverterSupplierMap in class PatternLayoutBase<ILoggingEvent>

Returns:

A map associating pattern words to the names of converter suppliers

getDefaultConverterMap

@Deprecated
public Map<String,String> getDefaultConverterMap()

Deprecated.

BEWARE: The map of type String,String for mapping conversion words is deprecated. Use getDefaultConverterSupplierMap() instead.

Existing code such as getDefaultMap().put("k", X.class.getName()) should be replaced by getDefaultConverterSupplierMap().put("k", X::new)

Note that values in the map will still be taken into account and processed correctly.

Specified by:

getDefaultConverterMap in class PatternLayoutBase<ILoggingEvent>

Returns:

a map of keys and class names

doLayout

public String doLayout(ILoggingEvent event)

Description copied from interface: Layout

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 - The event to format

Returns:

the event formatted as a String

getPresentationHeaderPrefix

protected String getPresentationHeaderPrefix()

Overrides:

getPresentationHeaderPrefix in class PatternLayoutBase<ILoggingEvent>