KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.apache.avalon.framework.Version;
57 import org.apache.avalon.meta.info.DependencyDescriptor;
58 import org.apache.avalon.meta.info.ReferenceDescriptor;
59
60 import java.util.ArrayList JavaDoc;
61 import java.util.HashSet JavaDoc;
62 import java.util.Set JavaDoc;
63
64 /**
65  * A doclet tag representing the lifestyle assigned to the Type.
66  *
67  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
68  * @version $Revision: 1.3 $ $Date: 2003/07/21 20:05:17 $
69  */
70 public class DependencyTag extends AbstractTag
71 {
72     /**
73      * The dependency tag name.
74      */
75     public static final String JavaDoc KEY = "dependency";
76
77     /**
78      * The dependency tag key parameter name.
79      */
80     public static final String JavaDoc KEY_PARAM = "key";
81
82     /**
83      * The dependency tag optional parameter name.
84      */
85     public static final String JavaDoc OPTIONAL_PARAM = "optional";
86
87     /**
88      * The default component manager class.
89      */
90     protected static final String JavaDoc COMPONENT_MANAGER_CLASS =
91             "org.apache.avalon.framework.component.ComponentManager";
92
93     /**
94      * The default service manager class.
95      */
96     protected static final String JavaDoc SERVICE_MANAGER_CLASS =
97             "org.apache.avalon.framework.service.ServiceManager";
98
99     private JavaMethod[] m_methods;
100
101     /**
102      * Class constructor.
103      * @param clazz the javadoc class descriptor
104      */
105     public DependencyTag( final JavaClass clazz )
106     {
107         super( clazz );
108         setMethods();
109     }
110
111     /**
112      * Return the array of dependency descriptors based on the set of
113      * 'dependency' tags associated with the components compose or service method.
114      * @return the set of dependencies
115      */
116     public DependencyDescriptor[] getDependencies()
117     {
118         final ArrayList JavaDoc deps = new ArrayList JavaDoc();
119         final Set JavaDoc marked = new HashSet JavaDoc( 10 );
120         for ( int j = 0; j < m_methods.length; j++ )
121         {
122             final DocletTag[] tags =
123                     m_methods[j].getTagsByName( getNS()
124                     + Tags.DELIMITER + KEY );
125
126             for ( int i = 0; i < tags.length; i++ )
127             {
128                 DocletTag tag = tags[i];
129                 DependencyDescriptor dep = getDependency( tag );
130                 final String JavaDoc key = dep.getKey();
131                 if ( !marked.contains( key ) )
132                 {
133                     deps.add( dep );
134                     marked.add( key );
135                 }
136             }
137         }
138         return (DependencyDescriptor[]) deps.toArray(
139                 new DependencyDescriptor[deps.size()] );
140     }
141
142     private DependencyDescriptor getDependency( DocletTag tag )
143     {
144         final String JavaDoc value = getNamedParameter( tag, TYPE_PARAM );
145         final String JavaDoc type = resolveType( value );
146         final String JavaDoc versionString = getNamedParameter( tag, VERSION_PARAM, null );
147         final Version version = resolveVersion( versionString, value );
148         final String JavaDoc key = getNamedParameter( tag, KEY_PARAM, type );
149         final String JavaDoc optional = getNamedParameter( tag, OPTIONAL_PARAM, "false" );
150         final boolean isOptional = "true".equals( optional.toLowerCase() );
151         final ReferenceDescriptor ref = new ReferenceDescriptor( type, version );
152         return new DependencyDescriptor( key, ref, isOptional, null );
153     }
154
155     /**
156      * Set the value of the composition method.
157      */
158     private void setMethods()
159     {
160         m_methods = getLifecycleMethods( "compose", COMPONENT_MANAGER_CLASS );
161         if ( m_methods.length == 0 )
162         {
163             m_methods = getLifecycleMethods( "service", SERVICE_MANAGER_CLASS );
164         }
165     }
166 }
167
Popular Tags