java.lang.Object | ||
java.util.logging.Logger |
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.
Value | ||||
---|---|---|---|---|
Logger | global | The global logger is provided as convenience for casual use. |
Logger(String name, String resourceBundleName) | ||||||
Constructs a Logger object with the supplied name and
resource bundle name. |
void | addHandler(Handler handler) | |||||
Adds a handler to this logger. | ||||||
void | config(String msg) | |||||
Logs a message of level Level.CONFIG . |
||||||
void | entering(String sourceClass, String sourceMethod, Object[] params) | |||||
Logs a message indicating entering a method. | ||||||
void | entering(String sourceClass, String sourceMethod, Object param) | |||||
Logs a message indicating entering a method. | ||||||
void | entering(String sourceClass, String sourceMethod) | |||||
Logs a message indicating entering a method. | ||||||
void | exiting(String sourceClass, String sourceMethod, Object result) | |||||
Logs a message indicating exiting a method. | ||||||
void | exiting(String sourceClass, String sourceMethod) | |||||
Logs a message indicating existing a method. | ||||||
void | fine(String msg) | |||||
Logs a message of level Level.FINE . |
||||||
void | finer(String msg) | |||||
Logs a message of level Level.FINER . |
||||||
void | finest(String msg) | |||||
Logs a message of level Level.FINEST . |
||||||
static | Logger | getAnonymousLogger() | ||||
Gets an anonymous logger to use internally in a thread. | ||||||
static | Logger | getAnonymousLogger(String resourceBundleName) | ||||
Gets an anonymous logger to use internally in a thread. | ||||||
Filter | getFilter() | |||||
Gets the filter used by this logger. | ||||||
Handler[] | getHandlers() | |||||
Gets all the handlers associated with this logger. | ||||||
Level | getLevel() | |||||
Gets the logging level of this logger. | ||||||
static | Logger | getLogger(String name) | ||||
Gets a named logger. | ||||||
static | Logger | getLogger(String name, String resourceBundleName) | ||||
Gets a named logger associated with the supplied resource bundle. | ||||||
String | getName() | |||||
Gets the name of this logger. | ||||||
Logger | getParent() | |||||
Gets the parent of this logger in the namespace. | ||||||
ResourceBundle | getResourceBundle() | |||||
Gets the loaded resource bundle used by this logger to localize logging messages. | ||||||
String | getResourceBundleName() | |||||
Gets the name of the loaded resource bundle used by this logger to localize logging messages. | ||||||
boolean | getUseParentHandlers() | |||||
Gets the flag which indicates whether to use parent's handlers to publish incoming log records, potentially recursively up the namespace. | ||||||
void | info(String msg) | |||||
Logs a message of level Level.INFO . |
||||||
boolean | isLoggable(Level l) | |||||
Determines whether this logger will actually log messages of the specified level. | ||||||
void | log(Level logLevel, String msg, Throwable thrown) | |||||
Logs a message of the specified level with the supplied
Throwable object. |
||||||
void | log(Level logLevel, String msg, Object[] params) | |||||
Logs a message of the specified level with the supplied parameter array. | ||||||
void | log(Level logLevel, String msg) | |||||
Logs a message of the specified level. | ||||||
void | log(Level logLevel, String msg, Object param) | |||||
Logs a message of the specified level with the supplied parameter. | ||||||
void | log(LogRecord record) | |||||
Logs a given log record. | ||||||
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. | ||||||
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. | ||||||
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. | ||||||
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. |
||||||
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. | ||||||
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. |
||||||
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. | ||||||
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. | ||||||
void | removeHandler(Handler handler) | |||||
Removes a handler for this logger. | ||||||
void | setFilter(Filter newFilter) | |||||
Sets the filter used by this logger. | ||||||
void | setLevel(Level newLevel) | |||||
Sets the logging level for this logger. | ||||||
void | setParent(Logger parent) | |||||
Sets the parent of this logger in the namespace. | ||||||
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. | ||||||
void | severe(String msg) | |||||
Logs a message of level Level.SEVERE . |
||||||
void | throwing(String sourceClass, String sourceMethod, Throwable thrown) | |||||
Logs a message indicating throwing an exception. | ||||||
void | warning(String msg) | |||||
Logs a message of level Level.WARNING . |
Logger
object with the supplied name and
resource bundle name.
name | the name of this logger, may be null for anonymous loggers |
---|---|
resourceBundleName | the name of the resource bundle used to localize logging messages, may be null |
MissingResourceException | If the specified resource bundle can not be loaded. |
---|
handler | the handler object to add, cannot be null |
---|
SecurityException | If a security manager determines that the caller does not have the required permission. |
---|
Level.CONFIG
.
msg | the message to log |
---|
Level.FINER
, log message "ENTRY", and the specified
source class name and source method name and parameters is submitted for
logging.
sourceClass | the source class name |
---|---|
sourceMethod | the source method name |
params | an array of parameters for the method call |
Level.FINER
, log message "ENTRY", and the specified
source class name and source method name and one parameter is submitted
for logging.
sourceClass | the source class name |
---|---|
sourceMethod | the source method name |
param | the parameter for the method call |
Level.FINER
, log message "ENTRY", and the specified
source class name and source method name is submitted for logging.
sourceClass | the calling class name |
---|---|
sourceMethod | the method name |
Level.FINER
, log message "RETURN", and the specified
source class name and source method name and return value is submitted
for logging.
sourceClass | the source class name |
---|---|
sourceMethod | the source method name |
result | the return value of the method call |
Level.FINER
, log message "RETURN", and the specified
source class name and source method name is submitted for logging.
sourceClass | the calling class name |
---|---|
sourceMethod | the method name |
Level.FINE
.
msg | the message to log |
---|
Level.FINER
.
msg | the message to log |
---|
Level.FINEST
.
msg | the message to log |
---|
Anonymous loggers' parent is set to be the root logger. This enables them to inherit default logging level and handlers from the root logger.
Anonymous loggers' parent is set to be the root logger. This enables them to inherit default logging level and handlers from the root logger.
resourceBundleName | the name of the resource bundle used to localize log messages |
---|
MissingResourceException | If the specified resource bundle can not be loaded. |
---|
LogManager
's properties if any.
name | the name of the logger to get, cannot be null |
---|
MissingResourceException | If the specified resource bundle can not be loaded. |
---|
name | the name of the logger to get, cannot be null |
---|---|
resourceBundleName | the name of the resource bundle, may be null |
true
if set to use parent's handlers, otherwise
false
Level.INFO
.
msg | the message to log |
---|
Level.INFO
.
l | the level to check |
---|
true
if this logger will actually log this level,
otherwise false
Throwable
object.
logLevel | the level of the given message |
---|---|
msg | the message to log |
thrown | the Throwable object associated with the event
that need to be logged
|
logLevel | the level of the given message |
---|---|
msg | the message to log |
params | the parameter array associated with the event that need to be logged |
logLevel | the level of the given message |
---|---|
msg | the message to log |
logLevel | the level of the given message |
---|---|
msg | the message to log |
param | the parameter associated with the event that need to be logged |
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.
record | the log record to be logged |
---|
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
msg | the message to be logged |
params | the parameter array associated with the event that need to be logged |
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
msg | the message to be logged |
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
msg | the message to be logged |
param | the parameter associated with the event that need to be logged |
Throwable
object.
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
msg | the message to be logged |
thrown | the Throwable object
|
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
bundleName | the name of the resource bundle, used to localize the message |
msg | the message to be logged |
Throwable
object, using the
given resource bundle to localize the message.
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
bundleName | the name of the resource bundle, used to localize the message |
msg | the message to be logged |
thrown | the Throwable object
|
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
bundleName | the name of the resource bundle, used to localize the message |
msg | the message to be logged |
param | the parameter associated with the event that need to be logged |
logLevel | the level of the given message |
---|---|
sourceClass | the source class name |
sourceMethod | the source method name |
bundleName | the name of the resource bundle, used to localize the message |
msg | the message to be logged |
params | the parameter array associated with the event that need to be logged |
handler | the handler to be removed, cannot be null |
---|
SecurityException | If a security manager determines that the caller does not have the required permission. |
---|
newFilter | the filter to set |
---|
SecurityException | If a security manager determines that the caller does not have the required permission. |
---|
null
level
indicates this logger will inherit its parent's level.
newLevel | the logging level to set |
---|
SecurityException | If a security manager determines that the caller does not have the required permission. |
---|
LogManager
object only.
parent | the parent logger to set |
---|
SecurityException | If a security manager determines that the caller does not have the required permission. |
---|
notifyParentHandlers | the flag whether to use parent's handlers |
---|
SecurityException | If a security manager determines that the caller does not have the required permission. |
---|
Level.SEVERE
.
msg | the message to log |
---|
Level.FINER
, log message "THROW", and the specified
source class name and source method name and Throwable
object is submitted for logging.
sourceClass | the source class name |
---|---|
sourceMethod | the source method name |
thrown | the Throwable object
|
Level.WARNING
.
msg | the message to log |
---|
Copyright 2007 Google Inc. | Build 0.9_r1-98467 - 14 Aug 2008 18:56 |