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 thrown whenever a TelnetOptionHandler with an invlaid option code is registered in TelnetClient
22 * with addOptionHandler.
23 */
24 public class InvalidTelnetOptionException extends Exception {
25
26 private static final long serialVersionUID = -2516777155928793597L;
27
28 /**
29 * Option code
30 */
31 private final int optionCode;
32
33 /**
34 * Error message
35 */
36 private final String msg;
37
38 /**
39 * Constructor for the exception.
40 *
41 * @param message - Error message.
42 * @param optcode - Option code.
43 */
44 public InvalidTelnetOptionException(final String message, final int optcode) {
45 optionCode = optcode;
46 msg = message;
47 }
48
49 /**
50 * Gets the error message of ths exception.
51 *
52 * @return the error message.
53 */
54 @Override
55 public String getMessage() {
56 return msg + ": " + optionCode;
57 }
58 }