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