org.apache.velocity.runtime.resource

Interface ResourceManager

public interface ResourceManager

Class to manage the text resource for the Velocity Runtime.

Version: $Id: ResourceManager.java,v 1.34.4.1 2004/03/03 23:23:01 geirm Exp $

Author: Jason van Zyl Paulo Gaspar Geir Magnusson Jr.

Field Summary
static intRESOURCE_CONTENT
A static content resource.
static intRESOURCE_TEMPLATE
A template resources.
Method Summary
StringgetLoaderNameForResource(String resourceName)
Determines is a template exists, and returns name of the loader that provides it.
ResourcegetResource(String resourceName, int resourceType, String encoding)
Gets the named resource.
voidinitialize(RuntimeServices rs)
Initialize the ResourceManager.

Field Detail

RESOURCE_CONTENT

public static final int RESOURCE_CONTENT
A static content resource.

RESOURCE_TEMPLATE

public static final int RESOURCE_TEMPLATE
A template resources.

Method Detail

getLoaderNameForResource

public String getLoaderNameForResource(String resourceName)
Determines is a template exists, and returns name of the loader that provides it. This is a slightly less hokey way to support the Velocity.templateExists() utility method, which was broken when per-template encoding was introduced. We can revisit this.

Parameters: resourceName Name of template or content resource

Returns: class name of loader than can provide it

getResource

public Resource getResource(String resourceName, int resourceType, String encoding)
Gets the named resource. Returned class type corresponds to specified type (i.e. Template to RESOURCE_TEMPLATE).

Parameters: resourceName The name of the resource to retrieve. resourceType The type of resource (RESOURCE_TEMPLATE, RESOURCE_CONTENT, etc.). encoding The character encoding to use.

Returns: Resource with the template parsed and ready.

Throws: ResourceNotFoundException if template not found from any available source. ParseErrorException if template cannot be parsed due to syntax (or other) error. Exception if a problem in parse

initialize

public void initialize(RuntimeServices rs)
Initialize the ResourceManager.
Copyright B) 2002 Apache Software Foundation. All Rights Reserved.