CIDLFileDependenciesResolver


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.Scope;
31  import org.objectweb.openccm.ast.api.CompositionDecl;
32  import org.objectweb.openccm.generator.common.lib.GenerationException;
33  
34  
35  /**
36   * This interface allows you to generate class file dependencies
37   * for a CIDL Composition.
38   *
39   * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
40   *
41   * @version 0.1
42   */
43  public interface CIDLFileDependenciesResolver
44  {
45      /**
46       * Set filters for class dependencies.
47       *
48       * @param filters - The list of filters to add.
49       */
50      public void
51      set_filters(String  [] filters);
52  
53      /**
54       * Generate class files dependencies for a composition.
55       *
56       * @param composition - The composition declaration.
57       * @param file - The name of the file to write dependencies in.
58       *
59       * @throws GenerationException if an exception occurs.
60       */
61      public void
62      generate_composition_dependencies(CompositionDecl composition,
63                                        String   file);
64  
65      /**
66       * Generate class files dependencies for a composition.
67       *
68       * @param name - The name of the composition.
69       * @param file - The name of the file to write dependencies in.
70       *
71       * @throws GenerationException if an exception occurs.
72       */
73      public void
74      generate_composition_dependencies(String   name, String   file)
75      throws GenerationException;
76  
77      /**
78       * Generate class files dependencies for all composition
79       * contained in this scope.
80       *
81       * @param filescope - The source AST FileScope returned by the compile() method.
82       * @param base_dir - The base directory for dependencies output.
83       *
84       * @throws GenerationException if an exception occurs.
85       */
86      public void
87      generate_dependencies(Scope scope,
88                            String   base_dir)
89      throws GenerationException;
90  }
91
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags