Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
DecoderException |
|
| 1.0;1 |
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 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 | * @version $Id$ | |
25 | */ | |
26 | public class DecoderException extends Exception { | |
27 | ||
28 | /** | |
29 | * Declares the Serial Version Uid. | |
30 | * | |
31 | * @see <a href="http://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always Declare Serial Version Uid</a> | |
32 | */ | |
33 | private static final long serialVersionUID = 1L; | |
34 | ||
35 | /** | |
36 | * Constructs a new exception with {@code null} as its detail message. The cause is not initialized, and may | |
37 | * subsequently be initialized by a call to {@link #initCause}. | |
38 | * | |
39 | * @since 1.4 | |
40 | */ | |
41 | public DecoderException() { | |
42 | 1 | super(); |
43 | 1 | } |
44 | ||
45 | /** | |
46 | * Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently | |
47 | * be initialized by a call to {@link #initCause}. | |
48 | * | |
49 | * @param message | |
50 | * The detail message which is saved for later retrieval by the {@link #getMessage()} method. | |
51 | */ | |
52 | public DecoderException(String message) { | |
53 | 29 | super(message); |
54 | 29 | } |
55 | ||
56 | /** | |
57 | * Constructs a new exception with the specified detail message and cause. | |
58 | * <p> | |
59 | * Note that the detail message associated with <code>cause</code> is not automatically incorporated into this | |
60 | * exception's detail message. | |
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 DecoderException(String message, Throwable cause) { | |
70 | 7 | super(message, cause); |
71 | 7 | } |
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</code>). | |
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 DecoderException(Throwable cause) { | |
84 | 1 | super(cause); |
85 | 1 | } |
86 | } |