File	Doc	Category	Size	Date	Package
Logger.java	API Doc	Glassfish v2 API	22350	Fri May 04 22:35:24 BST 2007	com.sun.jdo.spi.persistence.utility.logging

Logger

Fields Summary
public static final int	OFF OFF is a special level that can be used to turn off logging.
public static final int	SEVERE SEVERE is a message level indicating a serious failure. In general SEVERE messages should describe events that are of considerable importance and which will prevent normal program execution. They should be reasonably intelligible to end users and to system administrators.
public static final int	WARNING WARNING is a message level indicating a potential problem. In general WARNING messages should describe events that will be of interest to end users or system managers, or which indicate potential problems.
public static final int	INFO INFO is a message level for informational messages. Typically INFO messages will be written to the console or its equivalent. So the INFO level should only be used for reasonably significant messages that will make sense to end users and system admins.
public static final int	CONFIG CONFIG is a message level for static configuration messages. CONFIG messages are intended to provide a variety of static configuration information, to assist in debugging problems that may be associated with particular configurations. For example, CONFIG message might include the CPU type, the graphics depth, the GUI look-and-feel, etc.
public static final int	FINE FINE is a message level providing tracing information. All of FINE, FINER, and FINEST are intended for relatively detailed tracing. The exact meaning of the three levels will vary between subsystems, but in general, FINEST should be used for the most voluminous detailed output, FINER for somewhat less detailed output, and FINE for the lowest volume (and most important) messages. In general the FINE level should be used for information that will be broadly interesting to developers who do not have a specialized interest in the specific subsystem. FINE messages might include things like minor (recoverable) failures. Issues indicating potential performance problems are also worth logging as FINE.
public static final int	FINER FINER indicates a fairly detailed tracing message. By default logging calls for entering, returning, or throwing an exception are traced at this level.
public static final int	FINEST FINEST indicates a highly detailed tracing message
public static final int	ALL ALL indicates that all messages should be logged.

Constructors Summary

Methods Summary
public void	config(java.lang.String msg) Log a CONFIG message. If the logger is currently enabled for the CONFIG message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog)
public void	entering(java.lang.String sourceClass, java.lang.String sourceMethod) Log a method entry. This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY", log level FINER, and the given sourceMethod and sourceClass is logged. param sourceClass name of class that issued the logging request param sourceMethod name of method that is being entered
public void	entering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object param1) Log a method entry, with one parameter. This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY {0}", log level FINER, and the given sourceMethod, sourceClass, and parameter is logged. param sourceClass name of class that issued the logging request param sourceMethod name of method that is being entered param param1 parameter to the method being entered
public void	entering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object[] params) Log a method entry, with an array of parameters. This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY" (followed by a format {N} indicator for each entry in the parameter array), log level FINER, and the given sourceMethod, sourceClass, and parameters is logged. param sourceClass name of class that issued the logging request param sourceMethod name of method that is being entered param params array of parameters to the method being entered
public void	exiting(java.lang.String sourceClass, java.lang.String sourceMethod) Log a method return. This is a convenience method that can be used to log returning from a method. A LogRecord with message "RETURN", log level FINER, and the given sourceMethod and sourceClass is logged. param sourceClass name of class that issued the logging request param sourceMethod name of the method
public void	exiting(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object result) Log a method return, with result object. This is a convenience method that can be used to log returning from a method. A LogRecord with message "RETURN {0}", log level FINER, and the gives sourceMethod, sourceClass, and result object is logged. param sourceClass name of class that issued the logging request param sourceMethod name of the method param result Object that is being returned
public void	fine(java.lang.String msg) Log a message. If the logger is currently enabled for the message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog)
public void	fine(java.lang.String msg, java.lang.Object o1) Log a FINE message. If the logger is currently enabled for the FINE message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message
public void	fine(java.lang.String msg, java.lang.Object[] o) Log a FINE message. If the logger is currently enabled for the FINE message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o Objects to be inserted into the message
public void	fine(java.lang.String msg, java.lang.Object o1, java.lang.Object o2) Log a FINE message. If the logger is currently enabled for the FINE message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message
public void	fine(java.lang.String msg, java.lang.Object o1, java.lang.Object o2, java.lang.Object o3) Log a FINE message. If the logger is currently enabled for the FINE message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message param o3 A parameter to be inserted into the message
public void	finer(java.lang.String msg) Log a FINER message. If the logger is currently enabled for the FINER message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog)
public void	finer(java.lang.String msg, java.lang.Object[] o) Log a FINER message. If the logger is currently enabled for the FINER message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o Objects to be inserted into the message
public void	finer(java.lang.String msg, java.lang.Object o1) Log a FINER message. If the logger is currently enabled for the FINER message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message
public void	finer(java.lang.String msg, java.lang.Object o1, java.lang.Object o2) Log a FINER message. If the logger is currently enabled for the FINER message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message
public void	finer(java.lang.String msg, java.lang.Object o1, java.lang.Object o2, java.lang.Object o3) Log a FINER message. If the logger is currently enabled for the FINER message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message param o3 A parameter to be inserted into the message
public void	finest(java.lang.String msg) Log a FINEST message. If the logger is currently enabled for the FINEST message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog)
public void	finest(java.lang.String msg, java.lang.Object[] o) Log a FINEST message. If the logger is currently enabled for the FINEST message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o Objects to be inserted into the message
public void	finest(java.lang.String msg, java.lang.Object o1) Log a FINEST message. If the logger is currently enabled for the FINEST message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message
public void	finest(java.lang.String msg, java.lang.Object o1, java.lang.Object o2) Log a FINEST message. If the logger is currently enabled for the FINEST message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message
public void	finest(java.lang.String msg, java.lang.Object o1, java.lang.Object o2, java.lang.Object o3) Log a FINEST message. If the logger is currently enabled for the FINEST message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message param o3 A parameter to be inserted into the message
public java.lang.String	getName() Get the name for this logger. return logger name. Will be null for anonymous Loggers.
public void	info(java.lang.String msg) Log an INFO message. If the logger is currently enabled for the INFO message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog)
public boolean	isLoggable() Test if this logger is logging messages. This is a test for log level FINE, FINER, or FINEST. If the log message is expensive to construct, this method should be used to determine whether it is a waste of time. We don't expose isLoggable(Level) because Level is not available in JDK 1.3. Once this is not an issue, we can add isLoggable(Level). return if FINE, FINER, or FINEST is currently being logged
public boolean	isLoggable(int level) Test if this logger is logging messages at the specific level. If the log message is expensive to construct, this method should be used to determine whether it is a waste of time. We don't expose isLoggable(Level) because Level is not available in JDK 1.3. Once this is not an issue, we can add isLoggable(Level). return if this level is currently being logged param level The level to be tested
public void	log(int level, java.lang.String msg) Log a message. If the logger is currently enabled for the message level then the given message is forwarded to all the registered output Handler objects. param level The level for this message param msg The string message (or a key in the message catalog)
public void	log(int level, java.lang.String msg, java.lang.Object o1) Log a message. If the logger is currently enabled for the message level then the given message is forwarded to all the registered output Handler objects. param level The level for this message param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message
public void	log(int level, java.lang.String msg, java.lang.Object[] o) Log a message. If the logger is currently enabled for the message level then the given message is forwarded to all the registered output Handler objects. param level The level for this message param msg The string message (or a key in the message catalog) param o Objects to be inserted into the message
public void	log(int level, java.lang.String msg, java.lang.Object o1, java.lang.Object o2) Log a message. If the logger is currently enabled for the message level then the given message is forwarded to all the registered output Handler objects. param level The level for this message param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message
public void	log(int level, java.lang.String msg, java.lang.Object o1, java.lang.Object o2, java.lang.Object o3) Log a message. If the logger is currently enabled for the message level then the given message is forwarded to all the registered output Handler objects. param level The level for this message param msg The string message (or a key in the message catalog) param o1 A parameter to be inserted into the message param o2 A parameter to be inserted into the message param o3 A parameter to be inserted into the message
public void	log(int level, java.lang.String msg, java.lang.Throwable thrown) Log a message. If the logger is currently enabled for the message level then the given message, and the exception dump, is forwarded to all the registered output Handler objects. param level The level for this message param msg The string message (or a key in the message catalog) param thrown The exception to log
public void	severe(java.lang.String msg) Log a SEVERE message. If the logger is currently enabled for the SEVERE message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog)
public void	throwing(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Throwable thrown) Log throwing an exception. This is a convenience method to log that a method is terminating by throwing an exception. The logging is done using the FINER level. If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers. The LogRecord's message is set to "THROW". Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property. param sourceClass name of class that issued the logging request param sourceMethod name of the method. param thrown The Throwable that is being thrown.
public void	warning(java.lang.String msg) Log a WARNING message. If the logger is currently enabled for the WARNING message level then the given message is forwarded to all the registered output Handler objects. param msg The string message (or a key in the message catalog)