KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > cmdline > lib > DefaultOptionHelp


1 /*====================================================================
2
3 ObjectWeb Util CommandLine Package.
4 Copyright (C) 2003 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.lib;
28
29 /**
30  * This is a default implementation of the
31  * the command line help usage.
32  *
33  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
34  *
35  * @version 0.1
36  */
37
38 public class DefaultOptionHelp
39      extends DefaultOptionBase
40 {
41     // ==================================================================
42 //
43 // Internal state.
44 //
45 // ==================================================================
46
47     // ==================================================================
48 //
49 // Constructors.
50 //
51 // ==================================================================
52
53     /** The default constructor. */
54     public
55     DefaultOptionHelp()
56     {
57         super(new String JavaDoc[] { "-h", "--help"},
58               new String JavaDoc[0],
59               "Display this information and exit");
60     }
61
62     // ==================================================================
63 //
64 // Internal methods.
65 //
66 // ==================================================================
67
68     // ==================================================================
69 //
70 // Public methods for interface org.objectweb.util.cmdline.api.Option
71 //
72 // ==================================================================
73
74     /**
75      * Consumes command line arguments from an iterator.
76      *
77      * @param iterator The command line argument iterator.
78      *
79      * @return true if the option has consumed arguments.
80      */
81     public void
82     consume(org.objectweb.util.cmdline.api.Iterator iterator)
83     {
84         iterator.getCommandLine().print(
85             iterator.getCommandLine().getConsole().getOutputStream());
86         System.exit(0);
87     }
88
89     // ==================================================================
90 //
91 // Other public methods.
92 //
93 // ==================================================================
94 }
95
Popular Tags