com.sun.syndication.fetcher.impl.HashMapFeedInfoCache Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2004 Sun Microsystems, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package com.sun.syndication.fetcher.impl;

import java.io.Serializable;
import java.net.URL;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;


/**
 * A very simple implementation of the {@link com.sun.syndication.fetcher.impl.FeedFetcherCache} interface.
 * 
 * This implementation uses a HashMap to cache retrieved feeds. This implementation is
 * most suitible for sort term (client aggregator?) use, as the memory usage will increase
 * over time as the number of feeds in the cache increases.
 * 
 * @author Nick Lothian
 *
 */
public class HashMapFeedInfoCache implements FeedFetcherCache, Serializable {
	private static final long serialVersionUID = -1594665619950916222L;

	static HashMapFeedInfoCache _instance;
	
	private Map infoCache;
	
	/**
	 * Constructor for HashMapFeedInfoCache
	 * 
	 * Only use this if you want multiple instances of the cache. 
	 * Usually getInstance() is more appropriate.
	 *
	 */
	public HashMapFeedInfoCache() {
		setInfoCache(createInfoCache());
	}

	/**
	 * Get the global instance of the cache
	 * @return an implementation of FeedFetcherCache
	 */
	public static synchronized FeedFetcherCache getInstance() {
		if (_instance == null) {
			_instance = new HashMapFeedInfoCache();			
		}
		return _instance;
	}

	protected Map createInfoCache() {
 		return (Collections.synchronizedMap(new HashMap()));
 	}

	
	protected Object get(Object key) {
		return getInfoCache().get(key);
	}

	/**
	 * @see extensions.io.FeedFetcherCache#getFeedInfo(java.net.URL)
	 */
	public SyndFeedInfo getFeedInfo(URL feedUrl) {
		return (SyndFeedInfo) get(feedUrl.toString());
	}

	protected void put(Object key, Object value) {
		getInfoCache().put(key, value);
	}

	/**
	 * @see extensions.io.FeedFetcherCache#setFeedInfo(java.net.URL, extensions.io.SyndFeedInfo)
	 */
	public void setFeedInfo(URL feedUrl, SyndFeedInfo syndFeedInfo) {
		put(feedUrl.toString(), syndFeedInfo);		
	}

	protected synchronized final Map getInfoCache() {
		return infoCache;
	}

	/**
	 * The API of this class indicates that map must thread safe. In other
	 * words, be sure to wrap it in a synchronized map unless you know
	 * what you are doing.
	 * 
	 * @param map the map to use as the info cache.
	 */
	protected synchronized final void setInfoCache(Map map) {
		infoCache = map;
	}
	
	/**
	 * @see com.sun.syndication.fetcher.impl.FeedFetcherCache#clear()
	 */
	public void clear() {
		synchronized( infoCache ) {
			infoCache.clear();
		}
	}
	
	/**
	 * @see com.sun.syndication.fetcher.impl.FeedFetcherCache#remove(java.net.URL)
	 */
	public SyndFeedInfo remove( final URL url ) {
		if( url == null ) return null;
		
		return (SyndFeedInfo) infoCache.remove( url.toString() );
	}

}