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 * @version $Id: MissingArgumentException.java 1443102 2013-02-06 18:12:16Z tn $
025 */
026public class MissingArgumentException extends ParseException
027{
028    /**
029     * This exception {@code serialVersionUID}.
030     */
031    private static final long serialVersionUID = -7098538588704965017L;
032
033    /** The option requiring additional arguments */
034    private Option option;
035
036    /**
037     * Construct a new <code>MissingArgumentException</code>
038     * with the specified detail message.
039     *
040     * @param message the detail message
041     */
042    public MissingArgumentException(String message)
043    {
044        super(message);
045    }
046
047    /**
048     * Construct a new <code>MissingArgumentException</code>
049     * with the specified detail message.
050     *
051     * @param option the option requiring an argument
052     * @since 1.2
053     */
054    public MissingArgumentException(Option option)
055    {
056        this("Missing argument for option: " + option.getKey());
057        this.option = option;
058    }
059
060    /**
061     * Return the option requiring an argument that wasn't provided
062     * on the command line.
063     *
064     * @return the related option
065     * @since 1.2
066     */
067    public Option getOption()
068    {
069        return option;
070    }
071}