View Javadoc

1   /* This file is part of COPAL (COntext Provisioning for All).
2    *
3    * COPAL is a part of SM4All (Smart hoMes for All) project.
4    *
5    * COPAL is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU Lesser General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * COPAL is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public License
16   * along with COPAL. If not, see <http://www.gnu.org/licenses/>.
17   */
18  package at.ac.tuwien.infosys.sm4all.copal.api.listener;
19  
20  import java.lang.annotation.ElementType;
21  import java.lang.annotation.Retention;
22  import java.lang.annotation.RetentionPolicy;
23  import java.lang.annotation.Target;
24  import at.ac.tuwien.infosys.sm4all.copal.api.event.ContextEvent;
25  
26  /**
27   * Specifies the type of {@link ContextEvent}s a method is invoked with.
28   * 
29   * @author sanjin
30   */
31  @Retention(RetentionPolicy.RUNTIME)
32  @Target(ElementType.METHOD)
33  public @interface OnEvent {
34  
35      /**
36       * The value of {@link #type()} if method wants to receive
37       * {@link ContextEvent}s of any type.
38       */
39      static final String ANY_TYPE = "";
40  
41      /**
42       * Returns the type of {@link ContextEvent}s.
43       * 
44       * @return the type of {@link ContextEvent}s.
45       */
46      String type() default ANY_TYPE;
47  }