1 /* 2 * ==================================================================== 3 * The Apache Software License, Version 1.1 4 * 5 * Copyright (c) 2000 The Apache Software Foundation. All rights 6 * reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 20 * 3. The end-user documentation included with the redistribution, 21 * if any, must include the following acknowledgment: 22 * "This product includes software developed by the 23 * Apache Software Foundation (http://www.apache.org/)." 24 * Alternately, this acknowledgment may appear in the software itself, 25 * if and wherever such third-party acknowledgments normally appear. 26 * 27 * 4. The names "Apache" and "Apache Software Foundation" must 28 * not be used to endorse or promote products derived from this 29 * software without prior written permission. For written 30 * permission, please contact apache@apache.org. 31 * 32 * 5. Products derived from this software may not be called "Apache", 33 * nor may "Apache" appear in their name, without prior written 34 * permission of the Apache Software Foundation. 35 * 36 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 37 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 38 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 39 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 43 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 44 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 45 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 46 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 47 * SUCH DAMAGE. 48 * ==================================================================== 49 * 50 * This software consists of voluntary contributions made by many 51 * individuals on behalf of the Apache Software Foundation. For more 52 * information on the Apache Software Foundation, please see 53 * <http://www.apache.org/>. 54 */ 55 package org.apache.poi.hpsf; 56 57 /** 58 * <p> 59 * 60 * This exception is the superclass of all other checked exceptions thrown in 61 * this package. It supports a nested "reason" throwable, i.e. an exception 62 * that caused this one to be thrown.</p> 63 * 64 *@author Rainer Klute (klute@rainer-klute.de) 65 *@created May 10, 2002 66 *@version $Id: HPSFException.java,v 1.4 2002/05/11 14:47:23 acoliver Exp $ 67 *@since 2002-02-09 68 */ 69 public class HPSFException extends Exception { 70 71 private Throwable reason; 72 73 74 75 /** 76 * <p> 77 * 78 * Creates a new {@link HPSFException}.</p> 79 */ 80 public HPSFException() { 81 super(); 82 } 83 84 85 86 /** 87 * <p> 88 * 89 * Creates a new {@link HPSFException} with a message string.</p> 90 * 91 *@param msg Description of the Parameter 92 */ 93 public HPSFException(final String msg) { 94 super(msg); 95 } 96 97 98 99 /** 100 * <p> 101 * 102 * Creates a new {@link HPSFException} with a reason.</p> 103 * 104 *@param reason Description of the Parameter 105 */ 106 public HPSFException(final Throwable reason) { 107 super(); 108 this.reason = reason; 109 } 110 111 112 113 /** 114 * <p> 115 * 116 * Creates a new {@link HPSFException} with a message string and a reason. 117 * </p> 118 * 119 *@param msg Description of the Parameter 120 *@param reason Description of the Parameter 121 */ 122 public HPSFException(final String msg, final Throwable reason) { 123 super(msg); 124 this.reason = reason; 125 } 126 127 128 129 /** 130 * <p> 131 * 132 * Returns the {@link Throwable} that caused this exception to be thrown or 133 * <code>null</code> if there was no such {@link Throwable}.</p> 134 * 135 *@return The reason value 136 */ 137 public Throwable getReason() { 138 return reason; 139 } 140 141 } 142