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