/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.avalon.framework.logger;

Utility class to allow easy construction of components that will perform 
logging.
Author:
Avalon Development Team
Version:
$Id: AbstractLogEnabled.java 506231 2007-02-12 02:36:54Z crossley $/**
 * Utility class to allow easy construction of components that will perform 
 * logging.
 *
 * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
 * @version $Id: AbstractLogEnabled.java 506231 2007-02-12 02:36:54Z crossley $
 */
public abstract class AbstractLogEnabled
    implements LogEnabled
{
    ///Base Logger instance
    private Logger m_logger;

    
Set the components logger.
Params:
logger – the logger/**
     * Set the components logger.
     *
     * @param logger the logger
     */
    public void enableLogging( final Logger logger )
    {
        m_logger = logger;
    }

    
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/**
     * 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.
     *
     * <p>There is no performance penalty as this is a final method
     * and will be inlined by the JVM.</p>
     *
     * @return the Logger
     */
    protected final Logger getLogger()
    {
        return m_logger;
    }

    
Helper method to setup other components with same logger.
Params:
component – the component to pass logger object to/**
     * Helper method to setup other components with same logger.
     *
     * @param component the component to pass logger object to
     */
    protected void setupLogger( final Object component )
    {
        setupLogger( component, (String)null );
    }

    
Helper method to setup other components with logger.
The logger has the subcategory of this components logger.
Params:
component – the component to pass logger object to
subCategory – the subcategory to use (may be null)/**
     * Helper method to setup other components with logger.
     * The logger has the subcategory of this components logger.
     *
     * @param component the component to pass logger object to
     * @param subCategory the subcategory to use (may be null)
     */
    protected void setupLogger( final Object component, final String subCategory )
    {
        Logger logger = m_logger;

        if( null != subCategory )
        {
            logger = m_logger.getChildLogger( subCategory );
        }

        setupLogger( component, logger );
    }

    
Helper method to setup other components with logger.
Params:
component – the component to pass logger object to
logger – the Logger/**
     * Helper method to setup other components with logger.
     *
     * @param component the component to pass logger object to
     * @param logger the Logger
     */
    protected void setupLogger( final Object component, final Logger logger )
    {
        if( component instanceof LogEnabled )
        {
            ( (LogEnabled)component ).enableLogging( logger );
        }
    }
}