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    
018    package org.apache.commons.cli;
019    
020    /**
021     * Exception thrown during parsing signalling an unrecognized
022     * option was seen.
023     *
024     * @author bob mcwhiter (bob @ werken.com)
025     * @version $Revision: 680644 $, $Date: 2008-07-29 01:13:48 -0700 (Tue, 29 Jul 2008) $
026     */
027    public class UnrecognizedOptionException extends ParseException
028    {
029        /** The  unrecognized option */
030        private String option;
031    
032        /**
033         * Construct a new <code>UnrecognizedArgumentException</code>
034         * with the specified detail message.
035         *
036         * @param message the detail message
037         */
038        public UnrecognizedOptionException(String message)
039        {
040            super(message);
041        }
042    
043        /**
044         * Construct a new <code>UnrecognizedArgumentException</code>
045         * with the specified option and detail message.
046         *
047         * @param message the detail message
048         * @param option  the unrecognized option
049         * @since 1.2
050         */
051        public UnrecognizedOptionException(String message, String option)
052        {
053            this(message);
054            this.option = option;
055        }
056    
057        /**
058         * Returns the unrecognized option.
059         *
060         * @return the related option
061         * @since 1.2
062         */
063        public String getOption()
064        {
065            return option;
066        }
067    }