View Javadoc
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 an option requiring an argument is not provided with an argument.
22   */
23  public class MissingArgumentException extends ParseException {
24      /**
25       * This exception {@code serialVersionUID}.
26       */
27      private static final long serialVersionUID = -7098538588704965017L;
28  
29      /** The option requiring additional arguments */
30      private Option option;
31  
32      /**
33       * Construct a new {@code MissingArgumentException} with the specified detail message.
34       *
35       * @param option the option requiring an argument
36       * @since 1.2
37       */
38      public MissingArgumentException(final Option option) {
39          this("Missing argument for option: " + option.getKey());
40          this.option = option;
41      }
42  
43      /**
44       * Construct a new {@code MissingArgumentException} with the specified detail message.
45       *
46       * @param message the detail message
47       */
48      public MissingArgumentException(final String message) {
49          super(message);
50      }
51  
52      /**
53       * Return the option requiring an argument that wasn't provided on the command line.
54       *
55       * @return the related option
56       * @since 1.2
57       */
58      public Option getOption() {
59          return option;
60      }
61  }