Package lazyj

Class Log

java.lang.Object
lazyj.Log
public final class Log
extends java.lang.Object
Logging facility. Provides package- and class-based logging level and destination folder.
Since:
2006-10-16
Author:
costing

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int ERROR
    Constant for the ERROR log level
    static int FATAL
    Constant for the FATAL log level
    static int FINE
    Constant for the FINE log level
    static int FINER
    Constant for the FINER log level
    static int FINEST
    Constant for the FINEST log level
    static int INFO
    Constant for the INFO log level
    static int WARNING
    Constant for the WARNING log level

  • Constructor Summary

    Constructors 
    Constructor Description
    Log()  

  • Method Summary

    Modifier and Type Method Description
    static java.lang.Integer getLevel​(java.lang.String sComponent)
    Get the current logging level for a component
    static java.lang.String getLogDir​(java.lang.String sComponent)
    For a given component, get the folder where the log files should be put.
    static boolean isLoggable​(int level, java.lang.String sComponent)
    Check if a message of a given level for a given component will be actually logged.
    static void log​(int level, java.lang.String sMessage)
    Log a message of a given severity for a given component
    static void log​(int level, java.lang.String sComponent, java.lang.String sMessage)
    Log a message of a given severity for a given component
    static void log​(int level, java.lang.String sComponent, java.lang.String sMessage, java.lang.Object o)
    Log a message of a given severity for a given component, with an attached object.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • Log

      public Log()

  • Method Details

    • getLevel

      public static java.lang.Integer getLevel​(java.lang.String sComponent)
      Get the current logging level for a component
      Parameters:
      sComponent - component to get the level for
      Returns:
      the logging level

    • getLogDir

      public static java.lang.String getLogDir​(java.lang.String sComponent)
      For a given component, get the folder where the log files should be put.
      Parameters:
      sComponent - component (class hierarchy)
      Returns:
      the target log dir

    • isLoggable

      public static boolean isLoggable​(int level, java.lang.String sComponent)
      Check if a message of a given level for a given component will be actually logged. If it would not be logged then it makes no sense to try to log the message in the first place. You should use the logger with constructions like this when the log message is complicated to build:
       if (Log.isLoggable(Log.DEBUG, "class.name")){
     Log.log(Log.DEBUG, "class.name", "Some complicated message here : "+object.toString());
 }
      Parameters:
      level - desired logging level
      sComponent - component
      Returns:
      true if the message will be logged, false otherwise

    • log

      public static void log​(int level, java.lang.String sMessage)
      Log a message of a given severity for a given component
      Parameters:
      level - severity of the message. Check the constants in this class for possible values.
      sMessage - message to log

    • log

      public static void log​(int level, java.lang.String sComponent, java.lang.String sMessage)
      Log a message of a given severity for a given component
      Parameters:
      level - severity of the message. Check the constants in this class for possible values.
      sComponent - component name. Usually "servlet_zone/servlet_name", but could be the class name or something else you want
      sMessage - message to log

    • log

      public static void log​(int level, java.lang.String sComponent, java.lang.String sMessage, java.lang.Object o)
      Log a message of a given severity for a given component, with an attached object.
      Parameters:
      level - severity of the message. Check the constants in this class for possible values.
      sComponent - component name. Usually "servlet_zone/servlet_name", but could be the class name or something else you want
      sMessage - message to log
      o - object to attach, it is intended for use with a Throwable here, but works for any other objects too by invoking the .toString() method on them