    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 is not provided with an argument.
    022 */
    023public class MissingArgumentException extends ParseException {
    024    /**
    025     * This exception {@code serialVersionUID}.
    026     */
    027    private static final long serialVersionUID = -7098538588704965017L;
    028
    029    /** The option requiring additional arguments */
    030    private Option option;
    031
    032    /**
    033     * Constructs a new {@code MissingArgumentException} with the specified detail message.
    034     *
    035     * @param option the option requiring an argument
    036     * @since 1.2
    037     */
    038    public MissingArgumentException(final Option option) {
    039        this("Missing argument for option: " + option.getKey());
    040        this.option = option;
    041    }
    042
    043    /**
    044     * Constructs a new {@code MissingArgumentException} with the specified detail message.
    045     *
    046     * @param message the detail message
    047     */
    048    public MissingArgumentException(final String message) {
    049        super(message);
    050    }
    051
    052    /**
    053     * Gets the option requiring an argument that wasn't provided on the command line.
    054     *
    055     * @return the related option
    056     * @since 1.2
    057     */
    058    public Option getOption() {
    059        return option;
    060    }
    061}