|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.log4j.Category
org.apache.log4j.Logger
org.apache.log4j.spi.NOPLogger
public final class NOPLogger
No-operation implementation of Logger used by NOPLoggerRepository.
| Field Summary |
|---|
| Fields inherited from class org.apache.log4j.Category |
|---|
additive, level, name, parent, repository, resourceBundle |
| Constructor Summary | |
|---|---|
NOPLogger(NOPLoggerRepository repo,
java.lang.String name)
Create instance of Logger. |
|
| Method Summary | |
|---|---|
void |
addAppender(Appender newAppender)
Add newAppender to the list of appenders of this
Category instance. |
void |
assertLog(boolean assertion,
java.lang.String msg)
If assertion parameter is false, then
logs msg as an error statement. |
void |
callAppenders(LoggingEvent event)
Call the appenders in the hierrachy starting at this. |
void |
debug(java.lang.Object message)
Log a message object with the DEBUG level. |
void |
debug(java.lang.Object message,
java.lang.Throwable t)
Log a message object with the DEBUG level including
the stack trace of the Throwable t passed as
parameter. |
void |
error(java.lang.Object message)
Log a message object with the ERROR Level. |
void |
error(java.lang.Object message,
java.lang.Throwable t)
Log a message object with the ERROR level including
the stack trace of the Throwable t passed as
parameter. |
void |
fatal(java.lang.Object message)
Log a message object with the FATAL Level. |
void |
fatal(java.lang.Object message,
java.lang.Throwable t)
Log a message object with the FATAL level including
the stack trace of the Throwable t passed as
parameter. |
java.util.Enumeration |
getAllAppenders()
Get the appenders contained in this category as an Enumeration. |
Appender |
getAppender(java.lang.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. |
java.util.ResourceBundle |
getResourceBundle()
Return the inherited ResourceBundle for this
category. |
void |
info(java.lang.Object message)
Log a message object with the INFO Level. |
void |
info(java.lang.Object message,
java.lang.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,
java.lang.String key,
java.lang.Object[] params,
java.lang.Throwable t)
Log a localized and parameterized message. |
void |
l7dlog(Priority priority,
java.lang.String key,
java.lang.Throwable t)
Log a localized message. |
void |
log(Priority priority,
java.lang.Object message)
This generic form is intended to be used by wrappers. |
void |
log(Priority priority,
java.lang.Object message,
java.lang.Throwable t)
This generic form is intended to be used by wrappers. |
void |
log(java.lang.String callerFQCN,
Priority level,
java.lang.Object message,
java.lang.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(java.lang.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(java.util.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(java.lang.Object message)
Log a message object with the TRACE level. |
void |
trace(java.lang.Object message,
java.lang.Throwable t)
Log a message object with the TRACE level including the
stack trace of the Throwablet passed as parameter. |
void |
warn(java.lang.Object message)
Log a message object with the WARN Level. |
void |
warn(java.lang.Object message,
java.lang.Throwable t)
Log a message with the WARN level including the
stack trace of the Throwable t passed as
parameter. |
| Methods inherited from class org.apache.log4j.Logger |
|---|
getLogger, getLogger, getLogger, getRootLogger |
| Methods inherited from class org.apache.log4j.Category |
|---|
exists, forcedLog, getAdditivity, getCurrentCategories, getDefaultHierarchy, getHierarchy, getInstance, getInstance, getLevel, getLoggerRepository, getName, getParent, getPriority, getResourceBundleString, getRoot, setAdditivity, shutdown |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public NOPLogger(NOPLoggerRepository repo,
java.lang.String name)
repo - repository, may not be null.name - name, may not be null, use "root" for root logger.| Method Detail |
|---|
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 AppenderAttachableaddAppender in class Category
public void assertLog(boolean assertion,
java.lang.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.
assertLog in class Categorymsg - The message to print if assertion is
false.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 Categoryevent - the event to log.public void debug(java.lang.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.
debug in class Categorymessage - the message object to log.
public void debug(java.lang.Object message,
java.lang.Throwable t)
DEBUG level including
the stack trace of the Throwable t passed as
parameter.
See Category.debug(Object) form for more detailed information.
debug in class Categorymessage - the message object to log.t - the exception to log, including its stack trace.public void error(java.lang.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.
error in class Categorymessage - the message object to log
public void error(java.lang.Object message,
java.lang.Throwable t)
ERROR level including
the stack trace of the Throwable t passed as
parameter.
See Category.error(Object) form for more detailed information.
error in class Categorymessage - the message object to log.t - the exception to log, including its stack trace.public void fatal(java.lang.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.
fatal in class Categorymessage - the message object to log
public void fatal(java.lang.Object message,
java.lang.Throwable t)
FATAL level including
the stack trace of the Throwable t passed as
parameter.
See Category.fatal(Object) for more detailed information.
fatal in class Categorymessage - the message object to log.t - the exception to log, including its stack trace.public java.util.Enumeration getAllAppenders()
Enumeration. If no appenders can be found, then a NullEnumeration
is returned.
getAllAppenders in interface AppenderAttachablegetAllAppenders in class Categorypublic Appender getAppender(java.lang.String name)
name.
Return the appender with that name if in the list. Return
null otherwise.
getAppender in interface AppenderAttachablegetAppender in class Categorypublic Level getEffectiveLevel()
The Category class is designed so that this method executes as quickly as possible.
getEffectiveLevel in class Categorypublic Priority getChainedPriority()
getChainedPriority in class Categorypublic java.util.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 Categorypublic void info(java.lang.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.
info in class Categorymessage - the message object to log
public void info(java.lang.Object message,
java.lang.Throwable t)
INFO level including
the stack trace of the Throwable t passed as
parameter.
See Category.info(Object) for more detailed information.
info in class Categorymessage - the message object to log.t - the exception to log, including its stack trace.public boolean isAttached(Appender appender)
isAttached in interface AppenderAttachableisAttached in class Categorypublic 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 Categorytrue if this category is debug
enabled, false otherwise.public boolean isEnabledFor(Priority level)
Level passed as parameter.
See also Category.isDebugEnabled().
isEnabledFor in class Categorylevel.public boolean isInfoEnabled()
Category.isDebugEnabled().
isInfoEnabled in class Categorytrue if this category is enabled
for level info, false otherwise.
public void l7dlog(Priority priority,
java.lang.String key,
java.lang.Throwable t)
key is replaced by its localized version from the
resource bundle.
l7dlog in class CategoryCategory.setResourceBundle(java.util.ResourceBundle)
public void l7dlog(Priority priority,
java.lang.String key,
java.lang.Object[] params,
java.lang.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.
l7dlog in class Category
public void log(Priority priority,
java.lang.Object message,
java.lang.Throwable t)
log in class Category
public void log(Priority priority,
java.lang.Object message)
log in class Category
public void log(java.lang.String callerFQCN,
Priority level,
java.lang.Object message,
java.lang.Throwable t)
log in class CategorycallerFQCN - The wrapper class' fully qualified class name.level - The level of the logging request.message - The message of the logging request.t - The throwable of the logging request, may be null.public void removeAllAppenders()
This is useful when re-reading configuration information.
removeAllAppenders in interface AppenderAttachableremoveAllAppenders in class Categorypublic void removeAppender(Appender appender)
removeAppender in interface AppenderAttachableremoveAppender in class Categorypublic void removeAppender(java.lang.String name)
removeAppender in interface AppenderAttachableremoveAppender in class Categorypublic 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.
setLevel in class Categorypublic void setPriority(Priority priority)
Null values are admitted.
setPriority in class Categorypublic void setResourceBundle(java.util.ResourceBundle bundle)
Category.l7dlog(Priority,String,Throwable) and Category.l7dlog(Priority,String,Object[],Throwable).
setResourceBundle in class Categorypublic void warn(java.lang.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.
warn in class Categorymessage - the message object to log.
public void warn(java.lang.Object message,
java.lang.Throwable t)
WARN level including the
stack trace of the Throwable t passed as
parameter.
See Category.warn(Object) for more detailed information.
warn in class Categorymessage - the message object to log.t - the exception to log, including its stack trace.public void trace(java.lang.Object message)
TRACE level.
trace in class Loggermessage - the message object to log.for an explanation of the logic applied.
public void trace(java.lang.Object message,
java.lang.Throwable t)
TRACE level including the
stack trace of the Throwablet passed as parameter.
See Category.debug(Object) form for more detailed information.
trace in class Loggermessage - the message object to log.t - the exception to log, including its stack trace.public boolean isTraceEnabled()
isTraceEnabled in class Loggertrue if this category is enabled for level
TRACE, false otherwise.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||