KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > meta > info > builder > tags > SchemaTag


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6
7  Copyright (C) 2002-2003 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 package org.apache.avalon.meta.info.builder.tags;
51
52
53 import com.thoughtworks.qdox.model.DocletTag;
54 import com.thoughtworks.qdox.model.JavaClass;
55 import com.thoughtworks.qdox.model.JavaMethod;
56
57 import java.util.ArrayList JavaDoc;
58 import java.util.HashSet JavaDoc;
59 import java.util.Set JavaDoc;
60
61 /**
62  * A doclet tag handler supporting 'logger' tags.
63  *
64  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
65  * @version $Revision: 1.1 $ $Date: 2003/07/24 12:12:02 $
66  */
67 public class SchemaTag extends AbstractTag
68 {
69     /**
70      * The default logger class.
71      */
72     protected static final String JavaDoc CONFIGURATION_CLASS =
73             "org.apache.avalon.framework.configuration.Configuration";
74
75     /**
76      * The javadoc key for the logger tag.
77      */
78     protected static final String JavaDoc KEY = "configuration";
79
80     /**
81      * The javadoc parameter name for the logging channel name
82      */
83     public static final String JavaDoc SCHEMA_PARAM = "schema";
84
85     private JavaMethod[] m_methods;
86
87     /**
88      * The configuration schema tag constructor.
89      * @param clazz the javadoc class descriptor.
90      */
91     public SchemaTag( final JavaClass clazz )
92     {
93         super( clazz );
94         setMethods();
95     }
96
97     /**
98      * Return a schema descriptor string if present
99      * @return the set of logger descriptos
100      */
101     public String JavaDoc getConfigurationSchema()
102     {
103         if( m_methods.length > 0 )
104         {
105             final DocletTag[] tags =
106              m_methods[0].getTagsByName( getNS() + Tags.DELIMITER + KEY );
107             if( tags.length > 0 )
108             {
109                 DocletTag tag = tags[0];
110                 return getNamedParameter( tag, SCHEMA_PARAM, null );
111             }
112         }
113         return null;
114     }
115
116     /**
117      * Set the value of the composition method.
118      */
119     private void setMethods()
120     {
121         m_methods = getLifecycleMethods( "configure", CONFIGURATION_CLASS );
122     }
123 }
124
Popular Tags