01: /* Copyright 2002 The JA-SIG Collaborative. All rights reserved.
02: * See license distributed with this file and
03: * available online at http://www.uportal.org/license.html
04: */
05:
06: package org.jasig.portal.concurrency;
07:
08: /**
09: * A <code>CachingException</code> describes a problem that has arisen during
10: * an attempt to add, update, remove or reference a cache entry. If the problem
11: * arises in the store, the <code>CachingException</code> should wrap an
12: * <code>Exception</code> specific to the store, like a <code>java.sql.SQLException</code>.
13: *
14: * @author Dan Ellentuck
15: * @version $Revision: 35418 $ $Date: 2005-03-07 13:09:07 -0700 (Mon, 07 Mar 2005) $
16: */
17: public class CachingException extends org.jasig.portal.PortalException {
18:
19: /**
20: * Instantiate a bare CachingException.
21: * Deprecated because it would be so much more helpful if you were to
22: * instead use a contructor with a message.
23: * @deprecated use a more helpful constructor
24: */
25: public CachingException() {
26: super ();
27: }
28:
29: /**
30: * Instantiate a CachingException with the given cause.
31: * @param cause A throwable that caused the caching problem.
32: */
33: public CachingException(Throwable cause) {
34: super (cause);
35: }
36:
37: /**
38: * Instantiate a CachingException with the given message.
39: * @param msg message describing nature of caching problem.
40: */
41: public CachingException(String msg) {
42: super (msg);
43: }
44:
45: /**
46: * Instantiate a CachingException with the given message and underlying cause.
47: * @param msg message describing nature of caching problem.
48: * @param cause underlying cause.
49: */
50: public CachingException(String msg, Throwable cause) {
51: super (msg, cause);
52: }
53:
54: /**
55: * This method always returns zero. Presumably it is here because at one time
56: * PortalExceptions were to be identified by integer codes. In any case, this
57: * method does not correspond to any interface and is deprecated for future
58: * removal.
59: * @return 0
60: * @deprecated
61: */
62: public int getExceptionCode() {
63: return 0;
64: }
65: }
|