View Javadoc

1   /***
2    *  Copyright 2003-2010 Terracotta, Inc.
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.extension;
18  
19  import net.sf.ehcache.Ehcache;
20  
21  import java.util.Properties;
22  
23  /***
24   * An abstract factory for creating <code>CacheExtension</code>s. Implementers should provide their own
25   * concrete factory extending this factory. It can then be configured in ehcache.xml.
26   *
27   * @author <a href="mailto:gluck@gregluck.com">Greg Luck</a>
28   * @version $Id: CacheExtensionFactory.html 13146 2011-08-01 17:12:39Z oletizi $
29   */
30  public abstract class CacheExtensionFactory {
31  
32      /***
33       * @param cache the cache this extension should hold a reference to, and to whose lifecycle it should be bound.
34       * @param properties implementation specific properties configured as delimiter separated name value pairs in ehcache.xml
35       */
36      public abstract CacheExtension createCacheExtension(Ehcache cache, Properties properties); 
37  
38  }