err.no Git - sope/blob - sope-core/NGExtensions/NGExtensions/NGLogger.h

   1 /*
   2   Copyright (C) 2004 SKYRIX Software AG
   3
   4   This file is part of OpenGroupware.org.
   5
   6   OGo is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   OGo is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with OGo; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #ifndef __NGExtensions_NGLogger_H_
  23 #define __NGExtensions_NGLogger_H_
  24
  25 /*
  26   NGLogger
  27
  28   NGLogger has a minimum log level and passes messages to its appenders
  29   only if this minimum log level is satisfied - otherwise it silently drops
  30   these messages.
  31
  32   Note: Except in rare circumstances, do not allocate loggers yourself. Always
  33         try to use the appropriate API of NGLoggerManager if possible.
  34
  35   Note: Currently the NGLogger implementation lacks an API for configuring
  36         appenders. Until this has been done appropriately, use the
  37         "NGLogDefaultAppenderClass" user default to select an appropriate
  38         default appender. If this default isn't set, "NGLogConsoleAppender"
  39         is used.
  40 */
  41
  42 #import <Foundation/NSObject.h>
  43 #include <NGExtensions/NGLogLevel.h>
  44
  45 @interface NGLogger : NSObject
  46 {
  47   NGLogLevel logLevel;
  48   id         _appender; // going away as soon as we have a config
  49 }
  50
  51 + (id)defaultLogger;
  52 - (id)initWithLogLevel:(NGLogLevel)_level;
  53
  54 /* accessors */
  55
  56 - (void)setLogLevel:(NGLogLevel)_level;
  57 - (NGLogLevel)logLevel;
  58
  59
  60
  61 /* logging */
  62
  63
  64 /* conditions */
  65
  66 - (BOOL)isDebuggingEnabled;
  67 - (BOOL)isLogInfoEnabled;
  68 - (BOOL)isLogWarnEnabled;
  69 - (BOOL)isLogErrorEnabled;
  70 - (BOOL)isLogFatalEnabled;
  71
  72 @end
  73
  74 #endif  /* __NGExtensions_NGLogger_H_ */