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 */
017package Apache.CLI;
018
019/** Thrown during parsing signaling an unrecognized option. */
020@Torello.JavaDoc.JDHeaderBackgroundImg(EmbedTagFileID="LICENSE")
021public class UnrecognizedOptionException extends ParseException
022{
023    // This exception {@code serialVersionUID}.
024    private static final long serialVersionUID = 1;
025
026    // The unrecognized option.
027    private final String option;
028
029    /**
030     * Constructs a new {@code UnrecognizedArgumentException} with the specified detail message.
031     * @param message the detail message
032     */
033    public UnrecognizedOptionException(final String message)
034    { this(message, null); }
035
036    /**
037     * Constructs a new {@code UnrecognizedArgumentException} with the specified option and detail
038     * message.
039     *
040     * @param message the detail message
041     * @param option the unrecognized option
042     */
043    public UnrecognizedOptionException(final String message, final String option)
044    {
045        super(message);
046        this.option = option;
047    }
048
049    /**
050     * Gets the unrecognized option.
051     * @return the related option
052     */
053    public String getOption()
054    { return option; }
055}