com.randomcoder.download.cache
Class CachingPackageListProducer

java.lang.Object
  com.randomcoder.download.cache.CachingPackageListProducer

All Implemented Interfaces:

PackageListProducer

public class CachingPackageListProducer
extends Object
implements PackageListProducer

Package list producer which caches lookups to an underlying target.

 Copyright (c) 2007, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 

Constructor Summary

CachingPackageListProducer()

Method Summary

List<Package>	getPackages() Gets a list of packages, possibly from a cache.
void	refresh() Refreshes the cache with updated data
void	setCache(Cache cache) Sets the EHCache instance to use.
void	setCacheKey(String cacheKey) Sets the key to use for populating the cache.
void	setTarget(PackageListProducer target) Sets the target package list producer to execute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CachingPackageListProducer

public CachingPackageListProducer()

Method Detail

setCache

public void setCache(Cache cache)

Sets the EHCache instance to use.

Parameters:

cache - cache instance

setCacheKey

public void setCacheKey(String cacheKey)

Sets the key to use for populating the cache.

Parameters:

cacheKey - cache key

setTarget

public void setTarget(PackageListProducer target)

Sets the target package list producer to execute.

Parameters:

target - target package list producer

getPackages

public List<Package> getPackages()
                          throws PackageListException

Gets a list of packages, possibly from a cache.

Specified by:

getPackages in interface PackageListProducer

Returns:

list of packages

Throws:

PackageListException - if an error occurs

refresh

public void refresh()
             throws PackageListException

Refreshes the cache with updated data

Throws:

PackageListException - if an error occurs