Package ch.qos.logback.core.pattern

Class PatternLayoutBase<E>

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

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

All Implemented Interfaces:

Layout<E>, ContextAware, LifeCycle

Direct Known Subclasses:

PatternLayout

public abstract class PatternLayoutBase<E>
extends LayoutBase<E>

Constructor Summary

Constructors

Constructor	Description
PatternLayoutBase()

Method Summary

Modifier and Type	Method	Description
abstract java.util.Map<java.lang.String,java.lang.String>	getDefaultConverterMap()	Concrete implementations of this class are responsible for elaborating the mapping between pattern words and converters.
java.util.Map<java.lang.String,java.lang.String>	getEffectiveConverterMap()	Returns a map where the default converter map is merged with the map contained in the context.
java.util.Map<java.lang.String,java.lang.String>	getInstanceConverterMap()
java.lang.String	getPattern()
java.lang.String	getPresentationHeader()	Return the header of the logging event formatting.
boolean	isOutputPatternAsHeader()
void	setOutputPatternAsHeader(boolean outputPatternAsHeader)
void	setPattern(java.lang.String pattern)
void	setPostCompileProcessor(PostCompileProcessor<E> postCompileProcessor)
void	start()
java.lang.String	toString()

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface ch.qos.logback.core.Layout

doLayout

Constructor Detail

PatternLayoutBase

public PatternLayoutBase()

Method Detail

getDefaultConverterMap

public abstract java.util.Map<java.lang.String,java.lang.String> getDefaultConverterMap()

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

Returns:

A map associating pattern words to the names of converter classes

getEffectiveConverterMap

public java.util.Map<java.lang.String,java.lang.String> getEffectiveConverterMap()

Returns a map where the default converter map is merged with the map contained in the context.

start

public void start()

Specified by:

start in interface LifeCycle

Overrides:

start in class LayoutBase<E>

setPostCompileProcessor

public void setPostCompileProcessor(PostCompileProcessor<E> postCompileProcessor)

getPattern

public java.lang.String getPattern()

setPattern

public void setPattern(java.lang.String pattern)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getInstanceConverterMap

public java.util.Map<java.lang.String,java.lang.String> getInstanceConverterMap()

isOutputPatternAsHeader

public boolean isOutputPatternAsHeader()

setOutputPatternAsHeader

public void setOutputPatternAsHeader(boolean outputPatternAsHeader)

getPresentationHeader

public java.lang.String getPresentationHeader()

Description copied from interface: Layout

Return the header of the logging event formatting. The returned value may be null.

Specified by:

getPresentationHeader in interface Layout<E>

Overrides:

getPresentationHeader in class LayoutBase<E>

Returns:

The header.