Category (Apache Log4j 1.x Compatibility API 2.19.0 API)

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 and Description
`protected boolean`	`additive` Additivity is set to true by default, that is children inherit the appenders of their ancestors by default.
`protected ResourceBundle`	`bundle` Resource bundle for localized messages.
`protected Level`	`level` The assigned level of this category.
`protected String`	`name` The name of this category.
`protected Category`	`parent` The parent of this category.
`protected LoggerRepository`	`repository` Categories need to know what Hierarchy they are in.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Category(LoggerContext context, String name)` Constructor used by Logger to specify a LoggerContext.
`protected`	`Category(String name)` Constructor exposed by Log4j 1.2.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAppender(Appender appender)` Add `newAppender` to the list of appenders of this Category instance.
`void`	`assertLog(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)`
`void`	`debug(Object message, Throwable t)`
`void`	`error(Object message)`
`void`	`error(Object message, Throwable t)`
`static Logger`	`exists(String name)` Deprecated. Please use `LogManager.exists(String)` instead.
`void`	`fatal(Object message)`
`void`	`fatal(Object message, Throwable t)`
`void`	`forcedLog(String fqcn, Priority level, Object message, Throwable t)`
`boolean`	`getAdditivity()`
`Enumeration`	`getAllAppenders()` Get all the Log4j 1.x appenders contained in this category as an `Enumeration`.
`Appender`	`getAppender(String name)` Look for the appender named as `name`.
`Priority`	`getChainedPriority()`
`static Enumeration`	`getCurrentCategories()` Deprecated. Please use `LogManager.getCurrentLoggers()` instead.
`static LoggerRepository`	`getDefaultHierarchy()` Deprecated. Please use `LogManager.getLoggerRepository()` instead.
`Level`	`getEffectiveLevel()`
`LoggerRepository`	`getHierarchy()` Deprecated. Please use `getLoggerRepository()` instead.
`static Category`	`getInstance(Class clazz)`
`static Category`	`getInstance(String name)`
`Level`	`getLevel()`
`LoggerRepository`	`getLoggerRepository()` Gets the `LoggerRepository` where this `Category` is attached.
`String`	`getName()`
`Category`	`getParent()`
`Level`	`getPriority()`
`ResourceBundle`	`getResourceBundle()`
`static Category`	`getRoot()`
`void`	`info(Object message)`
`void`	`info(Object message, Throwable t)`
`boolean`	`isAttached(Appender appender)` Is the appender passed as parameter attached to this category?
`boolean`	`isDebugEnabled()`
`boolean`	`isEnabledFor(Priority level)`
`boolean`	`isErrorEnabled()`
`boolean`	`isFatalEnabled()`
`boolean`	`isInfoEnabled()`
`boolean`	`isWarnEnabled()`
`void`	`l7dlog(Priority priority, String key, Object[] params, Throwable t)`
`void`	`l7dlog(Priority priority, String key, Throwable t)`
`void`	`log(Priority priority, Object message)`
`void`	`log(Priority priority, Object message, Throwable t)`
`void`	`log(String fqcn, Priority priority, Object message, Throwable t)`
`void`	`removeAllAppenders()` Removes all previously added appenders from this Category instance.
`void`	`removeAppender(Appender appender)` Removes the appender passed as parameter form the list of appenders.
`void`	`removeAppender(String name)` Removes the appender with the name passed as parameter form the list of appenders.
`void`	`setAdditivity(boolean additivity)`
`void`	`setLevel(Level level)`
`void`	`setPriority(Priority priority)`
`void`	`setResourceBundle(ResourceBundle bundle)`
`static void`	`shutdown()` Shuts down the current configuration.
`void`	`warn(Object message)`
`void`	`warn(Object message, Throwable t)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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 to 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.
  - level
```
protected volatile Level level
```
    The assigned level of this category. The level variable 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 use LogManager.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 use LogManager.getCurrentLoggers() instead.
    
    Returns all the currently defined categories in the default hierarchy as an Enumeration.
    The root category is not included in the returned Enumeration.
    
    Returns:
    
    and Enumeration of the Categories.
  - getDefaultHierarchy
```
@Deprecated
public static LoggerRepository getDefaultHierarchy()
```
    Deprecated. Please use LogManager.getLoggerRepository() instead.
    
    Gets the default LoggerRepository instance.
    
    Returns:
    
    the default LoggerRepository instance.
    
    Since:
    
    1.0
  - getInstance
```
public static Category getInstance(Class clazz)
```
  - getInstance
```
public static Category getInstance(String name)
```
  - getRoot
```
public static Category getRoot()
```
  - shutdown
```
public static void shutdown()
```
    Shuts down the current configuration.
  - addAppender
```
public void addAppender(Appender appender)
```
    Add 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.
    
    Specified by:
    
    addAppender in interface AppenderAttachable
    
    Parameters:
    
    appender - The Appender to add.
  - assertLog
```
public void assertLog(boolean assertion,
                      String msg)
```
    If 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.
    
    Parameters:
    
    assertion - The assertion.
    
    msg - The message to print if assertion is false.
    
    Since:
    
    1.2
  - callAppenders
```
public void callAppenders(LoggingEvent event)
```
    Call the appenders in the hierrachy starting at 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.
    
    Parameters:
    
    event - the event to log.
  - debug
```
public void debug(Object message)
```
  - debug
```
public void debug(Object message,
                  Throwable t)
```
  - error
```
public void error(Object message)
```
  - error
```
public void error(Object message,
                  Throwable t)
```
  - fatal
```
public void fatal(Object message)
```
  - fatal
```
public void fatal(Object message,
                  Throwable t)
```
  - forcedLog
```
public void forcedLog(String fqcn,
                      Priority level,
                      Object message,
                      Throwable t)
```
  - getAdditivity
```
public boolean getAdditivity()
```
  - getAllAppenders
```
public Enumeration getAllAppenders()
```
    Get all the Log4j 1.x appenders contained in this category as an Enumeration. Log4j 2.x appenders are omitted.
    
    Specified by:
    
    getAllAppenders in interface AppenderAttachable
    
    Returns:
    
    Enumeration An enumeration of the appenders in this category.
  - getAppender
```
public Appender getAppender(String name)
```
    Look for the appender named as name.
    Return the appender with that name if in the list. Return null otherwise.
    
    Specified by:
    
    getAppender in interface AppenderAttachable
    
    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 use getLoggerRepository() instead.
    
    Gets the LoggerRepository where this Category instance is attached.
    
    Since:
    
    1.1
  - getLevel
```
public final Level getLevel()
```
  - getLoggerRepository
```
public LoggerRepository getLoggerRepository()
```
    Gets the LoggerRepository where this Category is 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)
```
  - info
```
public void info(Object message,
                 Throwable t)
```
  - isAttached
```
public boolean isAttached(Appender appender)
```
    Is the appender passed as parameter attached to this category?
    
    Specified by:
    
    isAttached in interface AppenderAttachable
    
    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()
```
  - l7dlog
```
public void l7dlog(Priority priority,
                   String key,
                   Object[] params,
                   Throwable t)
```
  - l7dlog
```
public void l7dlog(Priority priority,
                   String key,
                   Throwable t)
```
  - log
```
public void log(Priority priority,
                Object message)
```
  - log
```
public void log(Priority priority,
                Object message,
                Throwable t)
```
  - log
```
public void log(String fqcn,
                Priority priority,
                Object message,
                Throwable t)
```
  - 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 interface AppenderAttachable
  - removeAppender
```
public void removeAppender(Appender appender)
```
    Removes the appender passed as parameter form the list of appenders.
    
    Specified by:
    
    removeAppender in interface AppenderAttachable
    
    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:
    
    removeAppender in interface AppenderAttachable
    
    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)
```
  - warn
```
public void warn(Object message,
                 Throwable t)
```

Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.

Class Category

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

additive

level

parent

bundle

repository

Constructor Detail

Category

Category

Method Detail

exists

getCurrentCategories

getDefaultHierarchy

getInstance

getInstance

getRoot

shutdown

addAppender

assertLog

callAppenders

debug

debug

error

error

fatal

fatal

forcedLog

getAdditivity

getAllAppenders

getAppender

getChainedPriority

getEffectiveLevel

getHierarchy

getLevel

getLoggerRepository

getName

getParent

getPriority

getResourceBundle

info

info

isAttached

isDebugEnabled

isEnabledFor

isErrorEnabled

isFatalEnabled

isInfoEnabled

isWarnEnabled

l7dlog

l7dlog

log

log

log

removeAllAppenders

removeAppender

removeAppender

setAdditivity

setLevel

setPriority

setResourceBundle

warn

warn