KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > openccm > corba > idl2java > IdlToJavaOperations


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.openccm.corba.idl2java;
28
29 // Package dependencies
30
import java.util.Map JavaDoc;
31
32 /**
33  * Common Interface for an IDL to Java generator.
34  *
35  * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
36  *
37  * @version 0.1
38  */

39 public interface IdlToJavaOperations
40 {
41     /**
42      * Set the IDL file to parse.
43      *
44      * @param file - The input file.
45      */

46     public void
47     setInputFile(String JavaDoc file);
48     
49     /**
50      * Get the IDL file to parse.
51      *
52      * @return The input file.
53      */

54     public String JavaDoc
55     getInputFile();
56     
57     /**
58      * Set the destination directory for generated java files.
59      *
60      * @param destdir - The destination directory.
61      */

62     public void
63     setDestinationDirectory(String JavaDoc destdir);
64     
65     /**
66      * Get the destination directory for generated java files.
67      *
68      * @return The destination directory.
69      */

70     public String JavaDoc
71     getDestinationDirectory();
72     
73     /**
74      * Add a directory to the include list.
75      * (Preprocessor -I option)
76      *
77      * @param directory - The directory to add.
78      */

79     public void
80     addIncludeDirectory(String JavaDoc directory);
81
82     /**
83      * Get directories added to the include list.
84      * (Preprocessor -I option)
85      *
86      * @return The list of included directories.
87      */

88     public String JavaDoc[]
89     getIncludeDirectories();
90
91     /**
92      * Add a package mapping definition.
93      *
94      * @param idl_package - The idl package name.
95      * @param java_package - The java package name.
96      */

97     public void
98     addPackageMapping(String JavaDoc idl_package, String JavaDoc java_package);
99
100     /**
101      * Get package mapping definitions.
102      *
103      * @return The map of package mappings.
104      */

105     public Map JavaDoc
106     getPackageMappings();
107 }
Popular Tags