01: /*
02: * EventDeleter.java --
03: *
04: * Interface for deleting events in the notifier's event queue.
05: *
06: * Copyright (c) 1997 Sun Microsystems, Inc.
07: *
08: * See the file "license.terms" for information on usage and
09: * redistribution of this file, and for a DISCLAIMER OF ALL
10: * WARRANTIES.
11: *
12: * RCS: @(#) $Id: EventDeleter.java,v 1.1.1.1 1998/10/14 21:09:14 cvsadmin Exp $
13: *
14: */
15:
16: package tcl.lang;
17:
18: /*
19: * This is the interface for deleting events in the notifier's event
20: * queue. It's used together with the Notifier.deleteEvents() method.
21: *
22: */
23:
24: public interface EventDeleter {
25:
26: /*
27: *----------------------------------------------------------------------
28: *
29: * deleteEvent --
30: *
31: * This method is called once for each event in the event
32: * queue. It returns 1 for all events that should be deleted and
33: * 0 for events that should remain in the queue.
34: *
35: * If this method determines that an event should be removed, it
36: * should perform appropriate clean up on the event object.
37: *
38: * Results:
39: * 1 means evt should be removed from the event queue. 0
40: * otherwise.
41: *
42: * Side effects:
43: * After this method returns 1, the event will be removed from the
44: * event queue and will not be processed.
45: *
46: *----------------------------------------------------------------------
47: */
48:
49: public int deleteEvent(TclEvent evt); // Check whether this event should be removed.
50:
51: } // end EventDeleter
|