KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.sape.carbon.services.cache.total.TotalCacheDataLoader;
25
26 /**
27  * <p>
28  * The ConfigurableMapTypeCacheDataLoader is the component FunctionalInterface
29  * of components that can load data for a cache and also provide a mechanism
30  * to configure the map implementation to be stored in cache.
31  * </p>
32  *
33  * Copyright 2003 Sapient
34  * @since carbon 2.1
35  * @author Akash Tayal, May 2003
36  * @version $Revision: 1.1 $($Author: ghinkl $ / $Date: 2003/09/30 02:37:19 $)
37  */

38 public interface ConfigurableMapTypeCacheDataLoader extends TotalCacheDataLoader {
39     /**
40      * <p>
41      * Returns implementation of map for storing in the cache.
42      * This implementation should return a blank and new instance
43      * and does not need to be synchronized. The synchronization is
44      * taken care in <code>WritableCache</code>
45      * </p>
46      *
47      * @return Map implementation to be loaded into a cache
48      */

49     Map JavaDoc getMapInstance();
50 }
51
Popular Tags