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