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   
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.3 2002/05/01 09:31:52 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       public HPSFRuntimeException(final String msg)
88       {
89           super(msg);
90       }
91   
92   
93   
94       /**
95        * <p>Creates a new {@link HPSFRuntimeException} with a reason.</p>
96        */
97       public HPSFRuntimeException(final Throwable reason)
98       {
99           super();
100          this.reason = reason;
101      }
102  
103  
104  
105      /**
106       * <p>Creates a new {@link HPSFRuntimeException} with a message string
107       * and a reason.</p>
108       */
109      public HPSFRuntimeException(final String msg, final Throwable reason)
110      {
111          super(msg);
112          this.reason = reason;
113      }
114  
115  
116  
117      /**
118       * <p>Returns the {@link Throwable} that caused this exception to
119       * be thrown or <code>null</code> if there was no such {@link
120       * Throwable}.</p>
121       */
122      public Throwable getReason()
123      {
124          return reason;
125      }
126  
127  }
128