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.jcache;
18  
19  import net.sf.jsr107cache.CacheLoader;
20  
21  import java.util.Map;
22  
23  /**
24   * An abstract factory for creating cache loaders. Implementers should provide their own
25   * concrete factory extending this factory.
26   * <p/>
27   * This enables plugins to be written.
28   * <p/>
29   * Note that JCache also allows the CacheLoader to be set after creation programmatically.
30   * @author Greg Luck
31   * @version $Id: CacheLoaderFactory.java 512 2007-07-10 09:18:45Z gregluck $
32   */
33  public abstract class CacheLoaderFactory {
34  
35      /**
36       * Creates a CacheLoader. This method is called from {@link JCacheFactory}
37       * @param environment the same environment passed into {@link JCacheFactory}. This factory can
38       * extract any properties it needs from the environment. 
39       * @return a constructed CacheLoader
40       */
41      public abstract CacheLoader createCacheLoader(Map environment);
42  
43  
44  
45  }