KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > meta > info > CategoryDescriptor


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6
7  Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
8
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24
25  4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
26     "Apache Software Foundation" must not be used to endorse or promote
27     products derived from this software without prior written
28     permission. For written permission, please contact apache@apache.org.
29
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48
49 */
50
51 package org.apache.avalon.meta.info;
52
53 import java.util.Properties JavaDoc;
54
55 /**
56  * A descriptor describing an Avalon Logger
57  * child instances that the component will create using the
58  * <code>org.apache.avalon.framework.logger.Logger#getChildLogger</code>
59  * method. The name of each category is relative to the component. For
60  * example, a component with an internal logging category named "data"
61  * would aquire a logger for that category using the
62  * <code>m_logger.getChildLogger( "data" );</code>. The establishment
63  * of logging channels and targets for the returned channel is container
64  * concern facilities by type-level category declarations.
65  *
66  * <p>Also associated with each Logger is a set of arbitrary
67  * attributes that can be used to store extra information
68  * about Logger requirements.</p>
69  *
70  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
71  * @version $Revision: 1.5 $ $Date: 2003/07/14 20:14:24 $
72  */
73 public class CategoryDescriptor
74     extends Descriptor
75 {
76     public static final String JavaDoc SEPERATOR = ".";
77
78     private final String JavaDoc m_name;
79
80     /**
81      * Create a descriptor for logging category.
82      *
83      * @param name the logging category name
84      * @param attributes a set of attributes associated with the declaration
85      *
86      * @exception NullPointerException if name argument is null
87      */
88     public CategoryDescriptor( final String JavaDoc name,
89                              final Properties JavaDoc attributes )
90         throws NullPointerException JavaDoc
91     {
92         super( attributes );
93         if( null == name )
94         {
95             throw new NullPointerException JavaDoc( "name" );
96         }
97
98         m_name = name;
99     }
100
101     /**
102      * Return the name of logging category.
103      *
104      * @return the category name.
105      */
106     public String JavaDoc getName()
107     {
108         return m_name;
109     }
110
111    /**
112     * Test is the supplied object is equal to this object.
113     * @return true if the object are equivalent
114     */
115     public boolean equals( Object JavaDoc other )
116     {
117         boolean isEqual = other instanceof CategoryDescriptor;
118         if ( isEqual )
119         {
120             isEqual = isEqual && m_name.equals( ((CategoryDescriptor)other).m_name );
121         }
122         return isEqual;
123     }
124
125    /**
126     * Return the hashcode for the object.
127     * @return the hashcode value
128     */
129     public int hashCode()
130     {
131         int hash = super.hashCode();
132         hash >>>= 13;
133         hash ^= m_name.hashCode();
134         return hash;
135     }
136 }
137
Popular Tags