Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: logging ::
unpublished | interface XLogFormatter |
Usage Restrictions not published 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

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.