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
  21 module com { module sun { module star { module logging {
  22
  23 interface XLogger;
  24
  25
  26 /** implements a pool for named XLogger instances
  27
  28     @since OOo 2.3
  29  */
  30 interface XLoggerPool
  31 {
  32     /** retrieves a logger with the given name
  33
  34         <p>Multiple attempts to retrieve a logger with the same name will return
  35         the same instance.</p>
  36
  37         <p>Newly created logger instances are initialized via configuration. See the configuration
  38         module <code>/org.openoffice.Office.Logging</code> for an explanation of the initialization
  39         pattern.</p>
  40     */
  41     XLogger getNamedLogger( [in] string Name );
  42
  43     /** retrieves a logger with the default name &quot;org.openoffice.logging.DefaultLogger&quot;.
  44
  45         <p>Calling this method is equivalent to calling <code>getNamedLogger( &quot;org.openoffice.logging.DefaultLogger&quot; )</code>.</p>
  46     */
  47     XLogger getDefaultLogger();
  48 };
  49
  50
  51 }; }; }; };
  52
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */