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 java.lang.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 (package private) AppenderAttachableImpl
aai
protected boolean
additive
Additivity is set to true by default, that is children inherit the appenders of their ancestors by default.protected java.util.ResourceBundle
bundle
Resource bundle for localized messages.private static java.lang.String
FQCN
protected Level
level
The assigned level of this category.private Logger
logger
protected java.lang.String
name
The name of this category.protected Category
parent
The parent of this category.private RendererMap
rendererMap
protected LoggerRepository
repository
Categories need to know what Hierarchy they are in.
-
Constructor Summary
Constructors Modifier Constructor Description protected
Category(java.lang.String name)
Constructor exposed by Log4j 1.2.(package private)
Category(Logger logger)
protected
Category(LoggerContext context, java.lang.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 void
addAppender(Appender appender)
AddnewAppender
to the list of appenders of this Category instance.void
assertLog(boolean assertion, java.lang.String msg)
void
callAppenders(LoggingEvent event)
Call the appenders in the hierrachy starting atthis
.(package private) void
closeNestedAppenders()
Closes all attached appenders implementing the AppenderAttachable interface.void
debug(java.lang.Object message)
void
debug(java.lang.Object message, java.lang.Throwable t)
void
error(java.lang.Object message)
void
error(java.lang.Object message, java.lang.Throwable t)
static Logger
exists(java.lang.String name)
Deprecated.Please useLogManager.exists(String)
instead.void
fatal(java.lang.Object message)
void
fatal(java.lang.Object message, java.lang.Throwable t)
private void
fireRemoveAppenderEvent(Appender appender)
LoggerRepository forgot the fireRemoveAppenderEvent method, if using the stock Hierarchy implementation, then call its fireRemove.void
forcedLog(java.lang.String fqcn, Priority level, java.lang.Object message, java.lang.Throwable t)
private <T> ObjectRenderer
get(java.lang.Class<T> clazz)
boolean
getAdditivity()
java.util.Enumeration
getAllAppenders()
Get the appenders contained in this category as anEnumeration
.Appender
getAppender(java.lang.String name)
Look for the appender named asname
.Priority
getChainedPriority()
static java.util.Enumeration
getCurrentCategories()
Deprecated.Please useLogManager.getCurrentLoggers()
instead.static LoggerRepository
getDefaultHierarchy()
Deprecated.Please useLogManager.getLoggerRepository()
instead.Level
getEffectiveLevel()
LoggerRepository
getHierarchy()
Deprecated.Please usegetLoggerRepository()
instead.static Category
getInstance(java.lang.Class clazz)
static Category
getInstance(java.lang.String name)
Level
getLevel()
private java.lang.String
getLevelStr(Priority priority)
(package private) Logger
getLogger()
LoggerRepository
getLoggerRepository()
Gets the theLoggerRepository
where thisCategory
is attached.java.lang.String
getName()
Category
getParent()
Level
getPriority()
java.util.ResourceBundle
getResourceBundle()
static Category
getRoot()
private static java.lang.String
getSubName(java.lang.String name)
void
info(java.lang.Object message)
void
info(java.lang.Object message, java.lang.Throwable t)
boolean
isAttached(Appender appender)
Is the appender passed as parameter attached to this category?boolean
isDebugEnabled()
boolean
isEnabledFor(Priority level)
private boolean
isEnabledFor(Level level)
boolean
isErrorEnabled()
boolean
isFatalEnabled()
boolean
isInfoEnabled()
boolean
isWarnEnabled()
void
l7dlog(Priority priority, java.lang.String key, java.lang.Object[] params, java.lang.Throwable t)
void
l7dlog(Priority priority, java.lang.String key, java.lang.Throwable t)
void
log(java.lang.String fqcn, Priority priority, java.lang.Object message, java.lang.Throwable t)
void
log(Priority priority, java.lang.Object message)
void
log(Priority priority, java.lang.Object message, java.lang.Throwable t)
(package private) void
maybeLog(java.lang.String fqcn, Level level, java.lang.Object message, java.lang.Throwable throwable)
void
removeAllAppenders()
Removes all previously added appenders from this Category instance.void
removeAppender(java.lang.String name)
Removes the appender with the name passed as parameter form the list of appenders.void
removeAppender(Appender appender)
Removes the appender passed as parameter form the list of appenders.(package private) ObjectRenderer
searchInterfaces(java.lang.Class<?> c)
void
setAdditivity(boolean additivity)
(package private) void
setHierarchy(LoggerRepository repository)
Only the Hiearchy class can set the hiearchy of a category.private void
setLevel(java.lang.String levelStr)
void
setLevel(Level level)
void
setPriority(Priority priority)
void
setResourceBundle(java.util.ResourceBundle bundle)
static void
shutdown()
Shuts down the current configuration.void
warn(java.lang.Object message)
void
warn(java.lang.Object message, java.lang.Throwable t)
-
-
-
Field Detail
-
FQCN
private static final java.lang.String FQCN
-
name
protected java.lang.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 tofalse
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 tofalse
too. See the user manual for more details.
-
level
protected volatile Level level
The assigned level of this category. Thelevel
variable need not be assigned a value in which case it is inherited form the hierarchy.
-
rendererMap
private RendererMap rendererMap
-
parent
protected volatile Category parent
The parent of this category. All categories have at least one ancestor which is the root category.
-
bundle
protected java.util.ResourceBundle bundle
Resource bundle for localized messages.
-
logger
private final Logger logger
-
repository
protected LoggerRepository repository
Categories need to know what Hierarchy they are in.
-
aai
AppenderAttachableImpl aai
-
-
Constructor Detail
-
Category
protected Category(LoggerContext context, java.lang.String name)
Constructor used by Logger to specify a LoggerContext.- Parameters:
context
- The LoggerContext.name
- The name of the Logger.
-
Category
Category(Logger logger)
-
Category
protected Category(java.lang.String name)
Constructor exposed by Log4j 1.2.- Parameters:
name
- The name of the Logger.
-
-
Method Detail
-
exists
@Deprecated public static Logger exists(java.lang.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 java.util.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
-
getInstance
public static Category getInstance(java.lang.Class clazz)
-
getInstance
public static Category getInstance(java.lang.String name)
-
getRoot
public static Category getRoot()
-
getSubName
private static java.lang.String getSubName(java.lang.String name)
-
shutdown
public static void shutdown()
Shuts down the current configuration.
-
addAppender
public void addAppender(Appender appender)
AddnewAppender
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.- Specified by:
addAppender
in interfaceAppenderAttachable
- Parameters:
appender
- The Appender to add.
-
assertLog
public void assertLog(boolean assertion, java.lang.String msg)
Ifassertion
parameter isfalse
, then logsmsg
as anerror
statement.The
assert
method has been renamed toassertLog
becauseassert
is a language reserved word in JDK 1.4.- Parameters:
assertion
- The assertion.msg
- The message to print ifassertion
is 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.
-
closeNestedAppenders
void closeNestedAppenders()
Closes all attached appenders implementing the AppenderAttachable interface.- Since:
- 1.0
-
debug
public void debug(java.lang.Object message)
-
debug
public void debug(java.lang.Object message, java.lang.Throwable t)
-
error
public void error(java.lang.Object message)
-
error
public void error(java.lang.Object message, java.lang.Throwable t)
-
fatal
public void fatal(java.lang.Object message)
-
fatal
public void fatal(java.lang.Object message, java.lang.Throwable t)
-
fireRemoveAppenderEvent
private void fireRemoveAppenderEvent(Appender appender)
LoggerRepository forgot the fireRemoveAppenderEvent method, if using the stock Hierarchy implementation, then call its fireRemove. Custom repositories can implement HierarchyEventListener if they want remove notifications.- Parameters:
appender
- appender, may be null.
-
forcedLog
public void forcedLog(java.lang.String fqcn, Priority level, java.lang.Object message, java.lang.Throwable t)
-
get
private <T> ObjectRenderer get(java.lang.Class<T> clazz)
-
getAdditivity
public boolean getAdditivity()
-
getAllAppenders
public java.util.Enumeration getAllAppenders()
Get the appenders contained in this category as anEnumeration
. If no appenders can be found, then aNullEnumeration
is returned.- Specified by:
getAllAppenders
in interfaceAppenderAttachable
- Returns:
- Enumeration An enumeration of the appenders in this category.
-
getAppender
public Appender getAppender(java.lang.String name)
Look for the appender named asname
.Return the appender with that name if in the list. Return
null
otherwise.- Specified by:
getAppender
in 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 theLoggerRepository
where thisCategory
instance is attached.- Since:
- 1.1
-
getLevel
public final Level getLevel()
-
getLevelStr
private java.lang.String getLevelStr(Priority priority)
-
getLogger
Logger getLogger()
-
getLoggerRepository
public LoggerRepository getLoggerRepository()
Gets the theLoggerRepository
where thisCategory
is attached.- Since:
- 1.2
-
getName
public final java.lang.String getName()
-
getParent
public final Category getParent()
-
getPriority
public final Level getPriority()
-
getResourceBundle
public java.util.ResourceBundle getResourceBundle()
-
info
public void info(java.lang.Object message)
-
info
public void info(java.lang.Object message, java.lang.Throwable t)
-
isAttached
public boolean isAttached(Appender appender)
Is the appender passed as parameter attached to this category?- Specified by:
isAttached
in interfaceAppenderAttachable
- Parameters:
appender
- The Appender to add.- Returns:
- true if the appender is attached.
-
isDebugEnabled
public boolean isDebugEnabled()
-
isEnabledFor
private boolean isEnabledFor(Level level)
-
isEnabledFor
public boolean isEnabledFor(Priority level)
-
isErrorEnabled
public boolean isErrorEnabled()
-
isFatalEnabled
public boolean isFatalEnabled()
-
isInfoEnabled
public boolean isInfoEnabled()
-
isWarnEnabled
public boolean isWarnEnabled()
-
l7dlog
public void l7dlog(Priority priority, java.lang.String key, java.lang.Object[] params, java.lang.Throwable t)
-
l7dlog
public void l7dlog(Priority priority, java.lang.String key, java.lang.Throwable t)
-
log
public void log(Priority priority, java.lang.Object message)
-
log
public void log(Priority priority, java.lang.Object message, java.lang.Throwable t)
-
log
public void log(java.lang.String fqcn, Priority priority, java.lang.Object message, java.lang.Throwable t)
-
maybeLog
void maybeLog(java.lang.String fqcn, Level level, java.lang.Object message, java.lang.Throwable throwable)
-
removeAllAppenders
public void removeAllAppenders()
Removes all previously added appenders from this Category instance.This is useful when re-reading configuration information.
- Specified by:
removeAllAppenders
in interfaceAppenderAttachable
-
removeAppender
public void removeAppender(Appender appender)
Removes the appender passed as parameter form the list of appenders.- Specified by:
removeAppender
in interfaceAppenderAttachable
- Parameters:
appender
- The Appender to remove.- Since:
- 0.8.2
-
removeAppender
public void removeAppender(java.lang.String name)
Removes the appender with the name passed as parameter form the list of appenders.- Specified by:
removeAppender
in interfaceAppenderAttachable
- Parameters:
name
- The Appender to remove.- Since:
- 0.8.2
-
searchInterfaces
ObjectRenderer searchInterfaces(java.lang.Class<?> c)
-
setAdditivity
public void setAdditivity(boolean additivity)
-
setHierarchy
final void setHierarchy(LoggerRepository repository)
Only the Hiearchy class can set the hiearchy of a category. Default package access is MANDATORY here.
-
setLevel
public void setLevel(Level level)
-
setLevel
private void setLevel(java.lang.String levelStr)
-
setPriority
public void setPriority(Priority priority)
-
setResourceBundle
public void setResourceBundle(java.util.ResourceBundle bundle)
-
warn
public void warn(java.lang.Object message)
-
warn
public void warn(java.lang.Object message, java.lang.Throwable t)
-
-