KickJava   Java API By Example, From Geeks To Geeks.

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


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: PreprocessorOption.java,v 1.1 2004/02/05 20:29:57 rouvoy Exp $
27 ====================================================================*/
28
29 package org.objectweb.util.cpp.api;
30
31 import org.objectweb.util.cmdline.api.Option;
32
33 /**
34  * This provides a common interface for all Preprocessor Options.
35  *
36  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
37  * @version 0.1
38  */
39 public interface PreprocessorOption
40          extends Option,
41                  PreprocessorHolder
42 {
43     /**
44      * Gets the base option label.
45      *
46      * @return The base option label.
47      */
48     public String JavaDoc
49     getBaseOptionLabel();
50
51     /**
52      * Consumes the option value.
53      *
54      * @param current The option value.
55      */
56     public void
57     consumeOption(String JavaDoc current);
58 }
59
Popular Tags