Top Description Fields Constructors Methods
ch.qos.logback.core.html

public abstract Class HTMLLayoutBase<E>

extends LayoutBase<E>
Class Inheritance
Imports
java.util.HashMap, .Map, ch.qos.logback.core.Context, .CoreConstants, .LayoutBase, ch.qos.logback.core.pattern.Converter, .ConverterUtil, ch.qos.logback.core.pattern.parser.Node, .Parser, ch.qos.logback.core.spi.ScanException
This class is a base class for HTMLLayout classes part of other logback modules such as logback-classic and logback-access.
Author
Sébastien Pennec

Field Summary

Modifier and TypeField and Description
protected long
counter

protected CssBuilder
cssBuilder

protected Converter<E>
head

protected String
pattern

protected String
title

Inherited from ch.qos.logback.core.LayoutBase:
started

Constructor Summary

AccessConstructor and Description
public
HTMLLayoutBase()

Method Summary

Modifier and TypeMethod and Description
private void
buildHeaderRowForTable(StringBuilder sbuf)

protected String
computeConverterName(Converter<E> c)

public String
getContentType()

Overrides ch.qos.logback.core.LayoutBase.getContentType.

Implements ch.qos.logback.core.Layout.getContentType.

Returns the content type output by this layout, i.e "text/html".
public CssBuilder
getCssBuilder()

protected abstract Map<String, String>
getDefaultConverterMap()

public Map<String, String>
getEffectiveConverterMap()

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

public String
getFileFooter()

Overrides ch.qos.logback.core.LayoutBase.getFileFooter.

Implements ch.qos.logback.core.Layout.getFileFooter.

Returns the appropriate HTML footers.
public String
getFileHeader()

Overrides ch.qos.logback.core.LayoutBase.getFileHeader.

Implements ch.qos.logback.core.Layout.getFileHeader.

Returns appropriate HTML headers.
public String
getPattern()

Returns the value of the ConversionPattern option.

public String
getPresentationFooter()

Overrides ch.qos.logback.core.LayoutBase.getPresentationFooter.

Implements ch.qos.logback.core.Layout.getPresentationFooter.

Return the footer of the logging event formatting.
public String
getPresentationHeader()

Overrides ch.qos.logback.core.LayoutBase.getPresentationHeader.

Implements ch.qos.logback.core.Layout.getPresentationHeader.

Return the header of the logging event formatting.
public String
getTitle()

Returns the current value of the Title option.

public void
setCssBuilder(CssBuilder cssBuilder)

public void
setPattern(String conversionPattern)

Set the ConversionPattern option.

public void
setTitle(String title)

The Title option takes a String value.

public void
start()

Overrides ch.qos.logback.core.LayoutBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

Parses the pattern and creates the Converter linked list.
protected void
startNewTableIfLimitReached(StringBuilder sbuf)

Inherited from ch.qos.logback.core.LayoutBase:
getContextisStartedsetContextsetFileFootersetFileHeadersetPresentationFootersetPresentationHeaderstop

Field Detail

counterback to summary
protected long counter
cssBuilderback to summary
protected CssBuilder cssBuilder
patternback to summary
protected String pattern
titleback to summary
protected String title

Constructor Detail

HTMLLayoutBaseback to summary
public HTMLLayoutBase()

Method Detail

buildHeaderRowForTableback to summary
private void buildHeaderRowForTable(StringBuilder sbuf)
computeConverterNameback to summary
protected String computeConverterName(Converter<E> c)
getContentTypeback to summary
public String getContentType()

Overrides ch.qos.logback.core.LayoutBase.getContentType.

Implements ch.qos.logback.core.Layout.getContentType.

Returns the content type output by this layout, i.e "text/html".

Annotations
@Override
getCssBuilderback to summary
public CssBuilder getCssBuilder()
getDefaultConverterMapback to summary
protected abstract Map<String, String> getDefaultConverterMap()
getEffectiveConverterMapback to summary
public Map<String, String> getEffectiveConverterMap()

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

getFileFooterback to summary
public String getFileFooter()

Overrides ch.qos.logback.core.LayoutBase.getFileFooter.

Implements ch.qos.logback.core.Layout.getFileFooter.

Returns the appropriate HTML footers.

Returns:String

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

The footer.

Annotations
@Override
getFileHeaderback to summary
public String getFileHeader()

Overrides ch.qos.logback.core.LayoutBase.getFileHeader.

Implements ch.qos.logback.core.Layout.getFileHeader.

Returns appropriate HTML headers.

Returns:String

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

The header.

Annotations
@Override
getPatternback to summary
public String getPattern()

Returns the value of the ConversionPattern option.

getPresentationFooterback to summary
public String getPresentationFooter()

Overrides ch.qos.logback.core.LayoutBase.getPresentationFooter.

Implements ch.qos.logback.core.Layout.getPresentationFooter.

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

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

Returns:String

The footer.

getPresentationHeaderback to summary
public String getPresentationHeader()

Overrides ch.qos.logback.core.LayoutBase.getPresentationHeader.

Implements ch.qos.logback.core.Layout.getPresentationHeader.

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

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

Returns:String

The header.

getTitleback to summary
public String getTitle()

Returns the current value of the Title option.

setCssBuilderback to summary
public void setCssBuilder(CssBuilder cssBuilder)
setPatternback to summary
public void setPattern(String conversionPattern)

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

setTitleback to summary
public void setTitle(String title)

The Title option takes a String value. This option sets the document title of the generated HTML document.

Defaults to 'Logback Log Messages'.

startback to summary
public void start()

Overrides ch.qos.logback.core.LayoutBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

Parses the pattern and creates the Converter linked list.

Annotations
@Override
startNewTableIfLimitReachedback to summary
protected void startNewTableIfLimitReached(StringBuilder sbuf)