/hudson-utils/src/main/java/org/hudsonci/utils/event/EventHandler.java

 1/**
 2 * The MIT License
 3 *
 4 * Copyright (c) 2010-2011 Sonatype, Inc. All rights reserved.
 5 *
 6 * Permission is hereby granted, free of charge, to any person obtaining a copy
 7 * of this software and associated documentation files (the "Software"), to deal
 8 * in the Software without restriction, including without limitation the rights
 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24
25package org.hudsonci.utils.event;
26
27/**
28 * Abstraction to allow event handling logic to be componentized.
29 *
30 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
31 * @since 2.1.0
32 */
33public interface EventHandler<ContextType, EventType>
34{
35    /**
36     * Called to initialize the handler w/context.
37     */
38    void init(ContextType context);
39
40    /**
41     * Returns true if this handler can consume the given event.
42     */
43    boolean accept(Object event);
44
45    /**
46     * Handles the given event.
47     */
48    void handle(EventType event) throws Exception;
49}