Package org.apache.log4j
Class Category
- java.lang.Object
-
- org.apache.log4j.Category
-
- All Implemented Interfaces:
AppenderAttachable
- Direct Known Subclasses:
Logger
public class Category extends Object implements AppenderAttachable
Implementation of the Category class for compatibility, despite it having been deprecated a long, long time ago.
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanadditiveAdditivity is set to true by default, that is children inherit the appenders of their ancestors by default.protected ResourceBundlebundleResource bundle for localized messages.protected LevellevelThe assigned level of this category.protected StringnameThe name of this category.protected CategoryparentThe parent of this category.protected LoggerRepositoryrepositoryCategories need to know what Hierarchy they are in.
-
Constructor Summary
Constructors Modifier Constructor Description protectedCategory(String name)Constructor exposed by Log4j 1.2.protectedCategory(LoggerContext context, String name)Constructor used by Logger to specify a LoggerContext.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddAppender(Appender appender)AddnewAppenderto the list of appenders of this Category instance.voidassertLog(boolean assertion, String msg)voidcallAppenders(LoggingEvent event)Call the appenders in the hierrachy starting atthis.voiddebug(Object message)voiddebug(Object message, Throwable t)voiderror(Object message)voiderror(Object message, Throwable t)static Loggerexists(String name)Deprecated.Please useLogManager.exists(String)instead.voidfatal(Object message)voidfatal(Object message, Throwable t)voidforcedLog(String fqcn, Priority level, Object message, Throwable t)booleangetAdditivity()EnumerationgetAllAppenders()Get the appenders contained in this category as anEnumeration.AppendergetAppender(String name)Look for the appender named asname.PrioritygetChainedPriority()static EnumerationgetCurrentCategories()Deprecated.Please useLogManager.getCurrentLoggers()instead.static LoggerRepositorygetDefaultHierarchy()Deprecated.Please useLogManager.getLoggerRepository()instead.LevelgetEffectiveLevel()LoggerRepositorygetHierarchy()Deprecated.Please usegetLoggerRepository()instead.static CategorygetInstance(Class clazz)static CategorygetInstance(String name)LevelgetLevel()LoggerRepositorygetLoggerRepository()Gets the theLoggerRepositorywhere thisCategoryis attached.StringgetName()CategorygetParent()LevelgetPriority()ResourceBundlegetResourceBundle()static CategorygetRoot()voidinfo(Object message)voidinfo(Object message, Throwable t)booleanisAttached(Appender appender)Is the appender passed as parameter attached to this category?booleanisDebugEnabled()booleanisEnabledFor(Priority level)booleanisErrorEnabled()booleanisFatalEnabled()booleanisInfoEnabled()booleanisWarnEnabled()voidl7dlog(Priority priority, String key, Object[] params, Throwable t)voidl7dlog(Priority priority, String key, Throwable t)voidlog(String fqcn, Priority priority, Object message, Throwable t)voidlog(Priority priority, Object message)voidlog(Priority priority, Object message, Throwable t)voidremoveAllAppenders()Removes all previously added appenders from this Category instance.voidremoveAppender(String name)Removes the appender with the name passed as parameter form the list of appenders.voidremoveAppender(Appender appender)Removes the appender passed as parameter form the list of appenders.voidsetAdditivity(boolean additivity)voidsetLevel(Level level)voidsetPriority(Priority priority)voidsetResourceBundle(ResourceBundle bundle)static voidshutdown()Shuts down the current configuration.voidwarn(Object message)voidwarn(Object message, Throwable t)
-
-
-
Field Detail
-
name
protected String name
The name of this category.
-
additive
protected boolean additive
Additivity is set to true by default, that is children inherit the appenders of their ancestors by default. If this variable is set tofalsethen 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 tofalsetoo. See the user manual for more details.
-
level
protected volatile Level level
The assigned level of this category. Thelevelvariable need not be assigned a value in which case it is inherited form the hierarchy.
-
parent
protected volatile Category parent
The parent of this category. All categories have at least one ancestor which is the root category.
-
bundle
protected ResourceBundle bundle
Resource bundle for localized messages.
-
repository
protected LoggerRepository repository
Categories need to know what Hierarchy they are in.
-
-
Constructor Detail
-
Category
protected Category(LoggerContext context, String name)
Constructor used by Logger to specify a LoggerContext.- Parameters:
context- The LoggerContext.name- The name of the Logger.
-
Category
protected Category(String name)
Constructor exposed by Log4j 1.2.- Parameters:
name- The name of the Logger.
-
-
Method Detail
-
exists
@Deprecated public static Logger exists(String name)
Deprecated.Please useLogManager.exists(String)instead.Tests if the named category exists (in the default hierarchy).- Parameters:
name- The name to test.- Returns:
- Whether the name exists.
- Since:
- 0.8.5
-
getCurrentCategories
@Deprecated public static Enumeration getCurrentCategories()
Deprecated.Please useLogManager.getCurrentLoggers()instead.Returns all the currently defined categories in the default hierarchy as anEnumeration.The root category is not included in the returned
Enumeration.- Returns:
- and Enumeration of the Categories.
-
getDefaultHierarchy
@Deprecated public static LoggerRepository getDefaultHierarchy()
Deprecated.Please useLogManager.getLoggerRepository()instead.Gets the default LoggerRepository instance.- Returns:
- the default LoggerRepository instance.
- Since:
- 1.0
-
getRoot
public static Category getRoot()
-
shutdown
public static void shutdown()
Shuts down the current configuration.
-
addAppender
public void addAppender(Appender appender)
AddnewAppenderto the list of appenders of this Category instance.If
newAppenderis already in the list of appenders, then it won't be added again.- Specified by:
addAppenderin interfaceAppenderAttachable- Parameters:
appender- The Appender to add.
-
assertLog
public void assertLog(boolean assertion, String msg)Ifassertionparameter isfalse, then logsmsgas anerrorstatement.The
assertmethod has been renamed toassertLogbecauseassertis a language reserved word in JDK 1.4.- Parameters:
assertion- The assertion.msg- The message to print ifassertionis false.- Since:
- 1.2
-
callAppenders
public void callAppenders(LoggingEvent event)
Call the appenders in the hierrachy starting atthis. 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.
- Parameters:
event- the event to log.
-
debug
public void debug(Object message)
-
error
public void error(Object message)
-
fatal
public void fatal(Object message)
-
getAdditivity
public boolean getAdditivity()
-
getAllAppenders
public Enumeration getAllAppenders()
Get the appenders contained in this category as anEnumeration. If no appenders can be found, then aNullEnumerationis returned.- Specified by:
getAllAppendersin interfaceAppenderAttachable- Returns:
- Enumeration An enumeration of the appenders in this category.
-
getAppender
public Appender getAppender(String name)
Look for the appender named asname.Return the appender with that name if in the list. Return
nullotherwise.- Specified by:
getAppenderin interfaceAppenderAttachable- Parameters:
name- The name of the Appender.- Returns:
- The Appender.
-
getChainedPriority
public Priority getChainedPriority()
-
getEffectiveLevel
public Level getEffectiveLevel()
-
getHierarchy
@Deprecated public LoggerRepository getHierarchy()
Deprecated.Please usegetLoggerRepository()instead.Gets the theLoggerRepositorywhere thisCategoryinstance is attached.- Since:
- 1.1
-
getLevel
public final Level getLevel()
-
getLoggerRepository
public LoggerRepository getLoggerRepository()
Gets the theLoggerRepositorywhere thisCategoryis attached.- Since:
- 1.2
-
getName
public final String getName()
-
getParent
public final Category getParent()
-
getPriority
public final Level getPriority()
-
getResourceBundle
public ResourceBundle getResourceBundle()
-
info
public void info(Object message)
-
isAttached
public boolean isAttached(Appender appender)
Is the appender passed as parameter attached to this category?- Specified by:
isAttachedin interfaceAppenderAttachable- Parameters:
appender- The Appender to add.- Returns:
- true if the appender is attached.
-
isDebugEnabled
public boolean isDebugEnabled()
-
isEnabledFor
public boolean isEnabledFor(Priority level)
-
isErrorEnabled
public boolean isErrorEnabled()
-
isFatalEnabled
public boolean isFatalEnabled()
-
isInfoEnabled
public boolean isInfoEnabled()
-
isWarnEnabled
public boolean isWarnEnabled()
-
removeAllAppenders
public void removeAllAppenders()
Removes all previously added appenders from this Category instance.This is useful when re-reading configuration information.
- Specified by:
removeAllAppendersin interfaceAppenderAttachable
-
removeAppender
public void removeAppender(Appender appender)
Removes the appender passed as parameter form the list of appenders.- Specified by:
removeAppenderin interfaceAppenderAttachable- Parameters:
appender- The Appender to remove.- Since:
- 0.8.2
-
removeAppender
public void removeAppender(String name)
Removes the appender with the name passed as parameter form the list of appenders.- Specified by:
removeAppenderin interfaceAppenderAttachable- Parameters:
name- The Appender to remove.- Since:
- 0.8.2
-
setAdditivity
public void setAdditivity(boolean additivity)
-
setLevel
public void setLevel(Level level)
-
setPriority
public void setPriority(Priority priority)
-
setResourceBundle
public void setResourceBundle(ResourceBundle bundle)
-
warn
public void warn(Object message)
-
-