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>This exception is the superclass of all other unchecked 59 * exceptions thrown in this package. It supports a nested "reason" 60 * throwable, i.e. an exception that caused this one to be thrown.</p> 61 * 62 * @author Rainer Klute (klute@rainer-klute.de) 63 * @version $Id: HPSFRuntimeException.java,v 1.6 2003/02/01 13:28:28 klute Exp $ 64 * @since 2002-02-09 65 */ 66 public class HPSFRuntimeException extends RuntimeException 67 { 68 69 private Throwable reason; 70 71 72 73 /** 74 * <p>Creates a new {@link HPSFRuntimeException}.</p> 75 */ 76 public HPSFRuntimeException() 77 { 78 super(); 79 } 80 81 82 83 /** 84 * <p>Creates a new {@link HPSFRuntimeException} with a message 85 * string.</p> 86 * 87 * @param msg The message string. 88 */ 89 public HPSFRuntimeException(final String msg) 90 { 91 super(msg); 92 } 93 94 95 96 /** 97 * <p>Creates a new {@link HPSFRuntimeException} with a 98 * reason.</p> 99 * 100 * @param reason The reason, i.e. a throwable that indirectly 101 * caused this exception. 102 */ 103 public HPSFRuntimeException(final Throwable reason) 104 { 105 super(); 106 this.reason = reason; 107 } 108 109 110 111 /** 112 * <p>Creates a new {@link HPSFRuntimeException} with a message 113 * string and a reason.</p> 114 * 115 * @param msg The message string. 116 * @param reason The reason, i.e. a throwable that indirectly 117 * caused this exception. 118 */ 119 public HPSFRuntimeException(final String msg, final Throwable reason) 120 { 121 super(msg); 122 this.reason = reason; 123 } 124 125 126 127 /** 128 * <p>Returns the {@link Throwable} that caused this exception to 129 * be thrown or <code>null</code> if there was no such {@link 130 * Throwable}.</p> 131 * 132 * @return The reason 133 */ 134 public Throwable getReason() 135 { 136 return reason; 137 } 138 139 } 140