KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.util.ArrayList JavaDoc;
53
54 import org.apache.avalon.meta.info.ExtensionDescriptor;
55
56 import com.thoughtworks.qdox.model.DocletTag;
57 import com.thoughtworks.qdox.model.JavaClass;
58
59 /**
60  * A doclet tag handler for the 'extension' tag.
61  *
62  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
63  * @version $Revision: 1.3 $ $Date: 2003/07/26 11:10:11 $
64  */
65 public class ExtensionTag extends AbstractTag
66 {
67
68    /**
69     * The javadoc key for the extension tag.
70     */
71     public static final String JavaDoc KEY = "extension";
72
73    /**
74     * The stage tag id parameter name.
75     */
76     public static final String JavaDoc LEGACY_URN_PARAM = "urn";
77
78    /**
79     * The stage tag id parameter name.
80     */
81     public static final String JavaDoc LEGACY_KEY_PARAM = "key";
82
83    /**
84     * The stage tag id parameter name.
85     */
86     public static final String JavaDoc ID_PARAM = "id";
87
88    /**
89     * The extension tag constructor.
90     * @param clazz the javadoc class descriptor.
91     */
92     public ExtensionTag( final JavaClass clazz )
93     {
94         super( clazz );
95     }
96
97    /**
98     * Return an array of StageDescriptor instances based on declared 'stage' tags.
99     * @return the stage descriptors
100     */
101     public ExtensionDescriptor[] getExtensions()
102     {
103         final ArrayList JavaDoc list = new ArrayList JavaDoc();
104         final DocletTag[] tags =
105           getJavaClass().getTagsByName( getNS() + Tags.DELIMITER + KEY );
106         for( int i = 0; i < tags.length; i++ )
107         {
108             list.add( getExtension( tags[i] ) );
109         }
110         return (ExtensionDescriptor[])list.toArray(
111           new ExtensionDescriptor[ list.size() ] );
112     }
113
114     private ExtensionDescriptor getExtension( DocletTag tag )
115     {
116         String JavaDoc value = getNamedParameter( tag, TYPE_PARAM, null );
117         if( value != null )
118         {
119             final String JavaDoc type = resolveType( value );
120             return new ExtensionDescriptor( type );
121         }
122         else
123         {
124             value = getNamedParameter( tag, LEGACY_KEY_PARAM, null );
125             if( value == null )
126             {
127                 value = getNamedParameter( tag, LEGACY_URN_PARAM, null );
128             }
129             if( value == null )
130             {
131                 value = getNamedParameter( tag, ID_PARAM );
132             }
133             return new ExtensionDescriptor( value );
134         }
135     }
136 }
137
Popular Tags