View Javadoc

1   /**
2    *  Copyright 2003-2007 Greg Luck
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  
17  package net.sf.ehcache.event;
18  
19  import java.util.Properties;
20  
21  /**
22   * An abstract factory for creating {@link CacheManagerEventListener}s. Implementers should
23   * provide their own concrete factory extending this factory. It can then be configured in
24   * ehcache.xml
25   *
26   * @author Greg Luck
27   * @version $Id: CacheManagerEventListenerFactory.java 512 2007-07-10 09:18:45Z gregluck $
28   * @see "http://ehcache.sourceforge.net/documentation/cachemanager_event_listeners.html"
29   */
30  public abstract class CacheManagerEventListenerFactory {
31  
32      /**
33       * Create a <code>CacheEventListener</code>
34       *
35       * @param properties implementation specific properties. These are configured as comma
36       *                   separated name value pairs in ehcache.xml. Properties may be null
37       * @return a constructed CacheManagerEventListener
38       */
39      public abstract CacheManagerEventListener
40              createCacheManagerEventListener(Properties properties);
41  }