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 during parsing signaling an unrecognized option.
22 */
23 public class UnrecognizedOptionException extends ParseException {
24
25 /**
26 * This exception {@code serialVersionUID}.
27 */
28 private static final long serialVersionUID = -252504690284625623L;
29
30 /** The unrecognized option. */
31 private final String option;
32
33 /**
34 * Constructs a new {@code UnrecognizedArgumentException} with the specified detail message.
35 *
36 * @param message the detail message
37 */
38 public UnrecognizedOptionException(final String message) {
39 this(message, null);
40 }
41
42 /**
43 * Constructs a new {@code UnrecognizedArgumentException} with the specified option and detail message.
44 *
45 * @param message the detail message
46 * @param option the unrecognized option
47 * @since 1.2
48 */
49 public UnrecognizedOptionException(final String message, final String option) {
50 super(message);
51 this.option = option;
52 }
53
54 /**
55 * Gets the unrecognized option.
56 *
57 * @return the related option
58 * @since 1.2
59 */
60 public String getOption() {
61 return option;
62 }
63 }