KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > cli > OptionGroup


1 /*
2  * $Header: /home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli/OptionGroup.java,v 1.2 2002/06/06 09:37:26 jstrachan Exp $
3  * $Revision: 1.2 $
4  * $Date: 2002/06/06 09:37:26 $
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 1999-2001 The Apache Software Foundation. All rights
11  * reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in
22  * the documentation and/or other materials provided with the
23  * distribution.
24  *
25  * 3. The end-user documentation included with the redistribution, if
26  * any, must include the following acknowlegement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowlegement may appear in the software itself,
30  * if and wherever such third-party acknowlegements normally appear.
31  *
32  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33  * Foundation" must not be used to endorse or promote products derived
34  * from this software without prior written permission. For written
35  * permission, please contact apache@apache.org.
36  *
37  * 5. Products derived from this software may not be called "Apache"
38  * nor may "Apache" appear in their names without prior written
39  * permission of the Apache Group.
40  *
41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This software consists of voluntary contributions made by many
56  * individuals on behalf of the Apache Software Foundation. For more
57  * information on the Apache Software Foundation, please see
58  * <http://www.apache.org/>.
59  *
60  */
61
62 package org.apache.commons.cli;
63
64 import java.util.Collection JavaDoc;
65 import java.util.HashMap JavaDoc;
66 import java.util.Iterator JavaDoc;
67
68 /**
69  * A group of mutually exclusive options.
70  * @author John Keyes ( john at integralsource.com )
71  * @version $Revision: 1.2 $
72  */
73 public class OptionGroup {
74
75     /** hold the options */
76     private HashMap JavaDoc optionMap = new HashMap JavaDoc();
77
78     /** the name of the selected option */
79     private String JavaDoc selected;
80
81     /** specified whether this group is required */
82     private boolean required;
83
84     /**
85      * add <code>opt</code> to this group
86      *
87      * @param opt the option to add to this group
88      * @return this option group with opt added
89      */
90     public OptionGroup addOption(Option opt) {
91         // key - option name
92 // value - the option
93 optionMap.put( "-" + opt.getOpt(), opt );
94         return this;
95     }
96
97     /**
98      * @return the names of the options in this group as a
99      * <code>Collection</code>
100      */
101     public Collection JavaDoc getNames() {
102         // the key set is the collection of names
103 return optionMap.keySet();
104     }
105
106     /**
107      * @return the options in this group as a <code>Collection</code>
108      */
109     public Collection JavaDoc getOptions() {
110         // the values are the collection of options
111 return optionMap.values();
112     }
113
114     /**
115      * set the selected option of this group to <code>name</code>.
116      * @param opt the option that is selected
117      * @throws AlreadySelectedException if an option from this group has
118      * already been selected.
119      */
120     public void setSelected(Option opt) throws AlreadySelectedException {
121         // if no option has already been selected or the
122 // same option is being reselected then set the
123 // selected member variable
124
125         if ( this.selected == null || this.selected.equals( opt.getOpt() ) ) {
126             this.selected = opt.getOpt();
127         }
128         else {
129             throw new AlreadySelectedException( "an option from this group has " +
130                                                 "already been selected: '" +
131                                                 selected + "'");
132         }
133     }
134
135     /**
136      * @return the selected option name
137      */
138     public String JavaDoc getSelected() {
139         return selected;
140     }
141
142     /**
143      * @param required specifies if this group is required
144      */
145     public void setRequired( boolean required ) {
146         this.required = required;
147     }
148
149     /**
150      * Returns whether this option group is required.
151      *
152      * @returns whether this option group is required
153      */
154     public boolean isRequired() {
155         return this.required;
156     }
157
158     /**
159      * <p>Returns the stringified version of this OptionGroup.</p>
160      * @return the stringified representation of this group
161      */
162     public String JavaDoc toString() {
163         StringBuffer JavaDoc buff = new StringBuffer JavaDoc();
164
165         Iterator JavaDoc iter = getOptions().iterator();
166
167         buff.append( "[" );
168         while( iter.hasNext() ) {
169             Option option = (Option)iter.next();
170
171             buff.append( "-" );
172             buff.append( option.getOpt() );
173             buff.append( " " );
174             buff.append( option.getDescription( ) );
175
176             if( iter.hasNext() ) {
177                 buff.append( ", " );
178             }
179         }
180         buff.append( "]" );
181
182         return buff.toString();
183     }
184 }
185
Popular Tags