|
Log4j 1.3alpha-3 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.log4j.Category
This class has been deprecated and replaced by the
Logger
subclass. It will be kept around to
preserve backward compatibility until such time as the Log4j team sees fit
to remove it.
Logger
is a subclass of Category, i.e. it extends Category. In
other words, a logger is a category. Thus, all operations that
can be performed on a category can be performed on a logger. Whenever
log4j is asked to produce a Category object, it will instead produce a
Logger object. However, methods that previously accepted category objects
still continue to accept category objects.
For example, the following are all legal and will work as expected.
// Deprecated form: Category cat = Category.getInstance("foo.bar") // Preferred form for retrieving loggers: Logger logger = Logger.getLogger("foo.bar")
The first form is deprecated and should be avoided.
There is absolutely no need for new client code to use or refer to the
Category
class. Whenever possible, please avoid referring
to it or using it.
See the Short Manual for an introduction on this class.
Field Summary | |
protected boolean |
additive
Additivity is set to true by default, that is children inherit the appenders of their ancestors by default. |
protected Level |
level
The assigned level of this category. |
protected ReaderWriterLock |
lock
|
protected java.lang.String |
name
The name of this category. |
protected Category |
parent
The parent of this category. |
protected LoggerRepository |
repository
|
protected java.util.ResourceBundle |
resourceBundle
|
Constructor Summary | |
protected |
Category(java.lang.String name)
This constructor created a new Category instance and sets
its name.
|
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 messagePattern,
java.lang.Object arg)
Log a message with the DEBUG level with message formatting
done according to the value of messagePattern and
arg parameters.
|
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 messagePattern,
java.lang.Object arg)
Log a message with the ERROR level with message formatting
done according to the value of messagePattern and
arg parameters.
|
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.
|
static Logger |
exists(java.lang.String name)
Deprecated. Please use LogManager.exists(java.lang.String) instead. |
void |
fatal(java.lang.Object message)
Log a message object with the FATAL Level.
|
void |
fatal(java.lang.Object messagePattern,
java.lang.Object arg)
Log a message with the FATAL level with message formatting
done according to the value of messagePattern and
arg parameters.
|
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.
|
protected void |
forcedLog(java.lang.String fqcn,
Level level,
java.lang.Object message,
java.lang.Throwable t)
This method creates a new logging event and logs the event without further checks. |
boolean |
getAdditivity()
Get the additivity flag for this Category instance. |
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 .
|
Level |
getChainedPriority()
Deprecated. Please use the the getEffectiveLevel() method instead. |
static java.util.Enumeration |
getCurrentCategories()
Deprecated. Please use LogManager.getCurrentLoggers() instead. |
static LoggerRepository |
getDefaultHierarchy()
Deprecated. Please use LogManager.getLoggerRepository() instead. |
Level |
getEffectiveLevel()
Starting from this category, search the category hierarchy for a non-null level and return it. |
LoggerRepository |
getHierarchy()
Deprecated. Please use getLoggerRepository() instead. |
static Category |
getInstance(java.lang.Class clazz)
Deprecated. Please use Logger.getLogger(Class) instead. |
static Category |
getInstance(java.lang.String name)
Deprecated. Please use the Logger.getLogger(String) method instead. |
Level |
getLevel()
Returns the assigned Level , if any, for this Category. |
LoggerRepository |
getLoggerRepository()
Return the the LoggerRepository where this Category
is attached. |
java.lang.String |
getName()
Return the category name. |
Category |
getParent()
Returns the parent of this category. |
Level |
getPriority()
Deprecated. Please use getLevel() instead. |
java.util.ResourceBundle |
getResourceBundle()
Return the inherited ResourceBundle for this category.
|
protected java.lang.String |
getResourceBundleString(java.lang.String key)
Returns the string resource coresponding to key in this
category's inherited resource bundle. |
static Category |
getRoot()
Deprecated. Please use the Logger.getRootLogger() method instead. |
void |
info(java.lang.Object message)
Log a message object with the INFO Level.
|
void |
info(java.lang.Object messagePattern,
java.lang.Object arg)
Log a message with the INFO level with message formatting
done according to the value of messagePattern and
arg parameters.
|
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(Level level)
Check whether this category is enabled for a given Level passed
as parameter. |
boolean |
isEnabledFor(Priority level)
Deprecated. Use the alternate form taking a parameter of type Level. |
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(Level level,
java.lang.String key,
java.lang.Object[] params,
java.lang.Throwable t)
Log a localized and parameterized message. |
void |
l7dlog(Level level,
java.lang.String key,
java.lang.Throwable t)
Log a localized message. |
void |
log(Level level,
java.lang.Object message)
This generic form is intended to be used by wrappers. |
void |
log(Level level,
java.lang.Object message,
java.lang.Throwable t)
This generic form is intended to be used by wrappers. |
void |
log(Priority level,
java.lang.Object message)
Deprecated. Use the form taking in a Level as a parameter. |
void |
log(Priority level,
java.lang.Object message,
java.lang.Throwable t)
Deprecated. Use the form taking in a Level as a parameter. |
void |
log(java.lang.String callerFQCN,
Level level,
java.lang.Object message,
java.lang.Throwable t)
This is the most generic printing method. |
void |
log(java.lang.String callerFQCN,
Priority level,
java.lang.Object message,
java.lang.Throwable t)
Deprecated. Use the form taking in a Level as a parameter. |
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 |
setAdditivity(boolean additive)
Set the additivity flag for this Category instance. |
void |
setLevel(Level level)
Set the level of this Category. |
void |
setResourceBundle(java.util.ResourceBundle bundle)
Set the resource bundle to be used with localized logging methods l7dlog(Level,String,Throwable) and l7dlog(Level,String,Object[],Throwable) . |
static void |
shutdown()
Deprecated. Please use LogManager.shutdown() instead. |
void |
warn(java.lang.Object message)
Log a message object with the WARN Level.
|
void |
warn(java.lang.Object messagePattern,
java.lang.Object arg)
Log a message with the WARN level with message formatting
done according to the value of messagePattern and
arg parameters.
|
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.String name
protected volatile Level level
level
variable
need not be assigned a value in which case it is inherited form the
hierarchy.
protected volatile Category parent
protected java.util.ResourceBundle resourceBundle
protected ReaderWriterLock lock
protected LoggerRepository repository
protected boolean additive
false
then the appenders found in the ancestors of this
category are not used. However, the children of this category will
inherit its appenders, unless the children have their additivity flag
set to false
too. See the user manual for more details.
Constructor Detail |
protected Category(java.lang.String name)
Category
instance and sets
its name.
It is intended to be used by sub-classes only. You should not create categories directly.
name
- The name of the category.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 AppenderAttachable
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.
assertion
- msg
- 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.
event
- 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 debug(Object, Throwable)
form
instead.
message
- 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 debug(Object)
form for more detailed information.
message
- the message object to log.t
- the exception to log, including its stack trace.public void debug(java.lang.Object messagePattern, java.lang.Object arg)
DEBUG
level with message formatting
done according to the value of messagePattern
and
arg
parameters.
This form avoids superflous parameter construction. Whenever possible, you should use this form instead of constructing the message parameter using string concatenation.
messagePattern
- The message pattern which will be parsed and formattedarg
- The argument to replace the formatting element, i,e,
the '{}' pair within messagePattern
.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 error(Object, Throwable)
form
instead.
message
- the message object to logpublic void error(java.lang.Object message, java.lang.Throwable t)
ERROR
level including the
stack trace of the Throwable
t
passed as parameter.
See error(Object)
form for more detailed information.
message
- the message object to log.t
- the exception to log, including its stack trace.public void error(java.lang.Object messagePattern, java.lang.Object arg)
ERROR
level with message formatting
done according to the value of messagePattern
and
arg
parameters.
This form avoids superflous parameter construction. Whenever possible, you should use this form instead of constructing the message parameter using string concatenation.
messagePattern
- The message pattern which will be parsed and formattedarg
- The argument to replace the formatting element, i,e,
the '{}' pair within messagePattern
.public static Logger exists(java.lang.String name)
LogManager.exists(java.lang.String)
instead.
null
.
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 fatal(Object, Throwable)
form instead.
message
- the message object to logpublic void fatal(java.lang.Object messagePattern, java.lang.Object arg)
FATAL
level with message formatting
done according to the value of messagePattern
and
arg
parameters.
This form avoids superflous parameter construction. Whenever possible, you should use this form instead of constructing the message parameter using string concatenation.
messagePattern
- The message pattern which will be parsed and formattedarg
- The argument to replace the formatting element, i,e,
the '{}' pair within messagePattern
.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 fatal(Object)
for more detailed information.
message
- the message object to log.t
- the exception to log, including its stack trace.protected void forcedLog(java.lang.String fqcn, Level level, java.lang.Object message, java.lang.Throwable t)
public boolean getAdditivity()
public java.util.Enumeration getAllAppenders()
Enumeration
.
If no appenders can be found, then a NullEnumeration
is
returned.
getAllAppenders
in interface AppenderAttachable
public Appender getAppender(java.lang.String name)
name
.
Return the appender with that name if in the list. Return
null
otherwise.
getAppender
in interface AppenderAttachable
public Level getEffectiveLevel()
The Category class is designed so that this method executes as quickly as possible.
public Level getChainedPriority()
getEffectiveLevel()
method instead.
public static java.util.Enumeration getCurrentCategories()
LogManager.getCurrentLoggers()
instead.
Enumeration
.
The root category is not included in the returned Enumeration
.
public static LoggerRepository getDefaultHierarchy()
LogManager.getLoggerRepository()
instead.
public LoggerRepository getHierarchy()
getLoggerRepository()
instead.
Hierarchy
where this Category
instance is attached.
public LoggerRepository getLoggerRepository()
LoggerRepository
where this Category
is attached.
public static Category getInstance(java.lang.String name)
Logger.getLogger(String)
method instead.
public static Category getInstance(java.lang.Class clazz)
Logger.getLogger(Class)
instead.
public final java.lang.String getName()
public final Category getParent()
The root category will return null
.
public final Level getLevel()
Level
, if any, for this Category.
null
.public final Level getPriority()
getLevel()
instead.
public static final Category getRoot()
Logger.getRootLogger()
method instead.
public 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.
protected java.lang.String getResourceBundleString(java.lang.String key)
key
in this
category's inherited resource bundle. See also getResourceBundle()
.
If the resource cannot be found, then an error
message
will be logged complaining about the missing resource.
public 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 info(Object, Throwable)
form instead.
message
- the message object to logpublic void info(java.lang.Object messagePattern, java.lang.Object arg)
INFO
level with message formatting
done according to the value of messagePattern
and
arg
parameters.
This form avoids superflous parameter construction. Whenever possible, you should use this form instead of constructing the message parameter using string concatenation.
messagePattern
- The message pattern which will be parsed and formattedarg
- The argument to replace the formatting element, i,e,
the '{}' pair within messagePattern
.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 info(Object)
for more detailed information.
message
- the message object to log.t
- the exception to log, including its stack trace.public boolean isAttached(Appender appender)
isAttached
in interface AppenderAttachable
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.
true
if this category is debug enabled,
false
otherwise.public boolean isTraceEnabled()
isDebugEnabled()
.
true
if this category is enabled for level
TRACE, false
otherwise.public boolean isEnabledFor(Level level)
Level
passed
as parameter. See also isDebugEnabled()
.
level
.public boolean isEnabledFor(Priority level)
public boolean isInfoEnabled()
isDebugEnabled()
.
true
if this category is enabled for level
info, false
otherwise.public void l7dlog(Level level, java.lang.String key, java.lang.Throwable t)
key
is
replaced by its localized version from the resource bundle.
setResourceBundle(java.util.ResourceBundle)
public void l7dlog(Level level, 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
.
public void log(Priority level, java.lang.Object message, java.lang.Throwable t)
public void log(Level level, java.lang.Object message, java.lang.Throwable t)
public void log(Priority level, java.lang.Object message)
public void log(Level level, java.lang.Object message)
log(
String callerFQCN, Level level, Object message, Throwable t)
.
public void log(java.lang.String callerFQCN, Level level, java.lang.Object message, java.lang.Throwable t)
callerFQCN
- 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 log(java.lang.String callerFQCN, Priority level, java.lang.Object message, java.lang.Throwable t)
public void removeAllAppenders()
Removed appenders are closed.
This is useful when re-reading configuration information.
removeAllAppenders
in interface AppenderAttachable
public void removeAppender(Appender appender)
Does not close the appender.
removeAppender
in interface AppenderAttachable
public void removeAppender(java.lang.String name)
Does not close the appender.
removeAppender
in interface AppenderAttachable
public void setAdditivity(boolean additive)
public void setLevel(Level level)
Level.TRACE
, Level.DEBUG
,
Level.INFO
, Level.WARN
,
Level.ERROR
, or 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 setResourceBundle(java.util.ResourceBundle bundle)
l7dlog(Level,String,Throwable)
and l7dlog(Level,String,Object[],Throwable)
.
public static void shutdown()
LogManager.shutdown()
instead.
Some appenders such as SocketAppender
and
AsyncAppender
need to be closed before the application exists.
Otherwise, pending logging events might be lost.
The shutdown
method is careful to close nested appenders
before closing regular appenders. This is allows configurations where a
regular appender is attached to a category and again to a nested
appender.
public 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 warn(Object, Throwable)
form instead.
message
- 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 warn(Object)
for more detailed information.
message
- the message object to log.t
- the exception to log, including its stack trace.public void warn(java.lang.Object messagePattern, java.lang.Object arg)
WARN
level with message formatting
done according to the value of messagePattern
and
arg
parameters.
This form avoids superflous parameter construction. Whenever possible, you should use this form instead of constructing the message parameter using string concatenation.
messagePattern
- The message pattern which will be parsed and formattedarg
- The argument to replace the formatting element, i,e,
the '{}' pair within messagePattern
.
|
Log4j 1.3alpha-3 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |