offapi/com/sun/star/logging/PlainTextFormatter.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: PlainTextFormatter.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_PlainTextFormatter_idl__
  32 #define __com_sun_star_logging_PlainTextFormatter_idl__
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module logging {
  37
  38 interface XLogFormatter;
  39
  40 //=============================================================================
  41
  42 /** specifies a service which formats log records as single line plain text
  43
  44     <p>Every log record, as passed to <member>XLogFormatter::format</member>, will
  45     be formatted into a single text line, assembling the sequence number, the thread ID,
  46     the time of the logged event, the source class/method name (if applicable), and the
  47     log message.</p>
  48
  49     @since OOo 2.3
  50  */
  51 service PlainTextFormatter : XLogFormatter
  52 {
  53     /// creates a PlainTextFormatter instance
  54     create();
  55 };
  56
  57 //=============================================================================
  58
  59 }; }; }; };
  60
  61 //=============================================================================
  62
  63 #endif