001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.commons.cli;
019
020/**
021 * Thrown when an option requiring an argument
022 * is not provided with an argument.
023 *
024 * @author John Keyes (john at integralsource.com)
025 * @version $Revision: 680644 $, $Date: 2008-07-29 01:13:48 -0700 (Tue, 29 Jul 2008) $
026 */
027public class MissingArgumentException extends ParseException
028{
029    /** The option requiring additional arguments */
030    private Option option;
031
032    /**
033     * Construct a new <code>MissingArgumentException</code>
034     * with the specified detail message.
035     *
036     * @param message the detail message
037     */
038    public MissingArgumentException(String message)
039    {
040        super(message);
041    }
042
043    /**
044     * Construct a new <code>MissingArgumentException</code>
045     * with the specified detail message.
046     *
047     * @param option the option requiring an argument
048     * @since 1.2
049     */
050    public MissingArgumentException(Option option)
051    {
052        this("Missing argument for option: " + option.getKey());
053        this.option = option;
054    }
055
056    /**
057     * Return the option requiring an argument that wasn't provided
058     * on the command line.
059     *
060     * @return the related option
061     * @since 1.2
062     */
063    public Option getOption()
064    {
065        return option;
066    }
067}