KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > config > ForcedChoiceOption


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2005 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.drjava.config;
35 import java.util.Collection JavaDoc;
36 import java.util.Iterator JavaDoc;
37
38
39 /**
40  * Class defining a configuration option that requires a choice between
41  * mutually-exclusive possible values. Values are stored as Strings, though
42  * this could be extended to any type with a fairly simple refactoring.
43  * @version $Id: ForcedChoiceOption.java 3553 2006-02-20 21:22:09Z rcartwright $
44  */
45 public class ForcedChoiceOption extends Option<String JavaDoc>
46 {
47   private Collection JavaDoc<String JavaDoc> _choices;
48
49   /**
50    * @param key The name of this option.
51    * @param def The default value of the option.
52    * @param choices A collection of all possible values of this Option, as Strings.
53    */
54   public ForcedChoiceOption(String JavaDoc key, String JavaDoc def, Collection JavaDoc<String JavaDoc> choices) {
55     super(key,def);
56     _choices = choices;
57   }
58
59   /**
60    * Checks whether the parameter String is a legal value for this option.
61    * The input String must be formatted exactly like the original, as defined
62    * by String.equals(String).
63    * @param s the value to check
64    * @return true if s is legal, false otherwise
65    */
66   public boolean isLegal(String JavaDoc s) {
67     return _choices.contains(s);
68   }
69
70   /**
71    * Gets all legal values of this option.
72    * @return an Iterator containing the set of all Strings for which isLegal returns true.
73    */
74   public Iterator JavaDoc<String JavaDoc> getLegalValues() {
75     return _choices.iterator();
76   }
77
78   /**
79    * Gets the number of legal values for this option.
80    * @return an int indicating the number of legal values.
81    */
82   public int getNumValues() {
83     return _choices.size();
84   }
85
86   /**
87    * Parses an arbitrary String into an acceptable value for this option.
88    * @param s The String to be parsed.
89    * @return s, if s is a legal value of this option.
90    * @exception IllegalArgumentException if "s" is not one of the allowed values.
91    */
92   public String JavaDoc parse(String JavaDoc s)
93   {
94     if (isLegal(s)) {
95       return s;
96     }
97     else {
98       throw new OptionParseException(name, s, "Value is not an acceptable choice for this option.");
99     }
100   }
101
102   /**
103    * @param s The String to be formatted.
104    * @return "s", no actual formatting is performed.
105    */
106   public String JavaDoc format(String JavaDoc s) {
107     return s;
108   }
109 }
110
Popular Tags