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