Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: logging ::

interface XLogFormatter
Description
specifies the interface to be used for formatting log records
Since
OOo 2.3
See also
XLogHandler

Methods' Summary
getHead returns the header string for the log  
format formats the given log record for output  
getTail returns the footer string for the log  
Methods' Details
getHead
string
getHead();

Description
returns the header string for the log

This can be used to generate a header string, which by the XLogHandler is emitted to its output channel before actually logging any concrete LogRecord.

For instance, a formatter might produce table-like plain text output, and could return a table-head string (potentially including line breaks) here.

format
string
format( [in] LogRecord  Record );

Description
formats the given log record for output

A XLogHandler will call this method to format a given log record. The resulting string will be emitted to the handler's output channel, without processing it any further (except possibly encoding it with the handler's Encoding).

getTail
string
getTail();

Description
returns the footer string for the log

This can be used to generate a footer string, which by the XLogHandler is emitted to its output channel before it is finally being closed.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.