IDL2DeclarationDependencies


1   /*====================================================================
2   
3   OpenCCM: The Open CORBA Component Model Platform
4   Copyright (C) 2000-2004 INRIA & USTL - LIFL - GOAL
5   Contact: openccm@objectweb.org
6   
7   This library is free software; you can redistribute it and/or
8   modify it under the terms of the GNU Lesser General Public
9   License as published by the Free Software Foundation; either
10  version 2.1 of the License, or any later version.
11  
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  Lesser General Public License for more details.
16  
17  You should have received a copy of the GNU Lesser General Public
18  License along with this library; if not, write to the Free Software
19  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
20  USA
21  
22  Initial developer(s): Christophe Demarey.
23  Contributor(s): ______________________________________.
24  
25  ====================================================================*/
26  
27  package org.objectweb.corba.generator.dependencies.api;
28  
29  // Package dependencies.
30  import org.objectweb.openccm.ast.api.Declaration;
31  import org.objectweb.openccm.ast.api.ConstantDecl;
32  import org.objectweb.openccm.ast.api.EnumDecl;
33  import org.objectweb.openccm.ast.api.StructDecl;
34  import org.objectweb.openccm.ast.api.UnionDecl;
35  import org.objectweb.openccm.ast.api.AbstractInterfaceDecl;
36  import org.objectweb.openccm.ast.api.LocalInterfaceDecl;
37  import org.objectweb.openccm.ast.api.InterfaceDecl;
38  import org.objectweb.openccm.ast.api.ValueDecl;
39  import org.objectweb.openccm.ast.api.ValueBoxDecl;
40  import org.objectweb.openccm.ast.api.ExceptionDecl;
41  import org.objectweb.openccm.ast.api.AliasDecl;
42  import org.objectweb.openccm.ast.api.AnyValue;
43  import org.objectweb.openccm.ast.api.Scope;
44  import org.objectweb.openccm.ast.api.AttributeDecl;
45  import org.objectweb.openccm.ast.api.OperationDecl;
46  import org.objectweb.openccm.ast.api.TypeRef;
47  import java.util.Set  ;
48  
49  /**
50   * This interface allows you to get classes dependencies for an IDL2 declaration.
51   *
52   * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
53   *
54   * @version 0.1
55   */
56  
57  public interface IDL2DeclarationDependencies
58  {
59      /**
60       * Get Constant dependencies class files.
61       *
62       * @param aconst - Get dependencies from this constant.
63       * @param visited - List of previously visited declarations. Must not be null.
64       *
65       * @return The list of dependencies as a set of Files.
66       */
67      public Set  
68      getConstantDependencies(ConstantDecl aconst,
69                              Set   visited);
70  
71      /**
72       * Get Enum dependencies class files.
73       *
74       * @param enumDecl - Get dependencies from this enumeration.
75       * @param visited - List of previously visited declarations. Must not be null.
76       *
77       * @return The list of dependencies as a set of Files.
78       */
79      public Set  
80      getEnumDependencies(EnumDecl enumDecl,
81                          Set   visited);
82  
83      /**
84       * Get Struct dependencies class files.
85       *
86       * @param struct - Get dependencies from this structure.
87       * @param visited - List of previously visited declarations. Must not be null.
88       *
89       * @return The list of dependencies as a set of Files.
90       */
91      public Set  
92      getStructDependencies(StructDecl struct,
93                            Set   visited);
94  
95      /**
96       * Get Union dependencies class files.
97       *
98       * @param union - Get dependencies from this union.
99       * @param visited - List of previously visited declarations. Must not be null.
100      *
101      * @return The list of dependencies as a set of Files.
102      */
103     public Set  
104     getUnionDependencies(UnionDecl union,
105                          Set   visited);
106 
107     /**
108      * Get Abstract Interface dependencies class files.
109      *
110      * @param itf - Get dependencies from this abstrat interface.
111      * @param visited - List of previously visited declarations. Must not be null.
112      *
113      * @return The list of dependencies as a set of Files.
114      */
115     public Set  
116     getAbstractInterfaceDependencies(AbstractInterfaceDecl itf,
117                                      Set   visited);
118 
119     /**
120      * Get Local Interface dependencies class files.
121      *
122      * @param itf - Get dependencies from this local interface.
123      * @param visited - List of previously visited declarations. Must not be null.
124      *
125      * @return The list of dependencies as a set of Files.
126      */
127     public Set  
128     getLocalInterfaceDependencies(LocalInterfaceDecl itf,
129                                   Set   visited);
130 
131     /**
132      * Get Interface dependencies class files.
133      *
134      * @param itf - Get dependencies from this interface.
135      * @param server - If true, include server class files.
136      * @param visited - List of previously visited declarations. Must not be null.
137      *
138      * @return The list of dependencies as a set of Files.
139      */
140     public Set  
141     getInterfaceDependencies(InterfaceDecl itf,
142                              boolean server,
143                              Set   visited);
144 
145     /**
146      * Get Value Type dependencies class files.
147      *
148      * @param value - Get dependencies from this value type.
149      * @param visited - List of previously visited declarations. Must not be null.
150      *
151      * @return The list of dependencies as a set of Files.
152      */
153     public Set  
154     getValueTypeDependencies(ValueDecl value,
155                              Set   visited);
156 
157     /**
158      * Get Value Box dependencies class files.
159      *
160      * @param box - Get dependencies from this value box.
161      * @param visited - List of previously visited declarations. Must not be null.
162      *
163      * @return The list of dependencies as a set of Files.
164      */
165     public Set  
166     getValueBoxDependencies(ValueBoxDecl box,
167                             Set   visited);
168 
169     /**
170      * Get Exception dependencies class files.
171      *
172      * @param ex - Get dependencies from this exception.
173      * @param visited - List of previously visited declarations. Must not be null.
174      *
175      * @return The list of dependencies as a set of Files.
176      */
177     public Set  
178     getExceptionDependencies(ExceptionDecl ex,
179                              Set   visited);
180 
181     /**
182      * Get Any Value dependencies class files.
183      *
184      * @param any - Get dependencies from this Any Value.
185      * @param visited - List of previously visited declarations. Must not be null.
186      *
187      * @return The list of dependencies as a set of Files.
188      */
189     public Set  
190     getAnyValueDependencies(AnyValue any,
191                             Set   visited);
192 
193     /**
194      * Get Alias dependencies class files.
195      *
196      * @param alias - Get dependencies from this Alias.
197      * @param visited - List of previously visited declarations. Must not be null.
198      *
199      * @return The list of dependencies as a set of Files.
200      */
201     public Set  
202     getAliasDependencies(AliasDecl alias,
203                          Set   visited);
204 
205     /**
206      * Get Attribute dependencies class files.
207      *
208      * @param att - Get dependencies from this attribute.
209      * @param visited - List of previously visited declarations. Must not be null.
210      *
211      * @return The list of dependencies as a set of Files.
212      */
213     public Set  
214     getAttributeDependencies(AttributeDecl att,
215                              Set   visited);
216 
217     /**
218      * Get Operation dependencies class files.
219      *
220      * @param op - Get dependencies from this operation.
221      * @param visited - List of previously visited declarations. Must not be null.
222      *
223      * @return The list of dependencies as a set of Files.
224      */
225     public Set  
226     getOperationDependencies(OperationDecl op,
227                              Set   visited);
228 
229     /**
230      * Get scope contents dependencies.
231      *
232      * @param scope - Get dependencies for scope contents.
233      * @param visited - List of previously visited declarations. Must not be null.
234      *
235      * @return The list of dependencies as a set of Files.
236      */
237     public Set  
238     getContentsDependencies(Scope scope,
239                             Set   visited);
240 
241     /**
242      * Get dependencies for an IDL2 declaration.
243      *
244      * @param decl - Get dependencies for this declaration.
245      * @param visited - List of previously visited declarations. Must not be null.
246      *
247      * @return The list of dependencies as a set of Files.
248      */
249     public Set  
250     getDeclarationDependencies(Declaration decl,
251                                Set   visited);
252 
253     /**
254      * Get Type Reference dependencies class files.
255      *
256      * @param aconst - Get dependencies from this type reference.
257      * @param visited - List of previously visited declarations. Must not be null.
258      *
259      * @return The list of dependencies as a set of Files.
260      */
261     public Set  
262     getTypeRefDependencies(TypeRef type,
263                            Set   visited);
264 }
265
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags