Package org.apache.commons.logging.impl

# Class Log4jApiLogFactory

java.lang.Object
org.apache.commons.logging.LogFactory
org.apache.commons.logging.impl.Log4jApiLogFactory

public final class Log4jApiLogFactory extends LogFactory
Logger factory hardcoded to send everything to Log4j API.

Based on the `log4j-jcl` artifact from Apache Logging Services.

Since:
  1.3.0

- ## Field Summary

  ### Fields inherited from class org.apache.commons.logging.LogFactory

  `DIAGNOSTICS_DEST_PROPERTY, factories, FACTORY_DEFAULT, FACTORY_PROPERTIES, FACTORY_PROPERTY, HASHTABLE_IMPLEMENTATION_PROPERTY, nullClassLoaderFactory, PRIORITY_KEY, SERVICE_ID, TCCL_KEY`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Log4jApiLogFactory()`
  Constructs a new instance.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `getAttribute(String name)`
  Gets the configuration attribute with the specified name (if any), or `null` if there is no such attribute.
  `String[]`
  `getAttributeNames()`
  Gets an array containing the names of all currently defined configuration attributes.
  `Log`
  `getInstance(Class<?> clazz)`
  Convenience method to derive a name from the specified class and call `getInstance(String)` with it.
  `Log`
  `getInstance(String name)`
  Constructs (if necessary) and return a `Log` instance, using the factory's current set of configuration attributes.
  `void`
  `release()`
  This method is supposed to clear all loggers.
  `void`
  `removeAttribute(String name)`
  Remove any configuration attribute associated with the specified name.
  `void`
  `setAttribute(String name, Object value)`
  Sets the configuration attribute with the specified name.

  ### Methods inherited from class org.apache.commons.logging.LogFactory

  `createFactory, directGetContextClassLoader, getClassLoader, getContextClassLoader, getFactory, getLog, getLog, handleThrowable, isDiagnosticsEnabled, logRawDiagnostic, newFactory, newFactory, objectId, release, releaseAll`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### Log4jApiLogFactory

    public Log4jApiLogFactory()
    Constructs a new instance.

- ## Method Details

  - ### getAttribute

    public Object getAttribute(String name)
    Description copied from class: `LogFactory`
    Gets the configuration attribute with the specified name (if any), or `null` if there is no such attribute.
    Specified by:
      `getAttribute` in class `LogFactory`
    Parameters:
      `name` - Name of the attribute to return
    Returns:
      the configuration attribute with the specified name.

  - ### getAttributeNames

    public String[] getAttributeNames()
    Description copied from class: `LogFactory`
    Gets an array containing the names of all currently defined configuration attributes. If there are no such attributes, a zero length array is returned.
    Specified by:
      `getAttributeNames` in class `LogFactory`
    Returns:
      an array containing the names of all currently defined configuration attributes

  - ### getInstance

    public Log getInstance(Class<?> clazz)
    Description copied from class: `LogFactory`
    Convenience method to derive a name from the specified class and call `getInstance(String)` with it.
    Specified by:
      `getInstance` in class `LogFactory`
    Parameters:
      `clazz` - Class for which a suitable Log name will be derived
    Returns:
      a name from the specified class.

  - ### getInstance

    public Log getInstance(String name)
    Description copied from class: `LogFactory`
    Constructs (if necessary) and return a `Log` instance, using the factory's current set of configuration attributes.

    NOTE - Depending upon the implementation of the `LogFactory` you are using, the `Log` instance you are returned may or may not be local to the current application, and may or may not be returned again on a subsequent call with the same name argument.

    Specified by:
      `getInstance` in class `LogFactory`
    Parameters:
      `name` - Logical name of the `Log` instance to be returned (the meaning of this name is only known to the underlying logging implementation that is being wrapped)
    Returns:
      a `Log` instance.

  - ### release

    public void release()
    This method is supposed to clear all loggers. In this implementation it will clear all the logger wrappers but the loggers managed by the underlying logger context will not be.
    Specified by:
      `release` in class `LogFactory`

  - ### removeAttribute

    public void removeAttribute(String name)
    Description copied from class: `LogFactory`
    Remove any configuration attribute associated with the specified name. If there is no such attribute, no action is taken.
    Specified by:
      `removeAttribute` in class `LogFactory`
    Parameters:
      `name` - Name of the attribute to remove

  - ### setAttribute

    public void setAttribute(String name, Object value)
    Description copied from class: `LogFactory`
    Sets the configuration attribute with the specified name. Calling this with a `null` value is equivalent to calling `removeAttribute(name)`.
    Specified by:
      `setAttribute` in class `LogFactory`
    Parameters:
      `name` - Name of the attribute to set
      `value` - Value of the attribute to set, or `null` to remove any setting for this attribute