KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > barracuda > core > event > ListenerFactory


1 /*
2  * Copyright (C) 2003 Christian Cryder [christianc@granitepeaks.com]
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * $Id: ListenerFactory.java,v 1.5 2004/02/01 05:16:28 christianc Exp $
19  */
20 package org.enhydra.barracuda.core.event;
21
22 import java.io.*;
23 import java.util.*;
24
25 /**
26  * This interface defines the methods needed to be an
27  * ListenerFactory.
28  *
29  * Note that a factory is responsible for ensuring threadsafety
30  * within the underlying listener, so the factory should either
31  * return a new instance of the listener OR keep one static
32  * synchronized instance and return that instead.
33  */
34 public interface ListenerFactory {
35
36     /**
37      * Get an instance of the underlying BaseEventListener
38      *
39      * @return get an instance of the BaseEventListener
40      */
41     public BaseEventListener getInstance();
42     
43     /**
44      * Return true if you want to always be notified, even when an event has
45      * been handled by someone else. Return false (default) when you only want
46      * to notified if the event hasn't been handled already.
47      *
48      * Typically, only logging type listeners would return true.
49      *
50      * @return return true to be notified of the event even if it's already
51      * been handled
52      */
53     public boolean notifyAlways();
54
55     /**
56      * Get the Listener ID associated with this class of listener. This will
57      * generally either be the class name of the listener that the factory
58      * creates
59      *
60      * @return the listener ID that describes this factory
61      */
62     public String JavaDoc getListenerID();
63
64 }
65
Popular Tags