KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > misc > api > ExceptionWrapper


1 /*====================================================================
2
3 ObjectWeb Util Package.
4 Copyright (C) 2004 INRIA & USTL - LIFL - GOAL
5 Contact: architecture@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library 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 GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 --------------------------------------------------------------------
26 $Id: ExceptionWrapper.java,v 1.1 2004/02/13 17:46:08 rouvoy Exp $
27 ====================================================================*/

28
29 package org.objectweb.util.misc.api;
30
31 /**
32  * This class encapsulates any Java Exception object allowing us
33  * to avoid to throw them in every operation signatures.
34  *
35  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
36  * @version 0.1
37  */

38 public class ExceptionWrapper
39      extends java.lang.RuntimeException JavaDoc
40   implements ExceptionHolder
41 {
42     // ==================================================================
43
//
44
// Internal state.
45
//
46
// ==================================================================
47

48     /** To store the wrapped Java Exception object. */
49     private Exception JavaDoc exception_ = null;
50
51     // ==================================================================
52
//
53
// Constructors.
54
//
55
// ==================================================================
56

57     /** The default constructor. */
58     public ExceptionWrapper() {
59         this(null, "");
60     }
61
62     /**
63      * The constructor with the wrapped Java Exception object.
64      *
65      * @param exception The wrapped Java Exception object.
66      */

67     public ExceptionWrapper(Exception JavaDoc exception) {
68         this(exception, "");
69     }
70
71     /**
72      * The constructor with the wrapped Java Exception object
73      * and an associated message.
74      *
75      * @param exception The wrapped Java Exception object.
76      * @param message The message describing the exception.
77      */

78     public ExceptionWrapper(Exception JavaDoc exception, String JavaDoc message) {
79         // Calls the java.lang.Error constructor.
80
super(message);
81
82         // Inits internal state.
83
exception_ = exception;
84     }
85
86     // ==================================================================
87
//
88
// Internal methods.
89
//
90
// ==================================================================
91

92     // ==================================================================
93
//
94
// Public methods for org.objectweb.util.api.ExceptionHolder.
95
//
96
// ==================================================================
97

98     /**
99      * Obtains the wrapped Java Exception object.
100      *
101      * @return The wrapped Java Exception object.
102      */

103     public Exception JavaDoc getException() {
104         return exception_;
105     }
106
107     /**
108      * Sets the wrapped Java Exception object.
109      *
110      * @param exception The wrapped Java Exception object.
111      */

112     public void setException(Exception JavaDoc exception) {
113         exception_ = exception;
114     }
115
116     // ==================================================================
117
//
118
// Other public methods.
119
//
120
// ==================================================================
121
}
122
Popular Tags