| java.lang.Object
 java.util.logging.Logger
| Logger | | public class Logger (Code) | | Loggers are used to log records to certain outputs, including file, console,
etc. They use various handlers to actually do the output-dependent
operations.
Client applications can get named loggers by calling the methods
getLogger. They can also get anonymous loggers by calling the
methods getAnonymousLogger. Named loggers are organized in a
namespace hierarchy managed by a log manager. The naming convention is
usually the same as java package's naming convention, i.e., using
dot-separated strings. Anonymous loggers do not belong to any namespace.
Loggers "inherit" log level setting from their parent if its own level is set
to null. This is also true for the resource bundle. The
logger's resource bundle is used to localize the log messages if no resource
bundle name is given when a log method is called. If
getUseParentHandlers is true, loggers also
inherit their parent's handlers. Here "inherit" only means the "behaviors"
are inherited. The internal fields value will not change, for example,
getLevel() still returns null.
When loading a given resource bundle, the logger first tries to use the
context classloader. If that fails, it tries the system classloader. And if
that still fails, it searches up the class stack and uses each class's
classloader to try to locate the resource bundle.
Some log methods accept log requests that do not specify the source class and
source method. In these cases, the logging framework will automatically infer
the calling class and method, but not guaranteed to be accurate.
Once a LogRecord object has been passed into the logging
framework, it is owned by the logging framework and the client applications
should not use it any longer.
All methods of this class are thread-safe.
See Also: LogManager |
| Field Summary | |
| final public static Logger | global
The global logger is provided as convenience for casual use. |
| Constructor Summary | |
| protected | Logger(String name, String resourceBundleName)
Constructs a Logger object with the supplied name and
resource bundle name. |
| Method Summary | |
| final void | addChild(Logger logger)
| | public void | addHandler(Handler handler)
Adds a handler to this logger. | | public void | config(String msg)
Logs a message of level Level.CONFIG. | | public void | entering(String sourceClass, String sourceMethod)
Logs a message indicating entering a method. | | public void | entering(String sourceClass, String sourceMethod, Object param)
Logs a message indicating entering a method. | | public void | entering(String sourceClass, String sourceMethod, Object[] params)
Logs a message indicating entering a method. | | public void | exiting(String sourceClass, String sourceMethod)
Logs a message indicating existing a method. | | public void | exiting(String sourceClass, String sourceMethod, Object result)
Logs a message indicating exiting a method. | | public void | fine(String msg)
Logs a message of level Level.FINE. | | public void | finer(String msg)
Logs a message of level Level.FINER. | | public void | finest(String msg)
Logs a message of level Level.FINEST. | | public static Logger | getAnonymousLogger()
Gets an anonymous logger to use internally in a thread. | | public static Logger | getAnonymousLogger(String resourceBundleName)
Gets an anonymous logger to use internally in a thread. | | public Filter | getFilter()
Gets the filter used by this logger. | | public Handler[] | getHandlers()
Gets all the handlers associated with this logger. | | public Level | getLevel()
Gets the logging level of this logger. | | public static Logger | getLogger(String name)
Gets a named logger. | | public static Logger | getLogger(String name, String resourceBundleName)
Gets a named logger associated with the supplied resource bundle. | | public String | getName()
Gets the name of this logger. | | public Logger | getParent()
Gets the parent of this logger in the namespace. | | public ResourceBundle | getResourceBundle()
Gets the loaded resource bundle used by this logger to localize logging
messages. | | public String | getResourceBundleName()
Gets the name of the loaded resource bundle used by this logger to
localize logging messages. | | public boolean | getUseParentHandlers()
Gets the flag which indicates whether to use parent's handlers to publish
incoming log records, potentially recursively up the namespace. | | public void | info(String msg)
Logs a message of level Level.INFO. | | void | internalSetParent(Logger newParent)
Sets the parent of this logger in the namespace. | | public boolean | isLoggable(Level l)
Determines whether this logger will actually log messages of the
specified level. | | static ResourceBundle | loadResourceBundle(String resourceBundleName)
Load the specified resource bundle, use privileged code. | | public void | log(Level logLevel, String msg)
Logs a message of the specified level. | | public void | log(Level logLevel, String msg, Object param)
Logs a message of the specified level with the supplied parameter. | | public void | log(Level logLevel, String msg, Object[] params)
Logs a message of the specified level with the supplied parameter array. | | public void | log(Level logLevel, String msg, Throwable thrown)
Logs a message of the specified level with the supplied
Throwable object. | | public void | log(LogRecord record)
Logs a given log record. | | public void | logp(Level logLevel, String sourceClass, String sourceMethod, String msg)
Logs a message of the given level with the specified source class name
and source method name. | | public void | logp(Level logLevel, String sourceClass, String sourceMethod, String msg, Object param)
Logs a message of the given level with the specified source class name
and source method name and parameter. | | public void | logp(Level logLevel, String sourceClass, String sourceMethod, String msg, Object[] params)
Logs a message of the given level with the specified source class name
and source method name and parameter array. | | public void | logp(Level logLevel, String sourceClass, String sourceMethod, String msg, Throwable thrown)
Logs a message of the given level with the specified source class name
and source method name and Throwable object. | | public void | logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg)
Logs a message of the given level with the specified source class name
and source method name, using the given resource bundle to localize the
message. | | public void | logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg, Object param)
Logs a message of the given level with the specified source class name
and source method name and parameter, using the given resource bundle to
localize the message. | | public void | logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg, Object[] params)
Logs a message of the given level with the specified source class name
and source method name and parameter array, using the given resource
bundle to localize the message. | | public void | logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg, Throwable thrown)
Logs a message of the given level with the specified source class name
and source method name and Throwable object, using the
given resource bundle to localize the message. | | final void | removeChild(Logger child)
| | public void | removeHandler(Handler handler)
Removes a handler for this logger. | | synchronized void | reset()
| | public void | setFilter(Filter newFilter)
Sets the filter used by this logger. | | public void | setLevel(Level newLevel)
Sets the logging level for this logger. | | void | setManager(LogManager manager)
| | public void | setParent(Logger parent)
Sets the parent of this logger in the namespace. | | public void | setUseParentHandlers(boolean notifyParentHandlers)
Sets the flag which indicates whether to use parent's handlers to publish
incoming log records, potentially recursively up the namespace. | | public void | severe(String msg)
Logs a message of level Level.SEVERE. | | public void | throwing(String sourceClass, String sourceMethod, Throwable thrown)
Logs a message indicating throwing an exception. | | public void | warning(String msg)
Logs a message of level Level.WARNING. |
| global | | final public static Logger global(Code) | | The global logger is provided as convenience for casual use.
|
| Logger | | protected Logger(String name, String resourceBundleName)(Code) | | Constructs a Logger object with the supplied name and
resource bundle name.
Parameters:
name - the name of this logger, may be null for anonymous loggers
Parameters:
resourceBundleName - the name of the resource bundle used to localize loggingmessages, may be null
throws:
MissingResourceException - If the specified resource bundle can not be loaded. |
| addHandler | | public void addHandler(Handler handler)(Code) | | Adds a handler to this logger. The handler will be fed with log records
received by this logger.
Parameters:
handler - the handler object to add, cannot be null
throws:
SecurityException - If a security manager determines that the caller does nothave the required permission. |
| config | | public void config(String msg)(Code) | | Logs a message of level Level.CONFIG.
Parameters:
msg - the message to log |
| entering | | public void entering(String sourceClass, String sourceMethod)(Code) | | Logs a message indicating entering a method. A log record with log level
Level.FINER, log message "ENTRY", and the specified
source class name and source method name is submitted for logging.
Parameters:
sourceClass - the calling class name
Parameters:
sourceMethod - the method name |
| entering | | public void entering(String sourceClass, String sourceMethod, Object param)(Code) | | Logs a message indicating entering a method. A log record with log level
Level.FINER, log message "ENTRY", and the specified
source class name and source method name and one parameter is submitted
for logging.
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
param - the parameter for the method call |
| entering | | public void entering(String sourceClass, String sourceMethod, Object[] params)(Code) | | Logs a message indicating entering a method. A log record with log level
Level.FINER, log message "ENTRY", and the specified
source class name and source method name and parameters is submitted for
logging.
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
params - an array of parameters for the method call |
| exiting | | public void exiting(String sourceClass, String sourceMethod)(Code) | | Logs a message indicating existing a method. A log record with log level
Level.FINER, log message "RETURN", and the specified
source class name and source method name is submitted for logging.
Parameters:
sourceClass - the calling class name
Parameters:
sourceMethod - the method name |
| exiting | | public void exiting(String sourceClass, String sourceMethod, Object result)(Code) | | Logs a message indicating exiting a method. A log record with log level
Level.FINER, log message "RETURN", and the specified
source class name and source method name and return value is submitted
for logging.
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
result - the return value of the method call |
| fine | | public void fine(String msg)(Code) | | Logs a message of level Level.FINE.
Parameters:
msg - the message to log |
| finer | | public void finer(String msg)(Code) | | Logs a message of level Level.FINER.
Parameters:
msg - the message to log |
| finest | | public void finest(String msg)(Code) | | Logs a message of level Level.FINEST.
Parameters:
msg - the message to log |
| getAnonymousLogger | | public static Logger getAnonymousLogger()(Code) | | Gets an anonymous logger to use internally in a thread. Anonymous loggers
are not registered in the log manager's namespace. No security checks
will be performed when updating an anonymous logger's control settings so
that they can be used in applets.
Anonymous loggers' parent is set to be the root logger. This enables them
to inherit default logging level and handlers from the root logger.
a new instance of anonymous logger |
| getAnonymousLogger | | public static Logger getAnonymousLogger(String resourceBundleName)(Code) | | Gets an anonymous logger to use internally in a thread. Anonymous loggers
are not registered in the log manager's namespace. No security checks
will be performed when updating an anonymous logger's control settings so
that they can be used in applets.
Anonymous loggers' parent is set to be the root logger. This enables them
to inherit default logging level and handlers from the root logger.
Parameters:
resourceBundleName - the name of the resource bundle used to localize log messages a new instance of anonymous logger
throws:
MissingResourceException - If the specified resource bundle can not be loaded. |
| getFilter | | public Filter getFilter()(Code) | | Gets the filter used by this logger.
the filter used by this logger |
| getHandlers | | public Handler[] getHandlers()(Code) | | Gets all the handlers associated with this logger.
an array of all the handlers associated with this logger |
| getLevel | | public Level getLevel()(Code) | | Gets the logging level of this logger.
the logging level of this logger |
| getLogger | | public static Logger getLogger(String name)(Code) | | Gets a named logger. The returned logger may already exist, or may be
newly created. If the latter, its level will be set to the configured
level according to the LogManager's properties if any.
Parameters:
name - the name of the logger to get, cannot be null a named logger
throws:
MissingResourceException - If the specified resource bundle can not be loaded. |
| getLogger | | public static Logger getLogger(String name, String resourceBundleName)(Code) | | Gets a named logger associated with the supplied resource bundle. The
resource bundle will be used to localize logging messages.
Parameters:
name - the name of the logger to get, cannot be null
Parameters:
resourceBundleName - the name of the resource bundle, may be null a named logger |
| getName | | public String getName()(Code) | | Gets the name of this logger.
the name of this logger |
| getParent | | public Logger getParent()(Code) | | Gets the parent of this logger in the namespace.
the parent of this logger in the namespace |
| getResourceBundle | | public ResourceBundle getResourceBundle()(Code) | | Gets the loaded resource bundle used by this logger to localize logging
messages. If it's null, the parent's resource bundle will be inherited.
the loaded resource bundle used by this logger |
| getResourceBundleName | | public String getResourceBundleName()(Code) | | Gets the name of the loaded resource bundle used by this logger to
localize logging messages. If it's null, the parent's resource bundle
name will be inherited.
the name of the loaded resource bundle used by this logger |
| getUseParentHandlers | | public boolean getUseParentHandlers()(Code) | | Gets the flag which indicates whether to use parent's handlers to publish
incoming log records, potentially recursively up the namespace.
true if set to use parent's handlers, otherwisefalse |
| info | | public void info(String msg)(Code) | | Logs a message of level Level.INFO.
Parameters:
msg - the message to log |
| internalSetParent | | void internalSetParent(Logger newParent)(Code) | | Sets the parent of this logger in the namespace. This method should
usually be used by the LogManager object only. This method
does not check security.
Parameters:
newParent - the parent logger to set |
| isLoggable | | public boolean isLoggable(Level l)(Code) | | Determines whether this logger will actually log messages of the
specified level. The effective level used to do the determination may be
inherited from its parent. The default level is Level.INFO.
Parameters:
l - the level to check true if this logger will actually log this level,otherwise false |
| loadResourceBundle | | static ResourceBundle loadResourceBundle(String resourceBundleName)(Code) | | Load the specified resource bundle, use privileged code.
Parameters:
resourceBundleName - the name of the resource bundle to load, cannot be null the loaded resource bundle.
throws:
MissingResourceException - If the specified resource bundle can not be loaded. |
| log | | public void log(Level logLevel, String msg)(Code) | | Logs a message of the specified level.
Parameters:
logLevel - the level of the given message
Parameters:
msg - the message to log |
| log | | public void log(Level logLevel, String msg, Object param)(Code) | | Logs a message of the specified level with the supplied parameter.
Parameters:
logLevel - the level of the given message
Parameters:
msg - the message to log
Parameters:
param - the parameter associated with the event that need to be logged |
| log | | public void log(Level logLevel, String msg, Object[] params)(Code) | | Logs a message of the specified level with the supplied parameter array.
Parameters:
logLevel - the level of the given message
Parameters:
msg - the message to log
Parameters:
params - the parameter array associated with the event that need to belogged |
| log | | public void log(Level logLevel, String msg, Throwable thrown)(Code) | | Logs a message of the specified level with the supplied
Throwable object.
Parameters:
logLevel - the level of the given message
Parameters:
msg - the message to log
Parameters:
thrown - the Throwable object associated with the eventthat need to be logged |
| log | | public void log(LogRecord record)(Code) | | Logs a given log record. Only those with a logging level no lower than
this logger's level will be submitted to this logger's handlers for
logging. If getUseParentHandlers() is true,
the log record will also be submitted to the parent logger's handlers,
potentially recursively up the namespace.
Since all other log methods call this method to actually perform the
logging action, subclasses of this class can override this method to
catch all logging activities.
Parameters:
record - the log record to be logged |
| logp | | public void logp(Level logLevel, String sourceClass, String sourceMethod, String msg)(Code) | | Logs a message of the given level with the specified source class name
and source method name.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
msg - the message to be logged |
| logp | | public void logp(Level logLevel, String sourceClass, String sourceMethod, String msg, Object param)(Code) | | Logs a message of the given level with the specified source class name
and source method name and parameter.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
msg - the message to be logged
Parameters:
param - the parameter associated with the event that need to be logged |
| logp | | public void logp(Level logLevel, String sourceClass, String sourceMethod, String msg, Object[] params)(Code) | | Logs a message of the given level with the specified source class name
and source method name and parameter array.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
msg - the message to be logged
Parameters:
params - the parameter array associated with the event that need to belogged |
| logp | | public void logp(Level logLevel, String sourceClass, String sourceMethod, String msg, Throwable thrown)(Code) | | Logs a message of the given level with the specified source class name
and source method name and Throwable object.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
msg - the message to be logged
Parameters:
thrown - the Throwable object |
| logrb | | public void logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg)(Code) | | Logs a message of the given level with the specified source class name
and source method name, using the given resource bundle to localize the
message.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
bundleName - the name of the resource bundle, used to localize the message
Parameters:
msg - the message to be logged |
| logrb | | public void logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg, Object param)(Code) | | Logs a message of the given level with the specified source class name
and source method name and parameter, using the given resource bundle to
localize the message.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
bundleName - the name of the resource bundle, used to localize the message
Parameters:
msg - the message to be logged
Parameters:
param - the parameter associated with the event that need to be logged |
| logrb | | public void logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg, Object[] params)(Code) | | Logs a message of the given level with the specified source class name
and source method name and parameter array, using the given resource
bundle to localize the message.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
bundleName - the name of the resource bundle, used to localize the message
Parameters:
msg - the message to be logged
Parameters:
params - the parameter array associated with the event that need to belogged |
| logrb | | public void logrb(Level logLevel, String sourceClass, String sourceMethod, String bundleName, String msg, Throwable thrown)(Code) | | Logs a message of the given level with the specified source class name
and source method name and Throwable object, using the
given resource bundle to localize the message.
Parameters:
logLevel - the level of the given message
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
bundleName - the name of the resource bundle, used to localize the message
Parameters:
msg - the message to be logged
Parameters:
thrown - the Throwable object |
| removeHandler | | public void removeHandler(Handler handler)(Code) | | Removes a handler for this logger. If the specified handler does not
exist, this method has no effect.
Parameters:
handler - the handler to be removed, cannot be null
throws:
SecurityException - If a security manager determines that the caller does nothave the required permission. |
| reset | | synchronized void reset()(Code) | | |
| setFilter | | public void setFilter(Filter newFilter)(Code) | | Sets the filter used by this logger.
Parameters:
newFilter - the filter to set
throws:
SecurityException - If a security manager determines that the caller does nothave the required permission. |
| setLevel | | public void setLevel(Level newLevel)(Code) | | Sets the logging level for this logger. A null level
indicates this logger will inherit its parent's level.
Parameters:
newLevel - the logging level to set
throws:
SecurityException - If a security manager determines that the caller does nothave the required permission. |
| setParent | | public void setParent(Logger parent)(Code) | | Sets the parent of this logger in the namespace. This method should
usually be used by the LogManager object only.
Parameters:
parent - the parent logger to set
throws:
SecurityException - If a security manager determines that the caller does nothave the required permission. |
| setUseParentHandlers | | public void setUseParentHandlers(boolean notifyParentHandlers)(Code) | | Sets the flag which indicates whether to use parent's handlers to publish
incoming log records, potentially recursively up the namespace.
Parameters:
notifyParentHandlers - the flag whether to use parent's handlers
throws:
SecurityException - If a security manager determines that the caller does nothave the required permission. |
| severe | | public void severe(String msg)(Code) | | Logs a message of level Level.SEVERE.
Parameters:
msg - the message to log |
| throwing | | public void throwing(String sourceClass, String sourceMethod, Throwable thrown)(Code) | | Logs a message indicating throwing an exception. A log record with log
level Level.FINER, log message "THROW", and the specified
source class name and source method name and Throwable
object is submitted for logging.
Parameters:
sourceClass - the source class name
Parameters:
sourceMethod - the source method name
Parameters:
thrown - the Throwable object |
| warning | | public void warning(String msg)(Code) | | Logs a message of level Level.WARNING.
Parameters:
msg - the message to log |
|
|