Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.velocity.runtime.resource
Interface ResourceCache

All Known Implementing Classes:
  ResourceCacheImpl

public interface ResourceCache

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

Version:
  $Id: ResourceCache.java 463298 2006-10-12 16:10:32Z henning $
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

### initialize

    public void initialize(RuntimeServices rs)

  initializes the ResourceCache. Will be called before any utilization

  Parameters:
    `rs` - RuntimeServices to use for logging, etc

### 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

### 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
  Returns:
    stored under key

### enumerateKeys

    public Iterator enumerateKeys()

  returns an Iterator of Keys in the cache.

  Returns:
    An Iterator of Keys in the cache.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.