org.apache.velocity.runtime.resource
Interface ResourceManager
- ResourceManagerImpl
public interface ResourceManager
Class to manage the text resource for the Velocity
Runtime.
Version:
- Jason van Zyl
- Paulo Gaspar
- Geir Magnusson Jr.
RESOURCE_CONTENT
public static final int RESOURCE_CONTENT
A static content resource.
- 2
RESOURCE_TEMPLATE
public static final int RESOURCE_TEMPLATE
A template resources.
- 1
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.
resourceName
- Name of template or content resource
- class name of loader than can provide it
getResource
public Resource getResource(String resourceName,
int resourceType,
String encoding)
throws ResourceNotFoundException,
ParseErrorException,
Exception
Gets the named resource. Returned class type corresponds to specified type
(i.e. Template
to RESOURCE_TEMPLATE
).
resourceName
- The name of the resource to retrieve.resourceType
- The type of resource (RESOURCE_TEMPLATE
,
RESOURCE_CONTENT
, etc.).encoding
- The character encoding to use.
- Resource with the template parsed and ready.
ResourceNotFoundException
- if template not found
from any available source.ParseErrorException
- if template cannot be parsed due
to syntax (or other) error.
initialize
public void initialize(RuntimeServices rs)
throws Exception
Initialize the ResourceManager. It is assumed
that assembleSourceInitializers() has been
called before this is run.
Copyright © 2003 Apache Software Foundation. All Rights Reserved.