Class AbstractPatternConverter

All Implemented Interfaces:
Direct Known Subclasses:
IntegerPatternConverter, LogEventPatternConverter

public abstract class AbstractPatternConverter extends Object implements PatternConverter
AbstractPatternConverter is an abstract class that provides the formatting functionality that derived classes need.

Conversion specifiers in a conversion patterns are parsed to individual PatternConverters. Each of which is responsible for converting an object in a converter specific manner.

  • Field Details

    • LOGGER

      protected static final Logger LOGGER
      Allow subclasses access to the status logger.
  • Constructor Details

    • AbstractPatternConverter

      protected AbstractPatternConverter(String name, String style)
      Create a new pattern converter.
      name - name for pattern converter.
      style - CSS style for formatted output.
  • Method Details

    • getName

      public final String getName()
      This method returns the name of the conversion pattern.

      The name can be useful to certain Layouts such as HtmlLayout.

      Specified by:
      getName in interface PatternConverter
      the name of the conversion pattern
    • getStyleClass

      public String getStyleClass(Object e)
      This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can be null.

      This information is currently used only by HtmlLayout.

      Specified by:
      getStyleClass in interface PatternConverter
      e - null values are accepted
      the name of the conversion pattern