Log4j 1.3alpha-8

org.apache.log4j.spi
Class ComponentBase

java.lang.Object
  |
  +--org.apache.log4j.spi.ComponentBase
All Implemented Interfaces:
Component
Direct Known Subclasses:
Action, AppenderSkeleton, ConnectionSourceSkeleton, Filter, Layout, PluginSkeleton, PropertySetter, RendererMap, RollingPolicyBase, SocketNode, Util, XMLSocketNode

public class ComponentBase
extends Object
implements Component

Most log4j components derive from this class.

Since:
1.3
Author:
Ceki Gulcu

Field Summary
protected  LoggerRepository repository
           
 
Constructor Summary
ComponentBase()
           
 
Method Summary
protected  ULogger getLogger()
          Return an instance specific logger to be used by the component itself.
protected  LoggerRepository getLoggerRepository()
          Return the LoggerRepository this component is attached to.
protected  ULogger getNonFloodingLogger()
          Frequently called methods in log4j components can invoke this method in order to avoid flooding the output when logging lasting error conditions.
protected  void resetErrorCount()
          Called by derived classes when they deem that the component has recovered from an erroneous state.
 void setLoggerRepository(LoggerRepository repository)
          Set the owning repository.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

repository

protected LoggerRepository repository
Constructor Detail

ComponentBase

public ComponentBase()
Method Detail

resetErrorCount

protected void resetErrorCount()
Called by derived classes when they deem that the component has recovered from an erroneous state.

setLoggerRepository

public void setLoggerRepository(LoggerRepository repository)
Set the owning repository. The owning repository cannot be set more than once.
Specified by:
setLoggerRepository in interface Component
Following copied from interface: org.apache.log4j.spi.Component
Parameters:
repository - The repository where this appender is attached.
Throws:
IllegalStateException - If you try to change the repository after it has been set.

getLoggerRepository

protected LoggerRepository getLoggerRepository()
Return the LoggerRepository this component is attached to.
Returns:
Owning LoggerRepository

getLogger

protected ULogger getLogger()
Return an instance specific logger to be used by the component itself. This logger is not intended to be accessed by the end-user, hence the protected keyword.

In case the repository for this component is not set, this implementations returns a SimpleULogger instance.

Returns:
A ULogger instance.

getNonFloodingLogger

protected ULogger getNonFloodingLogger()
Frequently called methods in log4j components can invoke this method in order to avoid flooding the output when logging lasting error conditions.
Returns:
a regular logger, or a NOPLogger if called too frequently.

Log4j 1.3alpha-8

Copyright © 2000-2006 Apache Software Foundation.
Licensed under the Apache License, Version 2.0.