All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class guinea.util.Logger

java.lang.Object
   |
   +----guinea.util.Logger

public class Logger

extends Object

Variable Index

· BRIEF

· consoleLogLevel

· DEBUG

· defaultVerbosity

Default verbosity level.

· defFacilityName

· ERROR

· levelStrings

Logging levels as strings.

· logFileName

· logFormat

· LOGLEVEL_BRIEF

· LOGLEVEL_DEBUG

· LOGLEVEL_ERROR

· LOGLEVEL_NORMAL

· LOGLEVEL_SILENT

· LOGLEVEL_VERBOSE

· LOGLEVEL_VERYVERBOSE

· logPattern

Text formatting pattern for logging to a file.

· logScreenFormat

· logScreenPattern

Text formatting pattern for logging to console.

· logWriter

· NORMAL

· NOTICE

· SILENT

· VERBOSE

· VERYVERBOSE

· WARNING

Constructor Index

· Logger()

Method Index

· brief(String)

· closeLog()

Close log file.

· debug(String)

· finalize()

Finalize logger object.

· flog(String, int, Exception)

Log an exception to log.

· flog(String, int, String)

Log message to log.

· flush()

Flush logging file.

· getLevel()

· getLevel(String)

· isLogged(String, int)

· log(String, int, Exception)

Log message to log.

· log(String, int, String)

Log message to log.

· logError(Exception)

Log an exception to log.

· logError(String)

Log a message to log.

· logError(String, Exception)

Log an exception to log.

· logError(String, String)

Log a message to log.

· main(String[])

· normal(String)

· setConsoleLogLevel(int)

· setConsoleLogLevel(String)

· setLogFile(String)

Set file name of logging file and open it for writing.

· setLogLevel(int)

· setLogLevel(String)

· setLogLevel(String, int)

· setLogLevels(Properties)

· setVerbosity(int)

· setVerbosity(String)

· silent(String)

· stringToLevel(String)

· verbose(String)

· veryverbose(String)

· warning(String)

Variables

 protected static final String levelStrings[]

Logging levels as strings.

 public static final int ERROR

 public static final int LOGLEVEL_ERROR

 public static final int SILENT

 public static final int LOGLEVEL_SILENT

 public static final int WARNING

 public static final int BRIEF

 public static final int LOGLEVEL_BRIEF

 public static final int NOTICE

 public static final int NORMAL

 public static final int LOGLEVEL_NORMAL

 public static final int VERBOSE

 public static final int LOGLEVEL_VERBOSE

 public static final int VERYVERBOSE

 public static final int LOGLEVEL_VERYVERBOSE

 public static final int DEBUG

 public static final int LOGLEVEL_DEBUG

 protected String logPattern

Text formatting pattern for logging to a file. Parameter 0 is the date, parameter 1 is the severity level as a number, and parameter 2 is the 'facility' that send this report. The text of the report is appended at the end of this header.

 protected String logScreenPattern

Text formatting pattern for logging to console. This is same as the file log pattern but without the time and date. .

 protected MessageFormat logFormat

 protected MessageFormat logScreenFormat

 protected int defaultVerbosity

Default verbosity level. The default is NORMAL.

 protected String defFacilityName

 protected String logFileName

 protected transient PrintWriter logWriter

 protected int consoleLogLevel

Constructors

 public Logger()

Methods

 public void setVerbosity(int level)

 public void setLogLevel(int level)

 public void setVerbosity(String level)

 public void setLogLevel(String level)

 public void setConsoleLogLevel(String level)

 public void setConsoleLogLevel(int level)

 public void setLogLevels(Properties p)

 public void setLogLevel(String facility,
                         int level)

 protected int stringToLevel(String level)

 public int getLevel(String facility)

 public int getLevel()

 public boolean isLogged(String facility,
                         int level)

 public final boolean debug(String facility)

 public final boolean verbose(String facility)

 public final boolean veryverbose(String facility)

 public final boolean brief(String facility)

 public final boolean normal(String facility)

 public final boolean silent(String facility)

 public final boolean warning(String facility)

 public boolean log(String facility,
                    int level,
                    String msg)

Log message to log.

Parameters:

facility - Who sent (which module, etc.) sent this message. If null, default facility is used.

level - Logging level of this message (severity).

msg - Message to save to log.

Returns:

True if this message was saved to log, false if not.

 public boolean log(String facility,
                    int level,
                    Exception ex)

Log message to log.

Parameters:

facility - Who sent (which module, etc.) sent this message. If null, default facility is used.

level - Logging level of this message (severity).

ex - An exception to print to the log.

Returns:

True if this message was saved to log, false if not.

 public void flog(String facility,
                  int level,
                  String msg)

Log message to log. This is a fast version that doesn't check whether the message should be logged. This is usually used to force logging a message or the need for logging was just checked earlier in current block, for example. The log() methods use this method after they have determined that this message should be saved.

Parameters:

facility - Who sent (which module, etc.) sent this message. If null, default facility is used.

level - Logging level of this message (severity).

msg - Message to save to log.

 public void flog(String facility,
                  int level,
                  Exception ex)

Log an exception to log. This is a fast version that doesn't check whether the message should be logged. This is usually used to force logging a message or the need for logging was just checked earlier in current block, for example. The log() methods use this method after they have determined that this message should be saved.

Parameters:

facility - Who sent (which module, etc.) sent this message. If null, default facility is used.

level - Logging level of this message (severity).

ex - An exception to print to the log. The stack trace of the exception is printed.

 public void logError(String facility,
                      Exception ex)

Log an exception to log. This version does not check whether the message should be logged (errors generally should be saved anyway).

Parameters:

facility - Who sent (which module, etc.) sent this message. If null, default facility is used.

ex - An exception to print to the log. The stack trace of the exception is printed.

 public void logError(String facility,
                      String msg)

Log a message to log. This version does not check whether the message should be logged (errors generally should be saved anyway).

Parameters:

facility - Who sent (which module, etc.) sent this message. If null, default facility is used.

msg - Message to save to log.

 public void logError(String msg)

Log a message to log. This version does not check whether the message should be logged (errors generally should be saved anyway). Default facility is used as the facility.

Parameters:

msg - Message to save to log.

 public void logError(Exception ex)

Log an exception to log. This version does not check whether the message should be logged (errors generally should be saved anyway). Default facility is used as the facility.

Parameters:

ex - An exception to print to the log. The stack trace of the exception is printed.

 public synchronized void setLogFile(String name) throws IOException

Set file name of logging file and open it for writing.

Parameters:

name - File name of logging file.

Throws: IOException

If an error happened opening log file.

 public synchronized void closeLog()

Close log file. A message about file being closed is saved to file and the file is flushed and closed.

 public synchronized void flush()

Flush logging file.

 protected void finalize() throws Throwable

Finalize logger object. This closes the log if it is still open.

Throws: Throwable

If an exception is thrown for some reason. Generally, this should not happen.

Overrides:

finalize in class Object

See Also:

closeLog

 public static void main(String args[]) throws Exception

All Packages  Class Hierarchy  This Package  Previous  Next  Index