Syslog: White Paper FAQ Examples JavaDoc
Protomatter Classes v1.1.6

com.protomatter.syslog
Interface SyslogTextFormatter

All Known Implementing Classes:
SimpleSyslogTextFormatter

public interface SyslogTextFormatter

The interface for the pluggable text formatting system. It is used to format log entries by subclasses of the BasicLogger logger.

See Also:
SimpleSyslogTextFormatter

Method Summary
 void formatLogEntry(java.lang.StringBuffer b, SyslogMessage message)
          Format the given log entry.
 void formatMessageDetail(java.lang.StringBuffer b, SyslogMessage message)
          Format the given log message's detail.
 java.lang.String getLogFooter()
          Get the footer text that should be included at the bottom of each log file.
 java.lang.String getLogHeader()
          Get the header text that should be included at the top of each log file.
 void resetDateFormat()
          Reset the formatter's date format.
 

Method Detail

formatLogEntry

public void formatLogEntry(java.lang.StringBuffer b,
                           SyslogMessage message)
Format the given log entry. The time given is formatted according to the date format and timezone set in the BasicLogger class.

formatMessageDetail

public void formatMessageDetail(java.lang.StringBuffer b,
                                SyslogMessage message)
Format the given log message's detail.

getLogHeader

public java.lang.String getLogHeader()
Get the header text that should be included at the top of each log file.

getLogFooter

public java.lang.String getLogFooter()
Get the footer text that should be included at the bottom of each log file.

resetDateFormat

public void resetDateFormat()
Reset the formatter's date format. This method is used by rolling log implementations so that the date is always correct, even if the formatter is caching dates, which is recomended.

Protomatter Classes v1.1.6
Copyright 1998-2001 Nate Sammons

Protomatter Classes v1.1.6 http://protomatter.sourceforge.net/1.1.6