src/org/lwes/util/Log.java

   1 package org.lwes.util;
   2
   3 import java.util.logging.Level;
   4 import java.util.logging.Logger;
   5
   6 /**
   7  * This is a wrapper class for logging.  Instead of embedding log4j or JDK logging
   8  * statements in the code, we have a wrapper around JDK logging so this could be changed
   9  * easily in the future.  Also, since we prefer the distribution to be simple and
  10  * standalone, we aren't using Commons Logging so that we don't have to bundle that in
  11  * the distribution.  JDK logging could easily be redirected to the destination of the
  12  * library user's choice.
  13  *
  14  * @author Michael P. Lum
  15  */
  16 public class Log {
  17         private static Logger logger = Logger.getLogger("org.lwes");
  18
  19     /**
  20      * Check if debug logging is turned on. This should *always* be called
  21      * before calling Log.debug.
  22      *
  23      * @return true if debug logging is on.
  24      */
  25     public static boolean isLogDebug() {
  26         return logger.isLoggable(Level.FINER);
  27     }
  28
  29     /**
  30      * Check if trace logging is turned on. This should *always* be called
  31      * before calling Log.trace.
  32      *
  33      * @return true if trace logging is on.
  34      */
  35     public static boolean isLogTrace() {
  36         return logger.isLoggable(Level.FINEST);
  37     }
  38
  39     /**
  40      * Check if info logging is turned on. This should *always* be called
  41      * before calling Log.info.
  42      *
  43      * @return true if info logging is on.
  44      */
  45     public static boolean isLogInfo() {
  46         return logger.isLoggable(Level.FINE);
  47     }
  48
  49         /**
  50          * Log a trace level message
  51          * @param message the message to be logged
  52          */
  53         public static void trace(String message) {
  54                 logger.log(Level.FINEST, message);
  55         }
  56
  57         /**
  58          * Log a debug level message
  59          * @param message the message to be logged
  60          */
  61         public static void debug(String message) {
  62                 logger.log(Level.FINER, message);
  63         }
  64
  65         /**
  66          * Log a info level message
  67          * @param message the message to be logged
  68          */
  69         public static void info(String message) {
  70                 logger.log(Level.FINE, message);
  71         }
  72
  73         /**
  74          * Log a warning level message
  75          * @param message the message to be logged
  76          */
  77         public static void warning(String message) {
  78                 logger.log(Level.WARNING, message);
  79         }
  80
  81         /**
  82          * Log an warning level message, with associated Throwable information
  83          * @param message the message to be logged
  84          * @param t the Throwable associated with the log message
  85          */
  86         public static void warning(String message, Throwable t) {
  87                 logger.log(Level.WARNING, message, t);
  88         }
  89
  90
  91         /**
  92          * Log an error level message
  93          * @param message the message to be logged
  94          */
  95         public static void error(String message) {
  96                 logger.log(Level.SEVERE, message);
  97         }
  98
  99         /**
 100          * Log an error level message, with associated Throwable information
 101          * @param message the message to be logged
 102          * @param t the Throwable associated with the log message
 103          */
 104         public static void error(String message, Throwable t) {
 105                 logger.log(Level.SEVERE, message, t);
 106         }
 107 }