public final class NOPLogger extends Logger
additive, level, name, parent, repository, resourceBundle
Constructor and Description |
---|
NOPLogger(NOPLoggerRepository repo,
String name)
Create instance of Logger.
|
Modifier and Type | Method and Description |
---|---|
void |
addAppender(Appender newAppender)
Add
newAppender to the list of appenders of this Category instance. |
void |
assertLog(boolean assertion,
String msg)
|
void |
callAppenders(LoggingEvent event)
Call the appenders in the hierrachy starting at
this . |
void |
debug(Object message)
Log a message object with the
DEBUG level. |
void |
debug(Object message,
Throwable t)
Log a message object with the
DEBUG level including the stack trace of the Throwable
t passed as parameter. |
void |
error(Object message)
Log a message object with the
ERROR Level. |
void |
error(Object message,
Throwable t)
Log a message object with the
ERROR level including the stack trace of the Throwable
t passed as parameter. |
void |
fatal(Object message)
Log a message object with the
FATAL Level. |
void |
fatal(Object message,
Throwable t)
Log a message object with the
FATAL level including the stack trace of the Throwable
t passed as parameter. |
Enumeration |
getAllAppenders()
Get the appenders contained in this category as an
Enumeration . |
Appender |
getAppender(String name)
Look for the appender named as
name . |
Priority |
getChainedPriority() |
Level |
getEffectiveLevel()
Starting from this category, search the category hierarchy for a non-null level and return it.
|
ResourceBundle |
getResourceBundle()
Return the inherited
ResourceBundle for this category. |
void |
info(Object message)
Log a message object with the
INFO Level. |
void |
info(Object message,
Throwable t)
Log a message object with the
INFO level including the stack trace of the Throwable
t passed as parameter. |
boolean |
isAttached(Appender appender)
Is the appender passed as parameter attached to this category?
|
boolean |
isDebugEnabled()
Check whether this category is enabled for the
DEBUG Level. |
boolean |
isEnabledFor(Priority level)
Check whether this category is enabled for a given
Level passed as parameter. |
boolean |
isInfoEnabled()
Check whether this category is enabled for the info Level.
|
boolean |
isTraceEnabled()
Check whether this category is enabled for the TRACE Level.
|
void |
l7dlog(Priority priority,
String key,
Object[] params,
Throwable t)
Log a localized and parameterized message.
|
void |
l7dlog(Priority priority,
String key,
Throwable t)
Log a localized message.
|
void |
log(Priority priority,
Object message)
This generic form is intended to be used by wrappers.
|
void |
log(Priority priority,
Object message,
Throwable t)
This generic form is intended to be used by wrappers.
|
void |
log(String callerFQCN,
Priority level,
Object message,
Throwable t)
This is the most generic printing method.
|
void |
removeAllAppenders()
Remove all previously added appenders from this Category instance.
|
void |
removeAppender(Appender appender)
Remove the appender passed as parameter form the list of appenders.
|
void |
removeAppender(String name)
Remove the appender with the name passed as parameter form the list of appenders.
|
void |
setLevel(Level level)
Set the level of this Category.
|
void |
setPriority(Priority priority)
Set the level of this Category.
|
void |
setResourceBundle(ResourceBundle bundle)
Set the resource bundle to be used with localized logging methods
Category.l7dlog(Priority, String, Throwable)
and Category.l7dlog(Priority, String, Object[], Throwable) . |
void |
trace(Object message)
Log a message object with the
TRACE level. |
void |
trace(Object message,
Throwable t)
Log a message object with the
TRACE level including the stack trace of the
Throwable t passed as parameter. |
void |
warn(Object message)
Log a message object with the
WARN Level. |
void |
warn(Object message,
Throwable t)
|
getLogger, getLogger, getLogger, getRootLogger
exists, forcedLog, getAdditivity, getCurrentCategories, getDefaultHierarchy, getHierarchy, getInstance, getInstance, getLevel, getLoggerRepository, getName, getParent, getPriority, getResourceBundleString, getRoot, setAdditivity, shutdown
public NOPLogger(NOPLoggerRepository repo, String name)
repo
- repository, may not be null.name
- name, may not be null, use "root" for root logger.public void addAppender(Appender newAppender)
newAppender
to the list of appenders of this Category instance.
If newAppender
is already in the list of appenders, then it won't be added again.
addAppender
in interface AppenderAttachable
addAppender
in class Category
public void assertLog(boolean assertion, String msg)
assertion
parameter is false
, then logs
msg
as an error
statement.
The assert
method has been renamed to assertLog
because assert
is a
language reserved word in JDK 1.4.
public void callAppenders(LoggingEvent event)
this
. If no appenders could be found, emit a
warning.
This method calls all the appenders inherited from the hierarchy circumventing any evaluation of whether to log or not to log the particular log request.
callAppenders
in class Category
event
- the event to log.public void debug(Object message)
DEBUG
level.
This method first checks if this category is DEBUG
enabled by comparing the level of this category
with the DEBUG
level. If this category is DEBUG
enabled, then it converts the
message object (passed as parameter) to a string by invoking the appropriate
ObjectRenderer
. It then proceeds to call all the registered appenders in this
category and also higher in the hierarchy depending on the value of the additivity flag.
WARNING Note that passing a Throwable
to this method will
print the name of the Throwable
but no stack trace. To print a stack trace use the
Category.debug(Object, Throwable)
form instead.
public void debug(Object message, Throwable t)
DEBUG
level including the stack trace of the Throwable
t
passed as parameter.
See Category.debug(Object)
form for more detailed information.
public void error(Object message)
ERROR
Level.
This method first checks if this category is ERROR
enabled by comparing the level of this category
with ERROR
Level. If this category is ERROR
enabled, then it converts the
message object passed as parameter to a string by invoking the appropriate
ObjectRenderer
. It proceeds to call all the registered appenders in this category and
also higher in the hierarchy depending on the value of the additivity flag.
WARNING Note that passing a Throwable
to this method will
print the name of the Throwable
but no stack trace. To print a stack trace use the
Category.error(Object, Throwable)
form instead.
public void error(Object message, Throwable t)
ERROR
level including the stack trace of the Throwable
t
passed as parameter.
See Category.error(Object)
form for more detailed information.
public void fatal(Object message)
FATAL
Level.
This method first checks if this category is FATAL
enabled by comparing the level of this category
with FATAL
Level. If the category is FATAL
enabled, then it converts the message
object passed as parameter to a string by invoking the appropriate ObjectRenderer
. It
proceeds to call all the registered appenders in this category and also higher in the hierarchy depending on the
value of the additivity flag.
WARNING Note that passing a Throwable
to this method will
print the name of the Throwable but no stack trace. To print a stack trace use the
Category.fatal(Object, Throwable)
form instead.
public void fatal(Object message, Throwable t)
FATAL
level including the stack trace of the Throwable
t
passed as parameter.
See Category.fatal(Object)
for more detailed information.
public Enumeration getAllAppenders()
Enumeration
. If no appenders can be found, then a
NullEnumeration
is returned.getAllAppenders
in interface AppenderAttachable
getAllAppenders
in class Category
public Appender getAppender(String name)
name
.
Return the appender with that name if in the list. Return null
otherwise.
getAppender
in interface AppenderAttachable
getAppender
in class Category
public Level getEffectiveLevel()
The Category class is designed so that this method executes as quickly as possible.
getEffectiveLevel
in class Category
public Priority getChainedPriority()
getChainedPriority
in class Category
public ResourceBundle getResourceBundle()
ResourceBundle
for this category.
This method walks the hierarchy to find the appropriate resource bundle. It will return the resource bundle
attached to the closest ancestor of this category, much like the way priorities are searched. In case there is no
bundle in the hierarchy then null
is returned.
getResourceBundle
in class Category
public void info(Object message)
INFO
Level.
This method first checks if this category is INFO
enabled by comparing the level of this category
with INFO
Level. If the category is INFO
enabled, then it converts the message
object passed as parameter to a string by invoking the appropriate ObjectRenderer
. It
proceeds to call all the registered appenders in this category and also higher in the hierarchy depending on the
value of the additivity flag.
WARNING Note that passing a Throwable
to this method will
print the name of the Throwable but no stack trace. To print a stack trace use the
Category.info(Object, Throwable)
form instead.
public void info(Object message, Throwable t)
INFO
level including the stack trace of the Throwable
t
passed as parameter.
See Category.info(Object)
for more detailed information.
public boolean isAttached(Appender appender)
isAttached
in interface AppenderAttachable
isAttached
in class Category
public boolean isDebugEnabled()
DEBUG
Level.
This function is intended to lessen the computational cost of disabled log debug statements.
For some cat
Category object, when you write,
cat.debug("This is entry number: " + i);
You incur the cost constructing the message, concatenatiion in this case, regardless of whether the message is logged or not.
If you are worried about speed, then you should write
if (cat.isDebugEnabled()) { cat.debug("This is entry number: " + i); }
This way you will not incur the cost of parameter construction if debugging is disabled for cat
. On
the other hand, if the cat
is debug enabled, you will incur the cost of evaluating whether the
category is debug enabled twice. Once in isDebugEnabled
and once in the
debug
. This is an insignificant overhead since evaluating a
category takes about 1%% of the time it takes to actually log.
isDebugEnabled
in class Category
true
if this category is debug enabled,
false
otherwise.public boolean isEnabledFor(Priority level)
Level
passed as parameter.
See also Category.isDebugEnabled()
.
isEnabledFor
in class Category
level
.public boolean isInfoEnabled()
Category.isDebugEnabled()
.isInfoEnabled
in class Category
true
if this category is enabled for level info, false
otherwise.public void l7dlog(Priority priority, String key, Throwable t)
key
is replaced by its localized version from
the resource bundle.l7dlog
in class Category
Category.setResourceBundle(java.util.ResourceBundle)
public void l7dlog(Priority priority, String key, Object[] params, Throwable t)
key
is searched in the resource bundle. Next, the resulting
pattern is formatted using MessageFormat.format(String, Object[])
method with the user supplied
object array params
.public void log(Priority priority, Object message, Throwable t)
public void log(Priority priority, Object message)
public void log(String callerFQCN, Priority level, Object message, Throwable t)
public void removeAllAppenders()
This is useful when re-reading configuration information.
removeAllAppenders
in interface AppenderAttachable
removeAllAppenders
in class Category
public void removeAppender(Appender appender)
removeAppender
in interface AppenderAttachable
removeAppender
in class Category
public void removeAppender(String name)
removeAppender
in interface AppenderAttachable
removeAppender
in class Category
public void setLevel(Level level)
Level.DEBUG
, Level.INFO
, Level.WARN
,
Level.ERROR
, Level.FATAL
as a parameter, you need
to case them as Level.
As in
logger.setLevel((Level) Level.DEBUG);
Null values are admitted.
public void setPriority(Priority priority)
Null values are admitted.
setPriority
in class Category
public void setResourceBundle(ResourceBundle bundle)
Category.l7dlog(Priority, String, Throwable)
and Category.l7dlog(Priority, String, Object[], Throwable)
.setResourceBundle
in class Category
public void warn(Object message)
WARN
Level.
This method first checks if this category is WARN
enabled by comparing the level of this category
with WARN
Level. If the category is WARN
enabled, then it converts the message
object passed as parameter to a string by invoking the appropriate ObjectRenderer
. It
proceeds to call all the registered appenders in this category and also higher in the hieararchy depending on the
value of the additivity flag.
WARNING Note that passing a Throwable
to this method will
print the name of the Throwable but no stack trace. To print a stack trace use the
Category.warn(Object, Throwable)
form instead.
public void warn(Object message, Throwable t)
WARN
level including the stack trace of the Throwable
t
passed as parameter.
See Category.warn(Object)
for more detailed information.
public void trace(Object message)
TRACE
level.trace
in class Logger
message
- the message object to log.for an explanation of the logic applied.
public void trace(Object message, Throwable t)
TRACE
level including the stack trace of the
Throwable
t
passed as parameter.
See Category.debug(Object)
form for more detailed information.
public boolean isTraceEnabled()
isTraceEnabled
in class Logger
true
if this category is enabled for level TRACE, false
otherwise.Copyright © 1999–2023 QOS.CH Sarl (Switzerland). All rights reserved.