KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > services > cache > mru > MRUCacheDataLoader


1 /*
2  * The contents of this file are subject to the Sapient Public License
3  * Version 1.0 (the "License"); you may not use this file except in compliance
4  * with the License. You may obtain a copy of the License at
5  * http://carbon.sf.net/License.html.
6  *
7  * Software distributed under the License is distributed on an "AS IS" basis,
8  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9  * the specific language governing rights and limitations under the License.
10  *
11  * The Original Code is The Carbon Component Framework.
12  *
13  * The Initial Developer of the Original Code is Sapient Corporation
14  *
15  * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16  */

17
18 package org.sape.carbon.services.cache.mru;
19
20 import org.sape.carbon.core.component.FunctionalInterface;
21 import org.sape.carbon.services.cache.CacheLoadException;
22
23 /**
24  * <p>The MRUCacheDataLoader is the interface implemented by Objects that
25  * interface with the backing data store of an MRU cache.</p>
26  *
27  * Copyright 2002 Sapient
28  * @since carbon 1.0
29  * @author Douglas Voet, March 2002
30  * @version $Revision: 1.7 $($Author: dvoet $ / $Date: 2003/05/05 21:21:07 $)
31  */

32 public interface MRUCacheDataLoader extends FunctionalInterface {
33
34
35     /**
36      * Loads a single datum from the backing data store and returns it.
37      * This method is called from the get method of MRUCache when the
38      * requested datum is not in the cache or has expired.
39      *
40      * @param key an object providing all information necessary
41      * to locate a datum
42      * @return the data object represented by the key parameter
43      * @throws CacheLoadException indicates an error loading the data
44      */

45     Object JavaDoc loadDatum(Object JavaDoc key) throws CacheLoadException;
46
47 }
48
49
Popular Tags