public abstract class

PatternConverter

extends Object
java.lang.Object
   ↳ org.apache.log4j.pattern.PatternConverter
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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

Summary

Protected Constructors
PatternConverter(String name, String style)
Create a new pattern converter.
Public Methods
abstract void format(Object obj, StringBuffer toAppendTo)
Formats an object into a string buffer.
final String getName()
This method returns the name of the conversion pattern.
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.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected PatternConverter (String name, String style)

Create a new pattern converter.

Parameters
name name for pattern converter.
style CSS style for formatted output.

Public Methods

public abstract void format (Object obj, StringBuffer toAppendTo)

Formats an object into a string buffer.

Parameters
obj event to format, may not be null.
toAppendTo string buffer to which the formatted event will be appended. May not be null.

public final String getName ()

This method returns the name of the conversion pattern. The name can be useful to certain Layouts such as HTMLLayout.

Returns
  • the name of the conversion pattern

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.

Parameters
e null values are accepted
Returns
  • the name of the conversion pattern