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.processor;
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 {@link ProcessorAction}.
28   * 
29   * @author sanjin
30   */
31  @Retention(RetentionPolicy.RUNTIME)
32  @Target(ElementType.METHOD)
33  public @interface Action {
34  
35      /**
36       * Returns the name of {@link ProcessorAction}.
37       * 
38       * @return the name of {@link ProcessorAction}.
39       */
40      String name();
41  
42      /**
43       * Returns the type of input {@link ContextEvent}s of
44       * {@link ProcessorAction}.
45       * 
46       * @return the type of input {@link ContextEvent}s of
47       *         {@link ProcessorAction}.
48       */
49      String input();
50  
51      /**
52       * Returns the types of output {@link ContextEvent}s of
53       * {@link ProcessorAction}.
54       * 
55       * @return the types of output {@link ContextEvent}s of
56       *         {@link ProcessorAction}.
57       */
58      String[] output() default {};
59  }