KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > cmdline > api > CommandLine


1 /*====================================================================
2
3 ObjectWeb Util CommandLine Package.
4 Copyright (C) 2002 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
27 package org.objectweb.util.cmdline.api;
28
29 /**
30  * This interface represents command lines.
31  *
32  * Command lines have an associated usage.
33  *
34  * This provides the following properties:
35  *
36  * - CheckingArguments: Flag to check or not arguments.
37  *
38  * - Options: The command line options.
39  *
40  * This provides the following methods:
41  *
42  * - addOption: Adds a command line option.
43  * - parse: Parses command line arguments.
44  *
45  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
46  *
47  * @version 0.1
48  */
49
50 public interface CommandLine
51          extends Usage,
52                  ConsoleHolder
53 {
54     /**
55      * Obtains the CheckingArguments flag.
56      *
57      * @return The CheckingArguments flag.
58      */
59     public boolean
60     isCheckingArguments();
61     
62     /**
63      * Sets the CheckingArguments flag.
64      *
65      * @param checkingArguments The CheckingArguments flag.
66      */
67     public void
68     setCheckingArguments(boolean checkingArguments);
69     
70     /**
71      * Gets the command line options.
72      *
73      * @return The command line options.
74      */
75     public Option[]
76     getOptions();
77
78     /**
79      * Adds a command line option.
80      *
81      * @param option The command line option object.
82      */
83     public void
84     addOption(Option option);
85
86     /**
87      * Parses given command line arguments and
88      * feeds the command line option objects.
89      *
90      * @param args The command line arguments.
91      *
92      * @return The command line arguments not parsed.
93      */
94     public String JavaDoc[]
95     parse(String JavaDoc[] args);
96 }
97
Popular Tags