DefaultListenerFactory


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: DefaultListenerFactory.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 class provides the default implementaion for a 
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 abstract class DefaultListenerFactory implements ListenerFactory {
35  
36      //private vars
37      protected String   id = null;
38  
39      /**
40       * Get an instance of the underlying BaseEventListener
41       *
42       * @return get an instance of the BaseEventListener
43       */
44      public abstract BaseEventListener getInstance();
45      
46      /**
47       * Return true if you want to always be notified, even when an event has 
48       * been handled by someone else. Return false (default) when you only want 
49       * to notified if the event hasn't been handled already. 
50       *
51       * Typically, only logging type listeners would return true.
52       *
53       * @return return true to be notified of the event even if it's already 
54       *        been handled
55       */
56      public boolean notifyAlways() {
57          return false;
58      }
59  
60      /**
61       * Get the Listener ID associated with this class of listener. This will
62       * generally either be the class name of the listener that the factory 
63       * creates
64       *
65       * @return the listener ID that describes this factory
66       */
67      public abstract String   getListenerID();
68  
69  
70      protected String   getID(Class   cl) {
71          return DefaultBaseEvent.getClassID(cl);
72      }
73  
74  }
75
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags