KickJava   Java API By Example, From Geeks To Geeks.

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


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.Properties JavaDoc;
53
54 import com.thoughtworks.qdox.model.DocletTag;
55 import com.thoughtworks.qdox.model.JavaClass;
56
57 /**
58  * A doclet tag representing the set of attributes associated with the class.
59  *
60  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
61  * @version $Revision: 1.1.1.1 $ $Date: 2003/07/10 12:10:38 $
62  */
63 public class AttributeTag extends AbstractTag
64 {
65    /**
66     * The javadoc key for the attribute tag.
67     */
68     public static final String JavaDoc KEY = "attribute";
69
70    /**
71     * The parameter name for the attribute key.
72     */
73     public static final String JavaDoc KEY_PARAM = "key";
74
75    /**
76     * The parameter name for the attribute value.
77     */
78     public static final String JavaDoc VALUE_PARAM = "value";
79
80    /**
81     * Creation of a new attribute tag.
82     * @param clazz the javadoc class descriptor
83     */
84     public AttributeTag( final JavaClass clazz )
85     {
86         super( clazz );
87     }
88
89    /**
90     * Return the value of all Avalon 'attribute' tags as a Properties value.
91     * @return the attribute set as a property instance
92     */
93     public Properties JavaDoc getProperties()
94     {
95         final Properties JavaDoc properties = new Properties JavaDoc();
96         final DocletTag[] tags = getJavaClass().getTagsByName( getNS() + Tags.DELIMITER + KEY );
97         for( int i = 0; i < tags.length; i++ )
98         {
99             final DocletTag tag = tags[ i ];
100             final String JavaDoc key = getNamedParameter( tag, KEY_PARAM );
101             final String JavaDoc value = getNamedParameter( tag, VALUE_PARAM );
102             properties.setProperty( key, value );
103         }
104         return properties;
105     }
106 }
107
Popular Tags