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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_logging_XLoggerPool_idl__
  21 #define __com_sun_star_logging_XLoggerPool_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com { module sun { module star { module logging {
  27
  28 interface XLogger;
  29
  30
  31 /** implements a pool for named XLogger instances
  32
  33     @since OOo 2.3
  34  */
  35 interface XLoggerPool
  36 {
  37     /** retrieves a logger with the given name
  38
  39         <p>Multiple attempts to retrieve a logger with the same name will return
  40         the same instance.</p>
  41
  42         <p>Newly created logger instances are initialized via configuration. See the configuration
  43         module <code>/org.openoffice.Office.Logging</code> for an explanation of the initialization
  44         pattern.</p>
  45     */
  46     XLogger getNamedLogger( [in] string Name );
  47
  48     /** retrieves a logger with the default name &quot;org.openoffice.logging.DefaultLogger&quot;.
  49
  50         <p>Calling this method is equivalent to calling <code>getNamedLogger( &quot;org.openoffice.logging.DefaultLogger&quot; )</code>.</p>
  51     */
  52     XLogger getDefaultLogger();
  53 };
  54
  55
  56 }; }; }; };
  57
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */