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