KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > corba > generator > dependencies > api > IDL3DeclarationDependencies


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.ComponentDecl;
32 import org.objectweb.openccm.ast.api.HomeDecl;
33 import org.objectweb.openccm.ast.api.InterfacePortDecl;
34 import org.objectweb.openccm.ast.api.EventPortDecl;
35 import org.objectweb.openccm.ast.api.TypeRef;
36 import java.util.Set JavaDoc;
37
38
39 /**
40  * This interface allows you to get classes dependencies for an IDL3 declaration.
41  *
42  * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
43  *
44  * @version 0.1
45  */

46
47 public interface IDL3DeclarationDependencies
48          extends IDL2DeclarationDependencies
49 {
50     /**
51      * Get Home File dependencies.
52      * This includes all inherited Homes.
53      *
54      * @param home - The home declaration.
55      * @param visited - List of previously visited declarations. Must not be null.
56      *
57      * @return The list of dependencies as a set of Files.
58      */

59     public Set JavaDoc
60     getHomeDependencies(HomeDecl home,
61                         Set JavaDoc visited);
62
63     /**
64      * Get Component File dependencies.
65      * This includes all inherited Components.
66      *
67      * @param comp - The Component declaration.
68      * @param visited - List of previously visited declarations. Must not be null.
69      *
70      * @return The list of dependencies as a set of Files.
71      */

72     public Set JavaDoc
73     getComponentDependencies(ComponentDecl comp,
74                              Set JavaDoc visited);
75
76     /**
77      * Get Interface Port Declaration File dependencies.
78      * This includes all inherited interfaces.
79      *
80      * @param itf_port - The interface port declaration.
81      * @param server - If true, include server class files.
82      * @param visited - List of previously visited declarations. Must not be null.
83      *
84      * @return The list of dependencies as a set of Files.
85      */

86     public Set JavaDoc
87     getInterfacePortDependencies(InterfacePortDecl itf_port,
88                                  boolean server,
89                                  Set JavaDoc visited);
90
91     /**
92      * Get Event port Declaration File dependencies.
93      * This includes all inherited interfaces.
94      *
95      * @param event_port - The event port declaration.
96      * @param server - If true, include server class files.
97      * @param visited - List of previously visited declarations. Must not be null.
98      *
99      * @return The list of dependencies as a set of Files.
100      */

101     public Set JavaDoc
102     getEventPortDependencies(EventPortDecl event_port,
103                              boolean server,
104                              Set JavaDoc visited);
105
106     /**
107      * Get dependencies for an IDL3 declaration.
108      *
109      * @param decl - Get dependencies for this declaration.
110      * @param visited - List of previously visited declarations. Must not be null.
111      *
112      * @return The list of dependencies as a set of Files.
113      */

114     public Set JavaDoc
115     getDeclarationDependencies(Declaration decl,
116                                Set JavaDoc visited);
117
118     /**
119      * Get Type Reference dependencies class files.
120      *
121      * @param aconst - Get dependencies from this type reference.
122      * @param visited - List of previously visited declarations. Must not be null.
123      *
124      * @return The list of dependencies as a set of Files.
125      */

126     public Set JavaDoc
127     getTypeRefDependencies(TypeRef type,
128                            Set JavaDoc visited);
129 }
130
Popular Tags