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   */
26  public class EncoderException 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 EncoderException() {
42          super();
43      }
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       *            a useful message relating to the encoder specific error.
51       */
52      public EncoderException(final String message) {
53          super(message);
54      }
55  
56      /**
57       * Constructs a new exception with the specified detail message and cause.
58       *
59       * <p>
60       * Note that the detail message associated with {@code cause} is not automatically incorporated into this
61       * exception's detail message.
62       * </p>
63       *
64       * @param message
65       *            The detail message which is saved for later retrieval by the {@link #getMessage()} method.
66       * @param cause
67       *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
68       *            value is permitted, and indicates that the cause is nonexistent or unknown.
69       * @since 1.4
70       */
71      public EncoderException(final String message, final Throwable cause) {
72          super(message, cause);
73      }
74  
75      /**
76       * Constructs a new exception with the specified cause and a detail message of <code>(cause==null ?
77       * null : cause.toString())</code> (which typically contains the class and detail message of {@code cause}).
78       * This constructor is useful for exceptions that are little more than wrappers for other throwables.
79       *
80       * @param cause
81       *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
82       *            value is permitted, and indicates that the cause is nonexistent or unknown.
83       * @since 1.4
84       */
85      public EncoderException(final Throwable cause) {
86          super(cause);
87      }
88  }