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.codec;
19
20 /**
21 * Thrown when there is a failure condition during the encoding process. This exception is thrown when an
22 * {@link Encoder} encounters an encoding specific exception such as invalid data, inability to calculate a checksum,
23 * characters outside of the expected range.
24 */
25 public class EncoderException extends Exception {
26
27 /**
28 * Declares the Serial Version Uid.
29 *
30 * @see <a href="https://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always Declare Serial Version Uid</a>
31 */
32 private static final long serialVersionUID = 1L;
33
34 /**
35 * Constructs a new exception with {@code null} as its detail message. The cause is not initialized, and may
36 * subsequently be initialized by a call to {@link #initCause}.
37 *
38 * @since 1.4
39 */
40 public EncoderException() {
41 }
42
43 /**
44 * Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently
45 * be initialized by a call to {@link #initCause}.
46 *
47 * @param message
48 * a useful message relating to the encoder specific error.
49 */
50 public EncoderException(final String message) {
51 super(message);
52 }
53
54 /**
55 * Constructs a new exception with the specified detail message and cause.
56 *
57 * <p>
58 * Note that the detail message associated with {@code cause} is not automatically incorporated into this
59 * exception's detail message.
60 * </p>
61 *
62 * @param message
63 * The detail message which is saved for later retrieval by the {@link #getMessage()} method.
64 * @param cause
65 * The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
66 * value is permitted, and indicates that the cause is nonexistent or unknown.
67 * @since 1.4
68 */
69 public EncoderException(final String message, final Throwable cause) {
70 super(message, cause);
71 }
72
73 /**
74 * Constructs a new exception with the specified cause and a detail message of <code>(cause==null ?
75 * null : cause.toString())</code> (which typically contains the class and detail message of {@code cause}).
76 * This constructor is useful for exceptions that are little more than wrappers for other throwables.
77 *
78 * @param cause
79 * The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
80 * value is permitted, and indicates that the cause is nonexistent or unknown.
81 * @since 1.4
82 */
83 public EncoderException(final Throwable cause) {
84 super(cause);
85 }
86 }