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>LockingException</code> describes a problem that has arisen during
10: * an attempt to create or alter an <code>IEntityLock</code>. If the problem
11: * occurs in the lock store, the <code>LockingException</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 $
16: */
17: public class LockingException extends org.jasig.portal.PortalException {
18:
19: /**
20: * Instantiate a bare LockingException.
21: * Deprecated because it would be so much more helpful if you were to
22: * instead throw an exception that provides a message
23: * @deprecated use a more informative constructor
24: */
25: public LockingException() {
26: super ();
27: }
28:
29: /**
30: * Instantiate a LockingException with the given cause.
31: * @param cause Throwable that caused the locking problem
32: */
33: public LockingException(Throwable cause) {
34: super (cause);
35: }
36:
37: /**
38: * Instantiate a LockingException with the given message.
39: * @param msg message describing nature of locking problem
40: */
41: public LockingException(String msg) {
42: super (msg);
43: }
44:
45: /**
46: * Instantiate a LockingException with the given message
47: * and underlying cause.
48: * @param msg message describing nature of locking problem
49: * @param cause underlying cause
50: */
51: public LockingException(String msg, Throwable cause) {
52: super (msg, cause);
53: }
54:
55: /**
56: * This method always returns zero. It is deprecated and will presumably be
57: * removed in the future.
58: * @return 0
59: * @deprecated
60: */
61: public int getExceptionCode() {
62: return 0;
63: }
64: }
|