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