00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_CACHE_LOADER_HPP 00008 #define COH_CACHE_LOADER_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/util/Collection.hpp" 00013 #include "coherence/util/Map.hpp" 00014 00015 COH_OPEN_NAMESPACE3(coherence,net,cache) 00016 00017 using coherence::util::Collection; 00018 using coherence::util::Map; 00019 00020 00021 /** 00022 * A cache loader. 00023 * 00024 * @author jh 2008.03.12 00025 */ 00026 class COH_EXPORT CacheLoader 00027 : public interface_spec<CacheLoader> 00028 { 00029 // ----- CacheLoader interface ------------------------------------------ 00030 00031 public: 00032 /** 00033 * Return the value associated with the specified key, or NULL if the 00034 * key does not have an associated value in the underlying store. 00035 * 00036 * @param vKey key whose associated value is to be returned 00037 * 00038 * @return the value associated with the specified key, or 00039 * <tt>NULL</tt> if no value is available for that key 00040 */ 00041 virtual Object::Holder load(Object::View vKey) = 0; 00042 00043 /** 00044 * Return the values associated with each the specified keys in the 00045 * passed collection. If a key does not have an associated value in 00046 * the underlying store, then the return map will not have an entry 00047 * for that key. 00048 * 00049 * @param vColKeys a collection of keys to load 00050 * 00051 * @return a Map of keys to associated values for the specified keys 00052 */ 00053 virtual Map::View loadAll(Collection::View vColKeys) = 0; 00054 }; 00055 00056 COH_CLOSE_NAMESPACE3 00057 00058 #endif // COH_CACHE_LOADER_HPP