public final class

PropertiesPatternConverter

extends LoggingEventPatternConverter
java.lang.Object
   ↳ org.apache.log4j.pattern.PatternConverter
     ↳ org.apache.log4j.pattern.LoggingEventPatternConverter
       ↳ org.apache.log4j.pattern.PropertiesPatternConverter

Class Overview

Able to handle the contents of the LoggingEvent's Property bundle and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set.

Summary

Public Methods
void format(LoggingEvent event, StringBuffer toAppendTo)
Formats an event into a string buffer.
static PropertiesPatternConverter newInstance(String[] options)
Obtains an instance of PropertiesPatternConverter.
[Expand]
Inherited Methods
From class org.apache.log4j.pattern.LoggingEventPatternConverter
From class org.apache.log4j.pattern.PatternConverter
From class java.lang.Object

Public Methods

public void format (LoggingEvent event, StringBuffer toAppendTo)

Formats an event into a string buffer.

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

public static PropertiesPatternConverter newInstance (String[] options)

Obtains an instance of PropertiesPatternConverter.

Parameters
options options, may be null or first element contains name of property to format.
Returns
  • instance of PropertiesPatternConverter.