KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > services > cache > total > TotalCacheDataLoader


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.total;
19
20 import java.util.Map JavaDoc;
21
22 import org.sape.carbon.core.component.FunctionalInterface;
23 import org.sape.carbon.services.cache.CacheLoadException;
24
25 /**
26  * <p>
27  * The TotalCacheDataLoader is the component FunctionalInterface of components
28  * that can load data for a cache.
29  * </p>
30  *
31  * Copyright 2002 Sapient
32  * @since carbon 1.0
33  * @author Douglas Voet, March 2002
34  * @version $Revision: 1.8 $($Author: dvoet $ / $Date: 2003/05/05 21:21:08 $)
35  */
36 public interface TotalCacheDataLoader extends FunctionalInterface {
37     /**
38      * <p>
39      * Loads all the data that should be stored within a cache and returns
40      * it as a Map.
41      * </p>
42      *
43      * @return Map data to be loaded into a cache
44      * @throws CacheLoadException when failed to load data
45      */
46     Map JavaDoc loadAllData() throws CacheLoadException;
47 }
48
Popular Tags