offapi/com/sun/star/logging/XLogFormatter.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XLogFormatter.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_logging_XLogFormatter_idl__
  32 #define __com_sun_star_logging_XLogFormatter_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_logging_LogRecord_idl__
  39 #include <com/sun/star/logging/LogRecord.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module logging {
  45
  46 //=============================================================================
  47
  48 /** specifies the interface to be used for formatting log records
  49
  50     @see XLogHandler
  51
  52     @since OOo 2.3
  53 */
  54 interface XLogFormatter
  55 {
  56     /** returns the header string for the log
  57
  58         <p>This can be used to generate a header string, which by the <type>XLogHandler</type>
  59         is emitted to its output channel before actually logging any concrete
  60         <type>LogRecord</type>.</p>
  61
  62         <p>For instance, a formatter might produce table-like plain text output,
  63         and could return a table-head string (potentially including line breaks)
  64         here.</p>
  65     */
  66     string  getHead();
  67
  68     /** formats the given log record for output
  69
  70         <p>A <type>XLogHandler</type> will call this method to format a given
  71         log record. The resulting string will be emitted to the handler's output
  72         channel, without processing it any further (except possibly encoding it with
  73         the handler's <code>Encoding</code>).</p>
  74     */
  75     string  format( [in] LogRecord Record );
  76
  77     /** returns the footer string for the log
  78
  79         <p>This can be used to generate a footer string, which by the <type>XLogHandler</type>
  80         is emitted to its output channel before it is finally being closed.</p>
  81     */
  82     string  getTail();
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 //=============================================================================
  90
  91 #endif