KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > framework > logger > AbstractLogEnabled


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software
24  * itself, if and wherever such third-party acknowledgments
25  * normally appear.
26  *
27  * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
28  * must not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55 package org.apache.avalon.framework.logger;
56
57 /**
58  * Utility class to allow construction of easy components that will perform logging.
59  *
60  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
61  * @version CVS $Revision: 1.14 $ $Date: 2003/02/11 15:58:40 $
62  */
63 public abstract class AbstractLogEnabled
64     implements LogEnabled
65 {
66     ///Base Logger instance
67 private Logger m_logger;
68
69     /**
70      * Set the components logger.
71      *
72      * @param logger the logger
73      */
74     public void enableLogging( final Logger logger )
75     {
76         m_logger = logger;
77     }
78
79     /**
80      * Helper method to allow sub-classes to aquire logger.
81      * This method exists rather than exposing a member variable
82      * because it protects other users against future changes. It
83      * also means they do not have to use our naming convention.
84      *
85      * <p>There is no performance penalty as this is a final method
86      * and will be inlined by the JVM.</p>
87      *
88      * @return the Logger
89      */
90     protected final Logger getLogger()
91     {
92         return m_logger;
93     }
94
95     /**
96      * Helper method to setup other components with same logger.
97      *
98      * @param component the component to pass logger object to
99      */
100     protected void setupLogger( final Object JavaDoc component )
101     {
102         setupLogger( component, (String JavaDoc)null );
103     }
104
105     /**
106      * Helper method to setup other components with logger.
107      * The logger has the subcategory of this components logger.
108      *
109      * @param component the component to pass logger object to
110      * @param subCategory the subcategory to use (may be null)
111      */
112     protected void setupLogger( final Object JavaDoc component, final String JavaDoc subCategory )
113     {
114         Logger logger = m_logger;
115
116         if( null != subCategory )
117         {
118             logger = m_logger.getChildLogger( subCategory );
119         }
120
121         setupLogger( component, logger );
122     }
123
124     /**
125      * Helper method to setup other components with logger.
126      *
127      * @param component the component to pass logger object to
128      * @param logger the Logger
129      */
130     protected void setupLogger( final Object JavaDoc component, final Logger logger )
131     {
132         if( component instanceof LogEnabled )
133         {
134             ( (LogEnabled)component ).enableLogging( logger );
135         }
136     }
137 }
138
Popular Tags