01: package org.tanukisoftware.wrapper.event;
02:
03: /*
04: * Copyright (c) 1999, 2006 Tanuki Software Inc.
05: *
06: * Permission is hereby granted, free of charge, to any person
07: * obtaining a copy of the Java Service Wrapper and associated
08: * documentation files (the "Software"), to deal in the Software
09: * without restriction, including without limitation the rights
10: * to use, copy, modify, merge, publish, distribute, sub-license,
11: * and/or sell copies of the Software, and to permit persons to
12: * whom the Software is furnished to do so, subject to the
13: * following conditions:
14: *
15: * The above copyright notice and this permission notice shall be
16: * included in all copies or substantial portions of the Software.
17: *
18: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20: * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21: * NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22: * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23: * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25: * OTHER DEALINGS IN THE SOFTWARE.
26: */
27:
28: /**
29: * WrapperCoreEvents are used to notify the listener of the internal
30: * workings of the Wrapper.
31: *
32: * WARNING - Great care should be taken when receiving events of this type.
33: * They are sent from within the Wrapper's internal timing thread. If the
34: * listner takes too much time working with the event, Wrapper performance
35: * could be adversely affected. If unsure, it is recommended that events
36: * of this type not be included.
37: *
38: * @author Leif Mortenson <leif@tanukisoftware.com>
39: */
40: public abstract class WrapperCoreEvent extends WrapperEvent {
41: /*---------------------------------------------------------------
42: * Constructors
43: *-------------------------------------------------------------*/
44: /**
45: * Creates a new WrapperCoreEvent.
46: */
47: protected WrapperCoreEvent() {
48: }
49:
50: /*---------------------------------------------------------------
51: * WrapperCoreEvent Methods
52: *-------------------------------------------------------------*/
53: /**
54: * Returns a set of event flags for which the event should be fired.
55: * This value is compared with the mask supplied when when a
56: * WrapperEventListener is registered to decide which listeners should
57: * receive the event.
58: * <p>
59: * If a subclassed, the return value of the super class should usually
60: * be ORed with any additional flags.
61: *
62: * @return a set of event flags.
63: */
64: public long getFlags() {
65: return super.getFlags() | WrapperEventListener.EVENT_FLAG_CORE;
66: }
67: }
|