1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2000,2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: EventHandler.java,v 1.3 2003/08/17 01:32:22 tanderson Exp $
44 *
45 * Date Author Changes
46 * 07/27/00 jima Created
47 */
48
49 package org.exolab.jms.events;
50
51 import java.io.Serializable;
52
53 import org.exolab.core.foundation.HandleIfc;
54
55
56 /***
57 * This class defines an object that receives event notification from an
58 * {@link EventManager}. It also defines a method to return a
59 * <code>HandleIfc</code> to the event handler, making it possible to be
60 * resolved at some future time (i.e across EventManager invocations)
61 *
62 * @version $Revision: 1.3 $ $Date: 2003/08/17 01:32:22 $
63 * @author <a href="mailto:jima@intalio.com">Jim Alateras</a>
64 * @see EventManager
65 * @see Event
66 */
67 public interface EventHandler
68 extends Serializable {
69
70 /***
71 * Handle the specified event, generated by the {@link EventManager}.
72 * The event handler pressumably knows how to handle the callback object
73 * and should cast it appropriately before using it.
74 * <p>
75 * This methodshould not throw any exceptions
76 *
77 * @param event the event to handle
78 * @param callback the callback object
79 * @param time the absolute time, in ms, that the event
80 * fired.
81 */
82 void handleEvent(int event, Object callback, long time);
83
84 /***
85 * Return a handle to this event handler for the purpose of storing and
86 * restoring it. If you want event handlers to persist across subsequent
87 * invocations of the {@link EventManager} then you must support this
88 * method, otherwise this method can simply return null.
89 *
90 * @return HandleIfc return a reference to the handle.
91 */
92 HandleIfc getHandle();
93 }