C++ Client API Reference for Oracle Coherence: coherence/net/cache/IterableCacheLoader.hpp Source File

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_ITERABLE_CACHE_LOADER_HPP
00008 #define COH_ITERABLE_CACHE_LOADER_HPP
00009 
00010 #include "coherence/lang.ns"
00011 #include "coherence/net/cache/CacheLoader.hpp"
00012 #include "coherence/util/Iterator.hpp"
00013 
00014 
00015 COH_OPEN_NAMESPACE3(coherence,net,cache)
00016 
00017 using coherence::util::Iterator;
00018 
00019 /**
00020 * A CacheLoader that can iterate its underlying contents.
00021 *
00022 * @author nsa 2008.07.01
00023 */
00024 class COH_EXPORT IterableCacheLoader
00025     : public interface_spec<IterableCacheLoader,
00026         implements<CacheLoader> >
00027     {
00028     // ----- IterableCacheLoader interface ----------------------------------
00029 
00030     public:
00031         /**
00032         * Iterate all keys in the underlying store.
00033         *
00034         * @return a read-only iterator of the keys in the underlying store
00035         *
00036         * @throws UnsupportedOperationException  if the underlying store is
00037         *         not iterable
00038         */
00039         virtual Iterator::Handle keys() = 0;
00040     };
00041 
00042 
00043 COH_CLOSE_NAMESPACE3
00044 
00045 
00046 #endif // #ifndef COH_ITERABLE_CACHE_LOADER_HPP