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.service.copal;
19  
20  import at.ac.tuwien.infosys.sm4all.copal.api.event.xml.XMLContextEventType;
21  
22  /**
23   * Interface to be implemented by observers which are interested on availability
24   * of {@link XMLContextEventType}s.
25   * 
26   * @author sanjin
27   */
28  public interface ContextEventTypeObserver {
29  
30      /**
31       * This method is called in two cases by {@link ContextEventTypeRegistry}:
32       * <ul>
33       * <li>if the observed {@link XMLContextEventType} is already registered
34       * when observer is attached to {@link ContextEventTypeRegistry}.</li>
35       * <li>if the observed {@link XMLContextEventType}, that was previously not
36       * registered with {@link ContextEventTypeRegistry}, is registered.</li>
37       * </ul>
38       * 
39       * @param eventType the registered {@link XMLContextEventType}.
40       */
41      void onRegister(XMLContextEventType eventType);
42  
43      /**
44       * This method is called in two cases by {@link ContextEventTypeRegistry}:
45       * <ul>
46       * <li>if the observed {@link XMLContextEventType} is registered when
47       * observer is detached from {@link ContextEventTypeRegistry}.</li>
48       * <li>if the observed {@link XMLContextEventType}, that was previously
49       * registered with {@link ContextEventTypeRegistry}, is unregistered.</li>
50       * </ul>
51       * 
52       * @param eventType the unregistered {@link XMLContextEventType}.
53       */
54      void onUnregister(XMLContextEventType eventType);
55  }