org.xwiki.cache.internal.DefaultCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-cache-api Show documentation
XWiki Commons - Cache - API
The newest version!
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.cache.internal;

import org.xwiki.cache.Cache;
import org.xwiki.cache.event.CacheEntryListener;

/**
 * Default implementation of {@link Cache}. Does not really store anything and always return null when trying to get a
 * value associated with a key.
 * 
 * @param  the type of data stored in the cache
 * @version $Id: 4635c0c6452b023810661c8077dc0fdfff00b437 $
 */
public class DefaultCache implements Cache
{
    @Override
    public void remove(String key)
    {
        // Not a real cache, nothing to do here
    }

    @Override
    public void set(String key, T obj)
    {
        // Not a real cache, nothing to do here
    }

    @Override
    public T get(String key)
    {
        // Not a real cache, nothing was stored
        return null;
    }

    @Override
    public void removeAll()
    {
        // Not a real cache, nothing to do here
    }

    @Override
    public void addCacheEntryListener(CacheEntryListener listener)
    {
        // Since this is not a real cache, there will be no events to send, so there's no need to remember listeners
    }

    @Override
    public void removeCacheEntryListener(CacheEntryListener listener)
    {
        // Since this is not a real cache, there will be no events to send, so there's no need to remember listeners
    }

    @Override
    public void dispose()
    {
        // Not a real cache, no resources to free
    }
}