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.loader;
18
19 import net.sf.ehcache.Ehcache;
20
21 import java.util.Properties;
22
23 /***
24 * An abstract factory for creating cache loaders. Implementers should provide their own
25 * concrete factory extending this factory.
26 * <p/>
27 * Note that Ehcache API also allows the CacheLoader to be set programmatically.
28 * @author Greg Luck
29 * @version $Id: CacheLoaderFactory.html 13146 2011-08-01 17:12:39Z oletizi $
30 */
31 public abstract class CacheLoaderFactory {
32
33 /***
34 * Creates a CacheLoader using the Ehcache configuration mechanism at the time the associated cache
35 * is created.
36 * @param cache a reference to the owning cache
37 * @param properties implementation specific properties configured as delimiter
38 * separated name value pairs in ehcache.xml
39 * @return a constructed CacheLoader
40 */
41 public abstract CacheLoader createCacheLoader(Ehcache cache, Properties properties);
42
43 }