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.net.telnet;
019    
020    /***
021     * The InvalidTelnetOptionException is the exception that is
022     * thrown whenever a TelnetOptionHandler with an invlaid
023     * option code is registered in TelnetClient with addOptionHandler.
024     * <p>
025     * @author Bruno D'Avanzo
026     ***/
027    public class InvalidTelnetOptionException extends Exception
028    {
029    
030        private static final long serialVersionUID = -2516777155928793597L;
031    
032        /***
033         * Option code
034         ***/
035        private final int optionCode;
036    
037        /***
038         * Error message
039         ***/
040        private final String msg;
041    
042        /***
043         * Constructor for the exception.
044         * <p>
045         * @param message - Error message.
046         * @param optcode - Option code.
047         ***/
048        public InvalidTelnetOptionException(String message, int optcode)
049        {
050            optionCode = optcode;
051            msg = message;
052        }
053    
054        /***
055         * Gets the error message of ths exception.
056         * <p>
057         * @return the error message.
058         ***/
059        @Override
060        public String getMessage()
061        {
062            return (msg + ": " + optionCode);
063        }
064    }