KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > controls > api > events > EventHandler


1 package org.apache.beehive.controls.api.events;
2 /*
3  * Copyright 2004 The Apache Software Foundation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * $Header:$
18  */

19
20 import java.lang.annotation.ElementType JavaDoc;
21 import java.lang.annotation.Retention JavaDoc;
22 import java.lang.annotation.RetentionPolicy JavaDoc;
23 import java.lang.annotation.Target JavaDoc;
24
25 /**
26  * The EventHandler annotation type is used to mark a method that provides the event handler
27  * implementation for a Control event.
28  */

29 @Retention JavaDoc(RetentionPolicy.RUNTIME)
30 @Target JavaDoc({ElementType.METHOD})
31 public @interface EventHandler
32 {
33     /**
34      * The field name of the Java control event source. This must be an @Control field declared
35      * on the class defining the event handler method (or on a superclass if the field is not
36      * declared to be private).
37      */

38     String JavaDoc field();
39
40     /**
41      * The EventSet interface that declares the event. This must be a valid EventSet interface
42      * associated with the control type of the <code>field</code> member.
43      */

44     Class JavaDoc eventSet();
45
46     /**
47      * The name of the handled event. This must be the name of a method declared on the EventSet
48      * interface referenced by the <code>eventSet</code> member. The annotated method must have
49      * an event signature that <b>exactly</b> matches one of the event methods with this name.
50      */

51     String JavaDoc eventName();
52 }
53
Popular Tags