KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > barracuda > core > event > InterruptDispatchException


1 /*
2  * Copyright (C) 2003 Christian Cryder [christianc@granitepeaks.com]
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * $Id: InterruptDispatchException.java,v 1.6 2004/02/01 05:16:28 christianc Exp $
19  */
20 package org.enhydra.barracuda.core.event;
21
22 /**
23  * This class defines a InterruptDispatchException...it is used to
24  * interrupt the dispatch, flag all events currently in the queue
25  * as handled, and then redispatch the new event
26  */
27 public class InterruptDispatchException extends EventException {
28     private BaseEvent newEvent = null;
29
30     /**
31      * The public contructor for InterruptDispatchException
32      *
33      * @param inewEvent the event we want to dispatch instead
34      */
35     public InterruptDispatchException (BaseEvent inewEvent) {
36         this(null, inewEvent);
37     }
38
39     /**
40      * The public contructor for InterruptDispatchException
41      *
42      * @param s a String describing the exception
43      * @param inewEvent the event we want to dispatch instead
44      */
45     public InterruptDispatchException (String JavaDoc s, BaseEvent inewEvent) {
46         this(s, inewEvent, null);
47     }
48
49     /**
50      * The public contructor for InterruptDispatchException
51      *
52      * @param s a String describing the exception
53      * @param inewEvent the event we want to dispatch instead
54      * @param ibaseException the root exception behind this error
55      */
56     public InterruptDispatchException (String JavaDoc s, BaseEvent inewEvent, Exception JavaDoc ibaseException) {
57         super(s, ibaseException);
58         newEvent = inewEvent;
59     }
60     
61     /**
62      * Get the new event that triggered this interrupt
63      *
64      * @return the event we wish to fire instead
65      */
66     public BaseEvent getNewEvent() {
67         return newEvent;
68     }
69 }
70
Popular Tags