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 /**
21 * Thrown when more than one option in an option group has been provided.
22 */
23 public class AlreadySelectedException extends ParseException {
24
25 /**
26 * This exception {@code serialVersionUID}.
27 */
28 private static final long serialVersionUID = 3674381532418544760L;
29
30 /** The option group selected. */
31 private final OptionGroup group;
32
33 /** The option that triggered the exception. */
34 private final Option option;
35
36 /**
37 * Constructs a new {@code AlreadySelectedException} for the specified option group.
38 *
39 * @param group the option group already selected
40 * @param option the option that triggered the exception
41 * @since 1.2
42 */
43 public AlreadySelectedException(final OptionGroup group, final Option option) {
44 this(String.format("The option '%s' was specified but an option from this group has already been selected: '%s'", option.getKey(), group.getSelected()),
45 group, option);
46 }
47
48 /**
49 * Constructs a new {@code AlreadySelectedException} with the specified detail message.
50 *
51 * @param message the detail message
52 */
53 public AlreadySelectedException(final String message) {
54 this(message, null, null);
55 }
56
57 private AlreadySelectedException(final String message, final OptionGroup group, final Option option) {
58 super(message);
59 this.group = group;
60 this.option = option;
61 }
62
63 /**
64 * Gets the option that was added to the group and triggered the exception.
65 *
66 * @return the related option
67 * @since 1.2
68 */
69 public Option getOption() {
70 return option;
71 }
72
73 /**
74 * Gets the option group where another option has been selected.
75 *
76 * @return the related option group
77 * @since 1.2
78 */
79 public OptionGroup getOptionGroup() {
80 return group;
81 }
82 }