com.tangosol.net.cache.CacheLoaderCacheStore Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
There is a newer version: 24.03
/*
 * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * http://oss.oracle.com/licenses/upl.
 */

package com.tangosol.net.cache;


import java.util.Collection;
import java.util.Iterator;
import java.util.Map;


/**
* A read-only CacheStore that wraps a CacheLoader.
*
* @author cp  2006.09.06
*
* @since Coherence 3.2
*/
public class CacheLoaderCacheStore
        extends AbstractCacheStore
    {
    // ----- factory methods ------------------------------------------------

    /**
    * Create a CacheStore wrapper for the passed CacheLoader. Note that the
    * returned CacheStore will implement the IterableCacheLoader interface if
    * and only if the passed CacheLoader implements it.
    *
    * @param      the key type
    * @param      the value type
    * @param loader  the CacheLoader to wrap
    *
    * @return a CacheStore
    */
    public static  CacheStore wrapCacheLoader(CacheLoader loader)
        {
        return loader instanceof CacheStore
                ? (CacheStore) loader
                : loader instanceof IterableCacheLoader
                        ? new Iterable<>((IterableCacheLoader) loader)
                        : new CacheLoaderCacheStore<>(loader);
        }


    // ----- constructors ---------------------------------------------------

    /**
    * The CacheLoader to delegate to.
    *
    * @param loader  the delegate CacheLoader
    */
    public CacheLoaderCacheStore(CacheLoader loader)
        {
        m_loader = loader;
        }


    // ----- CacheLoader interface ------------------------------------------

    /**
    * {@inheritDoc}
    */
    public V load(K key)
        {
        return m_loader.load(key);
        }

    /**
    * {@inheritDoc}
    */
    public Map loadAll(Collection colKeys)
        {
        return m_loader.loadAll(colKeys);
        }


    // ----- inner class: IterableCacheLoaderCacheStore ---------------------

    /**
    * An extension to the CacheLoaderCacheStore that implements the
    * IterableCacheLoader interface.
    *
    * @author cp  2006.09.06
    *
    * @since Coherence 3.2
    */
    public static class Iterable
            extends CacheLoaderCacheStore
            implements IterableCacheLoader
        {
        // ----- constructors -------------------------------------------

        /**
        * The CacheLoader to delegate to.
        *
        * @param loader  the delegate CacheLoader
        */
        public Iterable(IterableCacheLoader loader)
            {
            super(loader);
            }


        // ----- IterableCacheLoader interface --------------------------

        /**
        * {@inheritDoc}
        */
        public Iterator keys()
            {
            return ((IterableCacheLoader) m_loader).keys();
            }
        }

    // ----- data members ---------------------------------------------------

    /**
    * The CacheLoader to delegate to.
    */
    protected CacheLoader m_loader;
    }