    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        /***
    031         * Option code
    032         ***/
    033        private final int optionCode;
    034
    035        /***
    036         * Error message
    037         ***/
    038        private final String msg;
    039
    040        /***
    041         * Constructor for the exception.
    042         * <p>
    043         * @param message - Error message.
    044         * @param optcode - Option code.
    045         ***/
    046        public InvalidTelnetOptionException(String message, int optcode)
    047        {
    048            optionCode = optcode;
    049            msg = message;
    050        }
    051
    052        /***
    053         * Gets the error message of ths exception.
    054         * <p>
    055         * @return the error message.
    056         ***/
    057        @Override
    058        public String getMessage()
    059        {
    060            return (msg + ": " + optionCode);
    061        }
    062    }