com.plealog.genericapp.api.log

Class EZLoggerManager

java.lang.Object

com.plealog.genericapp.api.log.EZLoggerManager

public class EZLoggerManager
extends Object

Utility class to setup logging system. This class is a convenient wrapper to setup default Java Logging system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EZLoggerManager.LogLevel

Constructor Summary

Constructors

Constructor and Description
EZLoggerManager()

Method Summary

Methods

Modifier and Type	Method and Description
static void	enableConsoleLogger(boolean enable) Figures out whether or not the default Java Logging Console logger has to be enabled.
static void	enableFileLogger(String fileName, boolean append) Figures out whether or not a file logger has to be enabled.
static void	enableUILogger(boolean enable, int sizeLimit) Figures out whether or not the UI logger has to be enabled.
static EZLoggerManager.LogLevel	getLevel() Returns the current log level.
static JComponent	getUILogger() Returns the UI Logger component.
static void	initialize() Call this method to setup the logging framework.
protected static boolean	isInitialized() For internal use only.
static void	setConsoleLoggerFormatter(Formatter formatter) Sets the console logger formatter.
static void	setFileLoggerFormatter(Formatter formatter) Sets the file logger formatter.
static void	setLevel(EZLoggerManager.LogLevel lvl) Set the log level.
static void	setUILoggerFormatter(Formatter formatter) Sets the UI logger formatter.
protected static void	updateLevel(EZLoggerManager.LogLevel lvl) For internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

EZLoggerManager

public EZLoggerManager()

Method Detail

setLevel

public static void setLevel(EZLoggerManager.LogLevel lvl)

Set the log level. This method can be called before and after initialize() method. Default is INFO level. EZLoggerManager only handles SEVERE, WARNING, INFO and CONFIG levels. CONFIG level is used as a DEBUG-like level.

Parameters:

lvl - the log level.

updateLevel

protected static void updateLevel(EZLoggerManager.LogLevel lvl)

For internal use only.

getLevel

public static EZLoggerManager.LogLevel getLevel()

Returns the current log level.

enableConsoleLogger

public static void enableConsoleLogger(boolean enable)

Figures out whether or not the default Java Logging Console logger has to be enabled. Default is true.

Parameters:

enable - use true to enable console logger, false otherwise.

enableUILogger

public static void enableUILogger(boolean enable,
                  int sizeLimit)

Figures out whether or not the UI logger has to be enabled. Default is false.

Parameters:

enable - use true to enable UI logger, false otherwise.

enableFileLogger

public static void enableFileLogger(String fileName,
                    boolean append)
                             throws IOException

Figures out whether or not a file logger has to be enabled. Default is false.

Parameters:

fileName - the file name to use. Parameter can be a simple file name, or a full path to a file.

append - use true to append log content to the file over application sessions.

Throws:

IOException - if file cannot be created.

setConsoleLoggerFormatter

public static void setConsoleLoggerFormatter(Formatter formatter)

Sets the console logger formatter. Default is SimpleFormatter. See java.util.logging.SimpleFormatter.

setUILoggerFormatter

public static void setUILoggerFormatter(Formatter formatter)

Sets the UI logger formatter. Default is SimpleFormatter. See java.util.logging.SimpleFormatter.

setFileLoggerFormatter

public static void setFileLoggerFormatter(Formatter formatter)

Sets the file logger formatter. Default is SimpleFormatter. See java.util.logging.SimpleFormatter.

initialize

public static void initialize()

Call this method to setup the logging framework. A call to this method has to be done after calling the various enableXXX() and setXXX() methods of this class, as needed.

isInitialized

protected static boolean isInitialized()

For internal use only.

getUILogger

public static JComponent getUILogger()

Returns the UI Logger component.