org.apache.velocity.runtime.resource

Interface ResourceCache

public interface ResourceCache

Interface that defines the shape of a pluggable resource cache for the included ResourceManager

Version: $Id: ResourceCache.java,v 1.1.8.1 2004/03/03 23:23:01 geirm Exp $

Author: Geir Magnusson Jr.

Method Summary
Iterator	enumerateKeys() returns an Iterator of Keys in the cache
Resource	get(Object resourceKey) retrieves a Resource from the cache
void	initialize(RuntimeServices rs) initializes the ResourceCache.
Resource	put(Object resourceKey, Resource resource) stores a Resource in the cache
Resource	remove(Object resourceKey) removes a Resource from the cache

Method Detail

enumerateKeys

public Iterator enumerateKeys()

returns an Iterator of Keys in the cache

get

public Resource get(Object resourceKey)

retrieves a Resource from the cache

Parameters: resourceKey key for Resource to be retrieved

Returns: Resource specified or null if not found

initialize

public void initialize(RuntimeServices rs)

initializes the ResourceCache. Will be called before any utilization

Parameters: rs RuntimeServices to use for logging, etc

put

public Resource put(Object resourceKey, Resource resource)

stores a Resource in the cache

Parameters: resourceKey key to associate with the Resource resource Resource to be stored

Returns: existing Resource stored under this key, or null if none

remove

public Resource remove(Object resourceKey)

removes a Resource from the cache

Parameters: resourceKey resource to be removed Resource stored under key

Copyright B) 2002 Apache Software Foundation. All Rights Reserved.