KickJava   Java API By Example, From Geeks To Geeks.

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


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 import java.util.EventObject JavaDoc;
29
30 import org.tanukisoftware.wrapper.WrapperManager;
31
32 /**
33  * WrapperEvents are used to notify WrapperEventListeners of various wrapper
34  * related events.
35  * <p>
36  * For performance reasons, some event instances may be reused by the code
37  * which fires them off. For this reason, references to the event should
38  * never be referenced outside the scope of the WrapperListener.processEvent
39  * method.
40  *
41  * @author Leif Mortenson <leif@tanukisoftware.com>
42  */
43 public abstract class WrapperEvent
44     extends EventObject JavaDoc
45 {
46     /*---------------------------------------------------------------
47      * Constructors
48      *-------------------------------------------------------------*/
49     /**
50      * Creates a new WrapperEvent.
51      */
52     protected WrapperEvent()
53     {
54         super( WrapperManager.class );
55     }
56     
57     /*---------------------------------------------------------------
58      * Methods
59      *-------------------------------------------------------------*/
60     /**
61      * Returns a set of event flags for which the event should be fired.
62      * This value is compared with the mask supplied when when a
63      * WrapperEventListener is registered to decide which listeners should
64      * receive the event.
65      * <p>
66      * If a subclassed, the return value of the super class should usually
67      * be ORed with any additional flags.
68      *
69      * @return a set of event flags.
70      */
71     public long getFlags()
72     {
73         return 0;
74     }
75 }
76
Popular Tags