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