1 /*
2 Licensed to the Apache Software Foundation (ASF) under one or more
3 contributor license agreements. See the NOTICE file distributed with
4 this work for additional information regarding copyright ownership.
5 The ASF licenses this file to You under the Apache License, Version 2.0
6 (the "License"); you may not use this file except in compliance with
7 the License. You may obtain a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16 */
17
18 package org.apache.commons.cli;
19
20 import java.io.Serializable;
21 import java.util.Collection;
22 import java.util.Iterator;
23 import java.util.LinkedHashMap;
24 import java.util.Map;
25
26 /**
27 * A group of mutually exclusive options.
28 */
29 public class OptionGroup implements Serializable {
30
31 /** The serial version UID. */
32 private static final long serialVersionUID = 1L;
33
34 /** Hold the options */
35 private final Map<String, Option> optionMap = new LinkedHashMap<>();
36
37 /** The name of the selected option */
38 private String selected;
39
40 /** Specified whether this group is required */
41 private boolean required;
42
43 /**
44 * Adds the given {@code Option} to this group.
45 *
46 * @param option the option to add to this group
47 * @return this option group with the option added
48 */
49 public OptionGroup addOption(final Option option) {
50 // key - option name
51 // value - the option
52 optionMap.put(option.getKey(), option);
53 return this;
54 }
55
56 /**
57 * Gets the names of the options in this group as a {@code Collection}.
58 *
59 * @return the names of the options in this group as a {@code Collection}.
60 */
61 public Collection<String> getNames() {
62 // the key set is the collection of names
63 return optionMap.keySet();
64 }
65
66 /**
67 * Gets the options in this group as a {@code Collection}.
68 *
69 * @return the options in this group as a {@code Collection}.
70 */
71 public Collection<Option> getOptions() {
72 // the values are the collection of options
73 return optionMap.values();
74 }
75
76 /**
77 * Gets the selected option name.
78 *
79 * If the selected option is deprecated <em>no warning is logged</em>.
80 * @return the selected option name.
81 */
82 public String getSelected() {
83 return selected;
84 }
85
86 /**
87 * Tests whether this option group is required.
88 *
89 * @return whether this option group is required
90 */
91 public boolean isRequired() {
92 return required;
93 }
94
95 /**
96 * Tests whether an option is selected.
97 *
98 * If an option is selected and is deprecated <em>no warning is logged</em>.
99 * @return whether whether an option is selected.
100 * @since 1.9.0
101 */
102 public boolean isSelected() {
103 return selected != null;
104 }
105
106 /**
107 * Sets whether this group is required.
108 *
109 * @param required whether this group is required.
110 */
111 public void setRequired(final boolean required) {
112 this.required = required;
113 }
114
115 /**
116 * Sets the selected option of this group to {@code name}.
117 *
118 * If the selected option is deprecated <em>no warning is logged</em>.
119 * @param option the option that is selected
120 * @throws AlreadySelectedException if an option from this group has already been selected.
121 */
122 public void setSelected(final Option option) throws AlreadySelectedException {
123 if (option == null) {
124 // reset the option previously selected
125 selected = null;
126 return;
127 }
128 // if no option has already been selected or the
129 // same option is being reselected then set the
130 // selected member variable
131 if (selected != null && !selected.equals(option.getKey())) {
132 throw new AlreadySelectedException(this, option);
133 }
134 selected = option.getKey();
135 }
136
137 /**
138 * Returns the stringified version of this OptionGroup.
139 *
140 * @return the stringified representation of this group
141 */
142 @Override
143 public String toString() {
144 final StringBuilder buff = new StringBuilder();
145 final Iterator<Option> iter = getOptions().iterator();
146 buff.append("[");
147 while (iter.hasNext()) {
148 final Option option = iter.next();
149 if (option.getOpt() != null) {
150 buff.append("-");
151 buff.append(option.getOpt());
152 } else {
153 buff.append("--");
154 buff.append(option.getLongOpt());
155 }
156
157 if (option.getDescription() != null) {
158 buff.append(Char.SP);
159 buff.append(option.getDescription());
160 }
161
162 if (iter.hasNext()) {
163 buff.append(", ");
164 }
165 }
166 buff.append("]");
167 return buff.toString();
168 }
169 }