A set of utilities method for configuring loggings in SIS.
This class provides also some convenience static methods, including:
log(Class, String, LogRecord)
for setting the logger name, source class name and source method name of the given record before to log it.unexpectedException(Logger, Class, String, Throwable)
for reporting an anomalous but nevertheless non-fatal exception.
- Since:
- 0.3
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
completeAndLog
(Logger logger, Class<?> classe, String method, LogRecord record) Completes the properties of the given record, then logs to the specified or inferred logger.static Logger
getLogger
(Class<?> source) Returns a logger for the package of the specified class.static boolean
ignorableException
(Logger logger, Class<?> classe, String method, Throwable error) Invoked when an ignorable error occurred.static void
log
(Class<?> classe, String method, LogRecord record) Deprecated, for removal: This API element is subject to removal in a future version.static boolean
recoverableException
(Logger logger, Class<?> classe, String method, Throwable error) Invoked when a recoverable error occurred.static boolean
severeException
(Logger logger, Class<?> classe, String method, Throwable error) Invoked when a severe error occurred.static boolean
unexpectedException
(Logger logger, Class<?> classe, String method, Throwable error) Invoked when an unexpected error occurred.
-
Method Details
-
getLogger
Returns a logger for the package of the specified class. This convenience method invokesLogger.getLogger(String)
with the package name of the given class taken as the logger name.- Parameters:
source
- the class which will emit a logging message.- Returns:
- a logger for the specified class.
- Since:
- 1.0
-
log
@Deprecated(since="1.4", forRemoval=true) public static void log(Class<?> classe, String method, LogRecord record) Deprecated, for removal: This API element is subject to removal in a future version.Replaced bycompleteAndLog(null, record, classe, method)
for encouraging the use of staticLogger
constants. Also the new name makes clear that the record is modified.Logs the given record to the logger associated to the given class.- Parameters:
classe
- the class to report as the source of the logging message.method
- the method to report as the source of the logging message.record
- the record to log.
-
completeAndLog
Completes the properties of the given record, then logs to the specified or inferred logger. If thelogger
argument isnull
, the logger is inferred from the other arguments. This convenience method performs the following steps:- Set the source class name to the canonical name of the given class.
- Set the source method name to the given value.
- Set the logger name to the name of the given logger if non null. Otherwise use the package name of the class.
- Log the modified record to the specified
logger
if non null, or to the logger specified by the logger name otherwise.
- Parameters:
logger
- the logger where to log, ornull
for inferring from the logger or package name.classe
- the class to report as the source of the logging message.method
- the method to report as the source of the logging message.record
- the record to complete and log.- Since:
- 1.4
-
unexpectedException
public static boolean unexpectedException(Logger logger, Class<?> classe, String method, Throwable error) Invoked when an unexpected error occurred. This method logs a message atLevel.WARNING
to the specified logger. The originating class name and method name can optionally be specified. If any of them isnull
, then it will be inferred from the error stack trace as described below. If theclasse
ormethod
arguments are null, then the originating class name and method name are inferred from the givenerror
using the first stack trace element for which the class name is inside a package or sub-package of the same name than the logger name.Recommended usage
Explicit value for class and method names are preferred to automatic inference for the following reasons:- Automatic inference is not 100% reliable, since the Java Virtual Machine is free to omit stack frame in optimized code.
- When an exception occurred in a private method used internally by a public method, we sometimes want to log the warning for the public method instead, since the user is not expected to know anything about the existence of the private method. If a developer really want to know about the private method, the stack trace is still available anyway.
Example
If the logger name is"org.apache.sis.image"
, then this method will uses the first stack trace element where the fully qualified class name starts with"org.apache.sis.image"
or"org.apache.sis.image.io"
, but not"org.apache.sis.imageio"
.- Parameters:
logger
- where to log the error, ornull
for inferring a default value from other arguments.classe
- the class where the error occurred, ornull
for inferring a default value from other arguments.method
- the method where the error occurred, ornull
for inferring a default value from other arguments.error
- the error, ornull
if none.- Returns:
true
if the error has been logged, orfalse
if the givenerror
was null or if the logger does not log anything atLevel.WARNING
.- See Also:
-
recoverableException
public static boolean recoverableException(Logger logger, Class<?> classe, String method, Throwable error) Invoked when a recoverable error occurred. This method is similar tounexpectedException(…)
except that it does not log the stack trace and uses a lower logging level.- Parameters:
logger
- where to log the error, ornull
for inferring a default value from other arguments.classe
- the class where the error occurred, ornull
for inferring a default value from other arguments.method
- the method name where the error occurred, ornull
for inferring a default value from other arguments.error
- the error, ornull
if none.- Returns:
true
if the error has been logged, orfalse
if the givenerror
was null or if the logger does not log anything atLevel.FINE
.- See Also:
-
ignorableException
public static boolean ignorableException(Logger logger, Class<?> classe, String method, Throwable error) Invoked when an ignorable error occurred. This method is similar tounexpectedException(…)
except that it uses a lower logging level.- Parameters:
logger
- where to log the error, ornull
for inferring a default value from other arguments.classe
- the class where the error occurred, ornull
for inferring a default value from other arguments.method
- the method name where the error occurred, ornull
for inferring a default value from other arguments.error
- the error, ornull
if none.- Returns:
true
if the error has been logged, orfalse
if the givenerror
was null or if the logger does not log anything atLevel.FINER
.- Since:
- 1.0
-
severeException
public static boolean severeException(Logger logger, Class<?> classe, String method, Throwable error) Invoked when a severe error occurred. This method is similar tounexpectedException
except that it logs the message at theSEVERE
level.- Parameters:
logger
- where to log the error, ornull
for inferring a default value from other arguments.classe
- the class where the error occurred, ornull
for inferring a default value from other arguments.method
- the method name where the error occurred, ornull
for inferring a default value from other arguments.error
- the error, ornull
if none.- Returns:
true
if the error has been logged, orfalse
if the givenerror
was null or if the logger does not log anything atLevel.SEVERE
.- See Also:
-
completeAndLog(null, record, classe, method)
for encouraging the use of staticLogger
constants.