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 a Decoder has encountered a failure condition during a decode. 22 * 23 * @version $Id: DecoderException.java 797804 2009-07-25 17:27:04Z ggregory $ 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</code> 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(String message) { 52 super(message); 53 } 54 55 /** 56 * Constructsa new exception with the specified detail message and cause. 57 * 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 * </p> 62 * 63 * @param message 64 * The detail message which is saved for later retrieval by the {@link #getMessage()} method. 65 * @param cause 66 * The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code> 67 * value is permitted, and indicates that the cause is nonexistent or unknown. 68 * @since 1.4 69 */ 70 public DecoderException(String message, Throwable cause) { 71 super(message, cause); 72 } 73 74 /** 75 * Constructs a new exception with the specified cause and a detail message of <code>(cause==null ? 76 * null : cause.toString())</code> (which typically contains the class and detail message of <code>cause</code>). 77 * This constructor is useful for exceptions that are little more than wrappers for other throwables. 78 * 79 * @param cause 80 * The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code> 81 * value is permitted, and indicates that the cause is nonexistent or unknown. 82 * @since 1.4 83 */ 84 public DecoderException(Throwable cause) { 85 super(cause); 86 } 87 } 88
