| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_logging_XLogFormatter_idl__ |
| #define __com_sun_star_logging_XLogFormatter_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| |
| #ifndef __com_sun_star_logging_LogRecord_idl__ |
| #include <com/sun/star/logging/LogRecord.idl> |
| #endif |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module logging { |
| |
| //============================================================================= |
| |
| /** specifies the interface to be used for formatting log records |
| |
| @see XLogHandler |
| |
| @since OpenOffice 2.3 |
| */ |
| published interface XLogFormatter |
| { |
| /** returns the header string for the log |
| |
| <p>This can be used to generate a header string, which by the <type>XLogHandler</type> |
| is emitted to its output channel before actually logging any concrete |
| <type>LogRecord</type>.</p> |
| |
| <p>For instance, a formatter might produce table-like plain text output, |
| and could return a table-head string (potentially including line breaks) |
| here.</p> |
| */ |
| string getHead(); |
| |
| /** formats the given log record for output |
| |
| <p>A <type>XLogHandler</type> 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 <code>Encoding</code>).</p> |
| */ |
| string format( [in] LogRecord Record ); |
| |
| /** returns the footer string for the log |
| |
| <p>This can be used to generate a footer string, which by the <type>XLogHandler</type> |
| is emitted to its output channel before it is finally being closed.</p> |
| */ |
| string getTail(); |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| //============================================================================= |
| |
| #endif |