de.infinityloop.util.log
Class LoggerDelegate

java.lang.Object
  extended by de.infinityloop.util.log.LoggerDelegate
Direct Known Subclasses:
LoggerDelegateConsole, LoggerDelegateFile, LoggerDelegateLog4j11, LoggerDelegateLog4j12

public abstract class LoggerDelegate
extends java.lang.Object

LoggerDelegate base class. To be implemented for various logging systems. The respective instance is then created via classForName().

Author:
Christian Roth

Field Summary
protected  NotificationCollector collector
          The collector object for notifications/errors/warnings, possibly wrapped into an ILException at some later time.
protected  LoggerConfiguration configuration
          The configuration for this logger
protected  long debugMask
          The debug mask to use
static java.lang.String kDebugAllString
           
 
Constructor Summary
LoggerDelegate()
          The only constructor to be supported.
 
Method Summary
 void config(java.lang.String message)
           
static void configure()
          Configure the logging system.
static void configure(java.util.Properties props)
          Configure the logging system using a Properties object.
abstract  void debug(long flags, int code, java.lang.Object[] params)
           
abstract  void debug(long flags, int code, java.lang.Object[] params, java.lang.Throwable t)
           
abstract  void debug(long flags, java.lang.String message)
           
abstract  void debug(long flags, java.lang.String message, java.lang.Throwable t)
           
 void entering(java.lang.String message)
           
abstract  void error(int code, java.lang.Object[] params)
           
abstract  void error(int code, java.lang.Object[] params, java.lang.Throwable t)
           
abstract  void error(int code, java.lang.String message)
           
abstract  void error(int code, java.lang.String message, java.lang.Throwable t)
           
abstract  void error(java.lang.String message)
           
abstract  void error(java.lang.String message, java.lang.Throwable t)
           
 boolean existsMessage(int code)
          Test if the numbered message does exist.
 void exiting(java.lang.String message)
           
abstract  void fatal(int code, java.lang.Object[] params)
           
abstract  void fatal(int code, java.lang.Object[] params, java.lang.Throwable t)
           
abstract  void fatal(int code, java.lang.String message)
           
abstract  void fatal(int code, java.lang.String message, java.lang.Throwable t)
           
abstract  void fatal(java.lang.String message)
           
 void fine(java.lang.String message)
           
 void fine(java.lang.String message, java.lang.Throwable t)
           
 void finer(java.lang.String message)
           
 void finer(java.lang.String message, java.lang.Throwable t)
           
 void finest(java.lang.String message)
           
 void finest(java.lang.String message, java.lang.Throwable t)
           
protected  java.lang.String formatMessage(int code, java.lang.Object[] params)
          formats a message
 NotificationCollector getCollector()
          Retrieves this Logger's notification collector
 LoggerConfiguration getConfiguration()
          Retrieves this Logger's configuration object
 long getDebugMask()
          Returns the current debug mask
 int getMessageType(int code)
           
abstract  void info(int code, java.lang.Object[] params)
           
abstract  void info(int code, java.lang.Object[] params, java.lang.Throwable t)
           
abstract  void info(java.lang.String message)
           
abstract  void info(java.lang.String message, java.lang.Throwable t)
           
abstract  boolean isDebugEnabled()
           
 void setCollector(NotificationCollector c)
          Sets a new notification collector object for this logger proxy.
 void setConfiguration(LoggerConfiguration c)
          Sets a new logger configuration object for this logger proxy.
 void setDebugMask(long mask)
          Sets the debug mask.
abstract  void setLevel(int lev)
           
abstract  void setLoggerClass(java.lang.Class name)
          Sets the backing logger's name by using a Class object
abstract  void setLoggerName(java.lang.String name)
          Sets the backing logger's name
 void severe(int code, java.lang.String message)
           
 void severe(int code, java.lang.String message, java.lang.Throwable t)
           
protected  boolean testDebugMask(long flags)
          Logic for testing against the mask
abstract  void warn(int code, java.lang.Object[] params)
           
abstract  void warn(int code, java.lang.Object[] params, java.lang.Throwable t)
           
abstract  void warn(int code, java.lang.String message)
           
abstract  void warn(int code, java.lang.String message, java.lang.Throwable t)
           
abstract  void warn(java.lang.String message)
           
 void warning(int code, java.lang.String message)
           
 void warning(int code, java.lang.String message, java.lang.Throwable t)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

kDebugAllString

public static final java.lang.String kDebugAllString
See Also:
Constant Field Values

collector

protected NotificationCollector collector
The collector object for notifications/errors/warnings, possibly wrapped into an ILException at some later time.


configuration

protected LoggerConfiguration configuration
The configuration for this logger


debugMask

protected long debugMask
The debug mask to use

Constructor Detail

LoggerDelegate

public LoggerDelegate()
The only constructor to be supported.

Method Detail

getCollector

public NotificationCollector getCollector()
Retrieves this Logger's notification collector

Returns:
the NotificationCollector object

setCollector

public void setCollector(NotificationCollector c)
Sets a new notification collector object for this logger proxy.

Parameters:
c - the NotificationCollector to set

getConfiguration

public LoggerConfiguration getConfiguration()
Retrieves this Logger's configuration object

Returns:
the LoggerConfiguration object

setConfiguration

public void setConfiguration(LoggerConfiguration c)
Sets a new logger configuration object for this logger proxy.

Parameters:
c - the LoggerConfiguration to set

setLoggerName

public abstract void setLoggerName(java.lang.String name)
Sets the backing logger's name

Parameters:
name - the logger name

setLoggerClass

public abstract void setLoggerClass(java.lang.Class name)
Sets the backing logger's name by using a Class object

Parameters:
name - the Class from which the logger's name should be generated

configure

public static void configure()
Configure the logging system.


configure

public static void configure(java.util.Properties props)
Configure the logging system using a Properties object.

Parameters:
props - the property object to use

setDebugMask

public void setDebugMask(long mask)
Sets the debug mask. LoggerDelegates should only execute the debug method when the passed value matches at least at one bit position with the current mask.

Parameters:
mask - the mask to set, i.e. the flags enabled

getDebugMask

public long getDebugMask()
Returns the current debug mask

Returns:

testDebugMask

protected boolean testDebugMask(long flags)
Logic for testing against the mask

Parameters:
flags - the flags of the debug message
Returns:
true when the message should be printed, i.e. it passes the mask

config

public void config(java.lang.String message)

entering

public void entering(java.lang.String message)

exiting

public void exiting(java.lang.String message)

fine

public void fine(java.lang.String message)

fine

public void fine(java.lang.String message,
                 java.lang.Throwable t)

finer

public void finer(java.lang.String message)

finer

public void finer(java.lang.String message,
                  java.lang.Throwable t)

finest

public void finest(java.lang.String message)

finest

public void finest(java.lang.String message,
                   java.lang.Throwable t)

warning

public void warning(int code,
                    java.lang.String message)

warning

public void warning(int code,
                    java.lang.String message,
                    java.lang.Throwable t)

severe

public void severe(int code,
                   java.lang.String message)

severe

public void severe(int code,
                   java.lang.String message,
                   java.lang.Throwable t)

setLevel

public abstract void setLevel(int lev)

isDebugEnabled

public abstract boolean isDebugEnabled()

debug

public abstract void debug(long flags,
                           java.lang.String message)

debug

public abstract void debug(long flags,
                           java.lang.String message,
                           java.lang.Throwable t)

debug

public abstract void debug(long flags,
                           int code,
                           java.lang.Object[] params)

debug

public abstract void debug(long flags,
                           int code,
                           java.lang.Object[] params,
                           java.lang.Throwable t)

info

public abstract void info(java.lang.String message)

info

public abstract void info(java.lang.String message,
                          java.lang.Throwable t)

info

public abstract void info(int code,
                          java.lang.Object[] params)

info

public abstract void info(int code,
                          java.lang.Object[] params,
                          java.lang.Throwable t)

warn

public abstract void warn(java.lang.String message)

warn

public abstract void warn(int code,
                          java.lang.String message)

warn

public abstract void warn(int code,
                          java.lang.String message,
                          java.lang.Throwable t)

warn

public abstract void warn(int code,
                          java.lang.Object[] params)

warn

public abstract void warn(int code,
                          java.lang.Object[] params,
                          java.lang.Throwable t)

error

public abstract void error(java.lang.String message)

error

public abstract void error(java.lang.String message,
                           java.lang.Throwable t)

error

public abstract void error(int code,
                           java.lang.String message)

error

public abstract void error(int code,
                           java.lang.String message,
                           java.lang.Throwable t)

error

public abstract void error(int code,
                           java.lang.Object[] params)

error

public abstract void error(int code,
                           java.lang.Object[] params,
                           java.lang.Throwable t)

fatal

public abstract void fatal(java.lang.String message)

fatal

public abstract void fatal(int code,
                           java.lang.String message)

fatal

public abstract void fatal(int code,
                           java.lang.String message,
                           java.lang.Throwable t)

fatal

public abstract void fatal(int code,
                           java.lang.Object[] params)

fatal

public abstract void fatal(int code,
                           java.lang.Object[] params,
                           java.lang.Throwable t)

formatMessage

protected java.lang.String formatMessage(int code,
                                         java.lang.Object[] params)
formats a message


getMessageType

public int getMessageType(int code)

existsMessage

public boolean existsMessage(int code)
Test if the numbered message does exist.

Parameters:
code -
Returns: