|
Log4j 0.9.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.log4j.Category
This is the central class in the log4j package. One of the distintive features of log4j are hierarchal categories and their evaluation.
See the user manual for an introduction on this class.
Field Summary | |
protected boolean |
additive
Additivity is set to true by default, i.e. |
static String |
DEFAULT_INIT_OVERRIDE_KEY
Setting the system property log4j.defaultInitOverride to "true" or any other value than "false" will skip default configuration from the log4j.properties file. |
static String |
DEFAULT_PROPERTIES_FILE
At class initialization, the log4j.properties file is searched from the search path used to load classes. |
protected static int |
disable
|
protected static String |
instanceFQN
|
protected String |
name
The name of this category. |
protected Category |
parent
The parent of this category. |
protected Priority |
priority
The assigned priority of this category. |
protected ResourceBundle |
resourceBundle
|
Constructor Summary | |
protected |
Category(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 |
assert(boolean assertion,
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(Object message)
Log an object with debug priority. |
void |
debug(String message)
Log a message with debug priority. |
void |
debug(String message,
Throwable t)
Log a message with the debug priority. |
void |
error(Object message)
Log an object with error priority. |
void |
error(String message)
Log a message with error priority. |
void |
error(String message,
Throwable t)
Log a message with the error priority. |
static Category |
exists(String name)
If the named category exists (in the default hierarchy) then it returns a reference to the category, otherwise it returns null . |
boolean |
getAdditivity()
Get the additivity flag for this Category instance. |
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()
Starting from this category, search the category hierarchy for a non-null priority and return it. |
static Enumeration |
getCurrentCategories()
Returns all the currently defined categories in the default hierarchy as an Enumeration . |
static Category |
getInstance(String name)
Instantiate a category with name name . |
static Category |
getInstance(String name,
CategoryFactory factory)
Like getInstance(String) except that the type of category
instantiated depends on the type returned by the CategoryFactory.makeNewCategoryInstance(java.lang.String) method of the
factory parameter. |
String |
getName()
Return the category name. |
Priority |
getPriority()
Returns the assigned Priority , if any, for this Category. |
ResourceBundle |
getResourceBundle()
Return the ResourceBundle for this category. |
protected String |
getResourceBundleString(String key)
|
static Category |
getRoot()
Return the root of the default category hierrachy. |
static Priority |
getRootPriority()
Deprecated. Use getRoot().getPriority() instead. |
void |
info(Object message)
Log an object with INFO priority. |
void |
info(String message)
Log a message with info priority. |
void |
info(String message,
Throwable t)
Log a message with the info priority. |
boolean |
isDebugEnabled()
Check whether this category is enabled for the debug priority. |
boolean |
isEnabledFor(Priority priority)
Check whether this category is enabled for a given Priority passed as parameter. |
boolean |
isInfoEnabled()
Check whether this category is enabled for the debug priority. |
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,
String message)
Use this form for priorities which are not directly supported, namely Priority.NOTICE , Priority.ALERT , Priority.EMERG and Priority.CRIT . |
void |
log(Priority priority,
String message,
Throwable t)
Use this form for priorities which are not directly supported, namely Priority.NOTICE , Priority.ALERT , Priority.EMERG and Priority.CRIT . |
void |
log(String callerFQN,
Priority priority,
String message,
Throwable t)
This method is intended to be invoked by wrapper classes. |
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 |
setAdditivity(boolean additive)
Set the additivity flag for this Category instance. |
void |
setPriority(Priority priority)
Set the priority of this Category. |
void |
setResourceBundle(ResourceBundle bundle)
Set the resource bundle to be used with localized logging methods l7dlog(Priority,String,Throwable) and l7dlog(Priority,String,Object[],Throwable) . |
static void |
setRootPriority(Priority priority)
Set the priority of the root category. |
void |
warn(Object message)
Log an object with warn priority. |
void |
warn(String message)
Log a message with warn priority. |
void |
warn(String message,
Throwable t)
Log a message with the warn priority. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static String instanceFQN
protected static int disable
protected ResourceBundle resourceBundle
public static final String DEFAULT_PROPERTIES_FILE
PropertyConfigurator
.
The DEFAULT_PROPERTIES_FILE
string constant holds the
value log4j.properties
.public static final String DEFAULT_INIT_OVERRIDE_KEY
log4j.properties
file.
The current value of the DEFAULT_INIT_OVERRIDE_KEY string
constant is log4j.defaultInitOverride.
Note that property keys are case sensitive.
protected String name
protected Priority priority
null
.protected Category parent
protected boolean additive
Constructor Detail |
protected Category(String name)
It is intended to be used by sub-classes only.
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 assert(boolean assertion, String msg)
assertion
parameter is false
, then
logs msg
as an error
statement.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 always calls all the appenders inherited form the hierarchy circumventing any evaluation of whether to log or not to log the particular log request.
LoggingEvent
- the event to log.public void debug(Object message)
String.valueOf(Object)
before logging it exactly in the
same way as debug(String)
.
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 debug(String, Throwable)
form instead.
message
- object to convert to String before writing into the log filepublic void debug(String message)
message
- string to write in the log filepublic void debug(String message, Throwable t)
message
- string to appendexception
- the exception to log, including a stack tracepublic void error(Object message)
String.valueOf(Object)
before logging it exactly in
the same way as error(String)
.
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(String, Throwable)
form instead.
message
- object to convert to String before writing into the log filepublic void error(String message)
message
- string to write in the log filepublic void error(String message, Throwable t)
message
- string to appendexception
- the exception to log, including a stack tracepublic static Category exists(String name)
null
.
Contributed by Ciaran Treanor - ciaran@xelector.com
public boolean getAdditivity()
public Enumeration getAllAppenders()
null
is returned.getAllAppenders
in interface AppenderAttachable
public Appender getAppender(String name)
name
.
Return the appender with that name if in the list. Return null otherwise.
getAppender
in interface AppenderAttachable
public Priority getChainedPriority()
The Category class is designed so that this method executes as quickly as possible.
public static Enumeration getCurrentCategories()
Enumeration
.
The root category is not included in the returned
Enumeration
.
public static Category getInstance(String name)
name
. This
method does not set priority of the category which is by
default null
.name
- The name of the category to retrieve.public static Category getInstance(String name, CategoryFactory factory)
getInstance(String)
except that the type of category
instantiated depends on the type returned by the CategoryFactory.makeNewCategoryInstance(java.lang.String)
method of the
factory
parameter.
This method is intended to be used by sub-classes.
name
- The name of the category to retrieve.factory
- A CategoryFactory
implementation that will
actually create a new Instance.public final String getName()
public final Priority getPriority()
Priority
, if any, for this Category.null
.public static final Category getRoot()
The root category is always instantiated and available. It's name is "root".
Nevertheless, calling Category.getInstance("root")
does not retrieve the root category
but a category just under root named "root".
public static Priority getRootPriority()
root
category.public ResourceBundle getResourceBundle()
ResourceBundle
for this category.
This method walks the hierarchy to find the appropriate resource bundle.
In case there is no bundle in the hierarchy then
null
is returned.
protected String getResourceBundleString(String key)
public void info(Object message)
INFO
priority. This
method converts the (Object) passed as parameter to String using
String.valueOf(Object)
before logging it exactly
in the same way as info(String)
.
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 info(String, Throwable)
form instead.
message
- object to convert to String before writing into the log filepublic void info(String message)
message
- string to write in the log filepublic void info(String message, Throwable t)
message
- string to appendexception
- the exception to log, including a stack tracepublic boolean isDebugEnabled()
This function is intended to lessen the computational cost of (not) logging debug statements.
For some cat
Category object, when you write,
cat.debug("This is entry number: " + i );
You incur the cost constructing the message, concatenating in this case, regardless of whether the message will be logged or not.
If you are worried about speed, then you can write
if(cat.isDebugEnabled("some category") { 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 isEnabledFor(Priority priority)
Priority
passed as parameter.
See also isDebugEnabled()
.priority
.public boolean isInfoEnabled()
isDebugEnabled()
.true
if this category is enabled
for priority info, false
otherwise.public void l7dlog(Priority priority, String key, Throwable t)
key
is replaced by its localized version from the
resource bundle.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, String message, Throwable t)
Priority.NOTICE
, Priority.ALERT
, Priority.EMERG
and Priority.CRIT
. This method is
requried for UNIX syslog compatibility and also for internationalized
logging methods.public void log(Priority priority, String message)
Priority.NOTICE
, Priority.ALERT
, Priority.EMERG
and Priority.CRIT
. This method is
required for UNIX syslog compatibility.public void log(String callerFQN, Priority priority, String message, Throwable t)
callerFQN
- The wrapper class' fully qualified class name.priority
- The priority 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 AppenderAttachable
public void removeAppender(Appender appender)
removeAppender
in interface AppenderAttachable
public void removeAppender(String name)
removeAppender
in interface AppenderAttachable
public void setAdditivity(boolean additive)
public void setPriority(Priority priority)
Null values are admitted.
public void setResourceBundle(ResourceBundle bundle)
l7dlog(Priority,String,Throwable)
and l7dlog(Priority,String,Object[],Throwable)
.public static void setRootPriority(Priority priority)
public void warn(Object message)
String.valueOf(Object)
before logging it exactly in
the same way as warn(String)
.
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(String, Throwable)
form instead.
message
- object to convert to String before writing into the log filepublic void warn(String message)
message
- string to write in the log filepublic void warn(String message, Throwable t)
message
- string to appendt
- the exception to log, including a stack trace
|
Log4j 0.9.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |