KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tanukisoftware > wrapper > event > WrapperCoreEvent


1 package org.tanukisoftware.wrapper.event;
2
3 /*
4  * Copyright (c) 1999, 2006 Tanuki Software Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person
7  * obtaining a copy of the Java Service Wrapper and associated
8  * documentation files (the "Software"), to deal in the Software
9  * 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
41     extends WrapperEvent
42 {
43     /*---------------------------------------------------------------
44      * Constructors
45      *-------------------------------------------------------------*/
46     /**
47      * Creates a new WrapperCoreEvent.
48      */
49     protected WrapperCoreEvent()
50     {
51     }
52     
53     /*---------------------------------------------------------------
54      * WrapperCoreEvent Methods
55      *-------------------------------------------------------------*/
56     /**
57      * Returns a set of event flags for which the event should be fired.
58      * This value is compared with the mask supplied when when a
59      * WrapperEventListener is registered to decide which listeners should
60      * receive the event.
61      * <p>
62      * If a subclassed, the return value of the super class should usually
63      * be ORed with any additional flags.
64      *
65      * @return a set of event flags.
66      */
67     public long getFlags()
68     {
69         return super.getFlags() | WrapperEventListener.EVENT_FLAG_CORE;
70     }
71 }
72
Popular Tags