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.constructs.blocking;
18  
19  
20  /**
21   * Creates objects to populate the cache.
22   * @version $Id: CacheEntryFactory.java 512 2007-07-10 09:18:45Z gregluck $
23   * @author Greg Luck
24   */
25  public interface CacheEntryFactory {
26      /**
27       * Creates the cacheEntry for the given cache key.
28       *
29       * ehcache requires cache entries to be serializable.
30       *
31       * Note that this method must be thread safe.
32       *
33       * @return The entry, or null if it does not exist.
34       * @throws Exception On failure creating the object.
35       */
36      Object createEntry(Object key) throws Exception;
37  }