KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > cpp > api > PreprocessorOperations


1 /*====================================================================
2
3 ObjectWeb Util Preprocessor Package.
4 Copyright (C) 2004 INRIA & USTL - LIFL - GOAL
5 Contact: architecture@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): Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 --------------------------------------------------------------------
26 $Id: PreprocessorOperations.java,v 1.1 2004/02/05 20:29:57 rouvoy Exp $
27 ====================================================================*/

28
29 package org.objectweb.util.cpp.api;
30
31 import java.io.File JavaDoc;
32 import java.io.OutputStream JavaDoc;
33
34 /**
35  * This defines a simple interface to interact with preprocessors.
36  *
37  * This provides two preprocess operations.
38  *
39  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
40  * @version 0.1
41  */

42 public interface PreprocessorOperations
43 {
44     /**
45      * Preprocesses a file.
46      *
47      * @param fileName The name of the file to preprocess.
48      *
49      * @return The file containing the output file.
50      */

51     public java.io.File JavaDoc
52     preprocess(String JavaDoc fileName);
53
54     /**
55      * Preprocesses a file.
56      *
57      * @param fileName The name of the file to preprocess.
58      * @param tmpFile The file containing the output file.
59      *
60      * @return True if OK.
61      */

62     public boolean
63     preprocess(String JavaDoc fileName,
64                File JavaDoc tmpFile);
65
66     /**
67      * Preprocesses a file.
68      *
69      * @param fileName The name of the file to preprocess.
70      * @param output The output stream.
71      */

72     public boolean
73     preprocess(String JavaDoc fileName,
74                OutputStream JavaDoc output);
75 }
76
Popular Tags