1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_logging_XLogFormatter_idl__
25#define __com_sun_star_logging_XLogFormatter_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_logging_LogRecord_idl__
32#include <com/sun/star/logging/LogRecord.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module logging {
38
39//=============================================================================
40
41/** specifies the interface to be used for formatting log records
42
43    @see XLogHandler
44
45    @since OpenOffice 2.3
46*/
47published interface XLogFormatter
48{
49    /** returns the header string for the log
50
51        <p>This can be used to generate a header string, which by the <type>XLogHandler</type>
52        is emitted to its output channel before actually logging any concrete
53        <type>LogRecord</type>.</p>
54
55        <p>For instance, a formatter might produce table-like plain text output,
56        and could return a table-head string (potentially including line breaks)
57        here.</p>
58    */
59    string  getHead();
60
61    /** formats the given log record for output
62
63        <p>A <type>XLogHandler</type> will call this method to format a given
64        log record. The resulting string will be emitted to the handler's output
65        channel, without processing it any further (except possibly encoding it with
66        the handler's <code>Encoding</code>).</p>
67    */
68    string  format( [in] LogRecord Record );
69
70    /** returns the footer string for the log
71
72        <p>This can be used to generate a footer string, which by the <type>XLogHandler</type>
73        is emitted to its output channel before it is finally being closed.</p>
74    */
75    string  getTail();
76};
77
78//=============================================================================
79
80}; }; }; };
81
82//=============================================================================
83
84#endif
85