Module ch.qos.logback.classic

Package ch.qos.logback.classic.html

Class HTMLLayout

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

ch.qos.logback.core.html.HTMLLayoutBase<ILoggingEvent>

ch.qos.logback.classic.html.HTMLLayout

All Implemented Interfaces:

Layout<ILoggingEvent>, ContextAware, LifeCycle

public class HTMLLayout
extends HTMLLayoutBase<ILoggingEvent>

HTMLLayout outputs events in an HTML table.

The content of the table columns are specified using a conversion pattern. See PatternLayout for documentation on the available patterns.

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

Author:

Ceki Gülcü, Sébastien Pennec

Field Summary

Fields inherited from class ch.qos.logback.core.html.HTMLLayoutBase

counter, cssBuilder, head, pattern, title

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
HTMLLayout()	Constructs a PatternLayout using the DEFAULT_LAYOUT_PATTERN.

Method Summary

Modifier and Type	Method	Description
protected String	computeConverterName(Converter<ILoggingEvent> c)
String	doLayout(ILoggingEvent event)	Transform an event (of type Object) and return it as a String after appropriate formatting.
protected Map<String,Supplier<DynamicConverter>>	getDefaultConverterSupplierMap()
IThrowableRenderer<ILoggingEvent>	getThrowableRenderer()
void	setThrowableRenderer(IThrowableRenderer<ILoggingEvent> throwableRenderer)
void	start()	Parses the pattern and creates the Converter linked list.

Methods inherited from class ch.qos.logback.core.html.HTMLLayoutBase

getContentType, getCssBuilder, getEffectiveConverterMap, getFileFooter, getFileHeader, getPattern, getPresentationFooter, getPresentationHeader, getTitle, setCssBuilder, setPattern, setTitle, startNewTableIfLimitReached

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

getContext, 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, toString, wait, wait, wait

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

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

Constructor Details

HTMLLayout

public HTMLLayout()

Constructs a PatternLayout using the DEFAULT_LAYOUT_PATTERN. The default pattern just produces the application supplied message.

Method Details

start

public void start()

Description copied from class: HTMLLayoutBase

Parses the pattern and creates the Converter linked list.

Specified by:

start in interface LifeCycle

Overrides:

start in class HTMLLayoutBase<ILoggingEvent>

getDefaultConverterSupplierMap

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

Specified by:

getDefaultConverterSupplierMap in class HTMLLayoutBase<ILoggingEvent>

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

getThrowableRenderer

public IThrowableRenderer<ILoggingEvent> getThrowableRenderer()

setThrowableRenderer

public void setThrowableRenderer(IThrowableRenderer<ILoggingEvent> throwableRenderer)

computeConverterName

protected String computeConverterName(Converter<ILoggingEvent> c)

Overrides:

computeConverterName in class HTMLLayoutBase<ILoggingEvent>