org.apache.avalon.framework.logger

Class AbstractLoggable

Implemented Interfaces:
Loggable

public abstract class AbstractLoggable
extends java.lang.Object
implements Loggable

Utility class to allow construction of easy components that will perform logging.
Version:
CVS $Revision: 1.19 $ $Date: 2004/02/11 14:34:26 $
Author:
Avalon Development Team

Method Summary

protected org.apache.log.Logger
getLogger()
Helper method to allow sub-classes to aquire logger.
void
setLogger(org.apache.log.Logger logger)
Set the components logger.
protected void
setupLogger(Object component)
Helper method to setup other components with same logger.
protected void
setupLogger(Object component, String subCategory)
Helper method to setup other components with logger.
protected void
setupLogger(Object component, org.apache.log.Logger logger)
Helper method to setup other components with logger.

Method Details

getLogger

protected final org.apache.log.Logger getLogger()
Helper method to allow sub-classes to aquire logger. This method exists rather than exposing a member variable because it protects other users against future changes. It also means they do not have to use our naming convention.

There is no performance penalty as this is a final method and will be inlined by the JVM.

Returns:
the Logger

setLogger

public void setLogger(org.apache.log.Logger logger)
Set the components logger.
Parameters:
logger - the logger

setupLogger

protected void setupLogger(Object component)
Helper method to setup other components with same logger.
Parameters:
component - the component to pass logger object to

setupLogger

protected void setupLogger(Object component,
                           String subCategory)
Helper method to setup other components with logger. The logger has the subcategory of this components logger.
Parameters:
component - the component to pass logger object to
subCategory - the subcategory to use (may be null)

setupLogger

protected void setupLogger(Object component,
                           org.apache.log.Logger logger)
Helper method to setup other components with logger.
Parameters:
component - the component to pass logger object to
logger - the Logger