View Javadoc

1   /*
2    * $Id: UserException.java 114 2004-10-22 19:27:43Z josem $
3    *
4    * Tarsis
5    * Copyright (C) 2002 Talika Open Source Group
6    *
7    * This program is free software; you can redistribute it and/or modify
8    * it under the terms of the GNU General Public License as published by
9    * the Free Software Foundation; either version 2 of the License, or
10   * (at your option) any later version.
11   *
12   * This program is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   * GNU General Public License for more details.
16   *
17   * You should have received a copy of the GNU General Public License
18   * along with this program; if not, write to the Free Software
19   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20   *
21   */
22  
23  package org.talika.tarsis.error;
24  
25  /**
26   * Thrown by the Tarsis MVC Framework to indicate a recoverable user error.
27   *
28   * @author  Jose M. Palomar
29   * @version $Revision: 114 $
30   */
31  public class UserException extends java.lang.Exception {
32  
33      // Fields
34      /**
35       * Root exception.
36       */
37      private Throwable rootCause;
38  
39      // Constructors
40      /**
41       * Constructs a new <code>UserException</code> with given message and
42       * cause.
43       *
44       * @param msg String text of the exception message.
45       */
46      public UserException(String msg) {
47          super(msg);
48      }
49  
50      /**
51       * Constructs a new <code>UserException</code> with given message and
52       * cause.
53       *
54       * @param msg String text of the exception message.
55       * @param rootCause Throwable the <code>Throwable</code> exception that caused
56       * this exception.
57       */
58      public UserException(String msg, Throwable rootCause) {
59          super(msg);
60          this.rootCause = rootCause;
61      }
62  
63      // Method
64      /**
65       * Returns root exception.
66       *
67       * @return Throwable root exception or <code>null</code> if none.
68       */
69      public final Throwable getRootCause() {
70          return rootCause;
71      }
72  
73  }