View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.net.telnet;
19  
20  /***
21   * The InvalidTelnetOptionException is the exception that is
22   * thrown whenever a TelnetOptionHandler with an invlaid
23   * option code is registered in TelnetClient with addOptionHandler.
24   ***/
25  public class InvalidTelnetOptionException extends Exception
26  {
27  
28      private static final long serialVersionUID = -2516777155928793597L;
29  
30      /***
31       * Option code
32       ***/
33      private final int optionCode;
34  
35      /***
36       * Error message
37       ***/
38      private final String msg;
39  
40      /***
41       * Constructor for the exception.
42       * <p>
43       * @param message - Error message.
44       * @param optcode - Option code.
45       ***/
46      public InvalidTelnetOptionException(String message, int optcode)
47      {
48          optionCode = optcode;
49          msg = message;
50      }
51  
52      /***
53       * Gets the error message of ths exception.
54       * <p>
55       * @return the error message.
56       ***/
57      @Override
58      public String getMessage()
59      {
60          return (msg + ": " + optionCode);
61      }
62  }