Package ch.qos.logback.core.html

Class HTMLLayoutBase<E>

  • All Implemented Interfaces:
    Layout<E>, ContextAware, LifeCycle
    Direct Known Subclasses:
    HTMLLayout
    public abstract class HTMLLayoutBase<E>
extends LayoutBase<E>
    This class is a base class for HTMLLayout classes part of other logback modules such as logback-classic and logback-access.

    • Constructor Detail

      • HTMLLayoutBase

        public HTMLLayoutBase()

    • Method Detail

      • setPattern

        public void setPattern​(java.lang.String conversionPattern)
        Set the ConversionPattern option. This is the string which controls formatting and consists of a mix of literal content and conversion specifiers.

      • getPattern

        public java.lang.String getPattern()
        Returns the value of the ConversionPattern option.

      • getCssBuilder

        public CssBuilder getCssBuilder()

      • setCssBuilder

        public void setCssBuilder​(CssBuilder cssBuilder)

      • start

        public void start()
        Parses the pattern and creates the Converter linked list.
        Specified by:
        start in interface LifeCycle
        Overrides:
        start in class LayoutBase<E>

      • 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.

      • setTitle

        public void setTitle​(java.lang.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'.

      • getTitle

        public java.lang.String getTitle()
        Returns the current value of the Title option.

      • getContentType

        public java.lang.String getContentType()
        Returns the content type output by this layout, i.e "text/html".
        Specified by:
        getContentType in interface Layout<E>
        Overrides:
        getContentType in class LayoutBase<E>
        Returns:

      • 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.

      • getPresentationFooter

        public java.lang.String getPresentationFooter()
        Description copied from interface: Layout
        Return the footer of the logging event formatting. The returned value may be null.
        Specified by:
        getPresentationFooter in interface Layout<E>
        Overrides:
        getPresentationFooter in class LayoutBase<E>
        Returns:
        The footer.