org.brains2b.log
Class Logger

java.lang.Object
  java.util.logging.Logger
      org.brains2b.log.Logger

public class Logger

extends java.util.logging.Logger

Prints log messages to selected output or if not set to default output on the basis of a defined outputlevel and Logger level

Logger writes output to a defined output on the basis of the following rules
• All output send to println(String) is always written to System.out or if set to an defined output
• All output send to println(String,level) are written to the output if the Logger-level is equal or lower than the level given.
• All output with a level set to Error and the printException functions are written to System.err or a defined output stream.

The following levels are recognized in order in which they will get printed
• PANIC
• INFO
• ERROR
• WARNING
• TRACE, wil also print the stack traces for any possible errors
• DEBUG
• DEBUG_VERBOSE, same as DEBUG, but for DEBUG statements that might influence performance and should not be run to often.

  The default level of the Logger is ERROR, so all panic,info and error messages are written.
  

  You can influence the behaviour of Logger through properties. Those properties can either be defined by setting System properties or by placing a file named logger.properties in the root for the java application or in a directory conf/ in that root.

  A property can be defined on either of these levels. If they are defined on both levels the System properties will overwrite the file properties.

  The following properties are recognized:
  • logger.level The level for the Logger
  • logger.err.out A filename to which to write the error output
  • logger.std.out A filename to which to write the standard output

  Version:

  {$Revision} {$Date}

  Author:

  dennis@brains2b.nl

  Nested Class Summary

  static class

  Logger.ClassicFormatter Implementation of Formatter to be consistant with The old-style Logger's formatting

  Field Summary

  static int	DEBUG
  static int	DEBUG_VERBOSE Output level for DEBUG statements which might have a notable influence on the overal performance.
  static int	ERROR
  static int	INFO
  static int	PANIC
  static int	TRACE
  static int	WARNING

  Fields inherited from class java.util.logging.Logger

  global

  Constructor Summary

  protected

  Logger(java.lang.String name, java.lang.String resourceBundle)

  Method Summary

  static Logger	getLogger() get the default TwelBox logger
  protected static Logger	instance() Deprecated. use getLogger() instead
  static void	print(java.lang.Object o) Prints the Object to the standard or defined output, irrespective of the level
  static void	print(java.lang.Object o, int level) Prints the Object to the standard or defined output, if the level given is smaller or equal to the Logger.level
  static void	printException(java.lang.Exception ex) Uses printException(String,Exception) to write the Exception message to the standard or defined error stream if the level of logger is greater or equal to ERROR, and writing the complete stack trace underneath if the logger is set to DEBUG or DEBUG_VERBOSE.
  static void	printException(java.lang.String message, java.lang.Exception ex) Writes the message to the standard or defined error stream if the level of logger is greater or equal to ERROR, writes the complete stack trace underneath if the logger is set to DEBUG or DEBUG_VERBOSE.
  static void	println(java.lang.String str) Prints the String to the standard or defined output, irrespective of the level
  static void	println(java.lang.String str, int level) Prints the String to the standard or defined output, if the level given is smaller or equal to the Logger.level
  static void	setLevel(int level) sets the Logger level programmatically.

  Methods inherited from class java.util.logging.Logger

  addHandler, config, entering, entering, entering, exiting, exiting, fine, finer, finest, getAnonymousLogger, getAnonymousLogger, getFilter, getHandlers, getLevel, getLogger, getLogger, getName, getParent, getResourceBundle, getResourceBundleName, getUseParentHandlers, info, isLoggable, log, log, log, log, log, logp, logp, logp, logp, logrb, logrb, logrb, logrb, removeHandler, setFilter, setLevel, setParent, setUseParentHandlers, severe, throwing, warning

  Methods inherited from class java.lang.Object

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

  Field Detail

  PANIC

  public static final int PANIC

  See Also:

  Constant Field Values

  INFO

  public static final int INFO

  See Also:

  Constant Field Values

  ERROR

  public static final int ERROR

  See Also:

  Constant Field Values

  WARNING

  public static final int WARNING

  See Also:

  Constant Field Values

  TRACE

  public static final int TRACE

  See Also:

  Constant Field Values

  DEBUG

  public static final int DEBUG

  See Also:

  Constant Field Values

  DEBUG_VERBOSE

  public static final int DEBUG_VERBOSE

  Output level for DEBUG statements which might have a notable influence on the overal performance.

  Since:

  TwelBox 0.31

  See Also:

  Constant Field Values

  Constructor Detail

  Logger

  protected Logger(java.lang.String name,
                   java.lang.String resourceBundle)

  Method Detail

  instance

  protected static Logger instance()

  Deprecated. use getLogger() instead

  Creates an instance of Logger if non existed and stores the instance into a static member.

  just a Singleton implementation

  Returns:

  Logger

  getLogger

  public static Logger getLogger()

  get the default TwelBox logger

  setLevel

  public static void setLevel(int level)

  sets the Logger level programmatically. Using this function frequently might not highten the predicatibility of the output.

  It was implemented for test purposes only

  Parameters:

  level - int, the print level.

  println

  public static void println(java.lang.String str)

  Prints the String to the standard or defined output, irrespective of the level

  Parameters:

  str - String

  print

  public static void print(java.lang.Object o)

  Prints the Object to the standard or defined output, irrespective of the level

  Parameters:

  o - Object

  See Also:

  Object.toString()

  println

  public static void println(java.lang.String str,
                             int level)

  Prints the String to the standard or defined output, if the level given is smaller or equal to the Logger.level

  Parameters:

  str - String

  level - int

  print

  public static void print(java.lang.Object o,
                           int level)

  Prints the Object to the standard or defined output, if the level given is smaller or equal to the Logger.level

  Parameters:

  o - Object

  level - int

  See Also:

  Object.toString()

  printException

  public static void printException(java.lang.String message,
                                    java.lang.Exception ex)

  Writes the message to the standard or defined error stream if the level of logger is greater or equal to ERROR, writes the complete stack trace underneath if the logger is set to DEBUG or DEBUG_VERBOSE.

  Parameters:

  message - String

  ex - Exception

  printException

  public static void printException(java.lang.Exception ex)

  Uses printException(String,Exception) to write the Exception message to the standard or defined error stream if the level of logger is greater or equal to ERROR, and writing the complete stack trace underneath if the logger is set to DEBUG or DEBUG_VERBOSE.

  Parameters:

  ex - Exception

  See Also:

  printException(String, Exception)