bboss.org.apache.velocity.runtime.resource.loader

类 ClasspathResourceLoader

java.lang.Object

bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader

bboss.org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader

public class ClasspathResourceLoader
extends ResourceLoader

ClasspathResourceLoader is a simple loader that will load templates from the classpath.

Will load templates from from multiple instances of and arbitrary combinations of :

• jar files
• zip files
• template directories (any directory containing templates)

This is a configuration-free loader, in that there are no parameters to be specified in the configuration properties, other than specifying this as the loader to use. For example the following is all that the loader needs to be functional :

resource.loader = class class.resource.loader.class = bboss.org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader

To use, put your template directories, jars and zip files into the classpath or other mechanisms that make resources accessable to the classloader.

This makes deployment trivial for web applications running in any Servlet 2.2 compliant servlet runner, such as Tomcat 3.2 and others.

For a Servlet Spec v2.2 servlet runner, just drop the jars of template files into the WEB-INF/lib directory of your webapp, and you won't have to worry about setting template paths or altering them with the root of the webapp before initializing.

I have also tried it with a WAR deployment, and that seemed to work just fine.

字段概要

从类继承的字段 bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader

className, isCachingOn, log, modificationCheckInterval, rsvc

构造器概要

构造器

构造器和说明
ClasspathResourceLoader()

方法概要

限定符和类型	方法和说明
long	getLastModified(Resource resource) Get the last modified time of the InputStream source that was used to create the template.
java.io.InputStream	getResourceStream(java.lang.String name) Get an InputStream so that the Runtime can build a template with it.
void	init(org.apache.commons.collections.ExtendedProperties configuration) This is abstract in the base class, so we need it
boolean	isSourceModified(Resource resource) Given a template, check to see if the source of InputStream has been modified.

从类继承的方法 bboss.org.apache.velocity.runtime.resource.loader.ResourceLoader

commonInit, getClassName, getModificationCheckInterval, isCachingOn, resourceExists, setCachingOn, setModificationCheckInterval

从类继承的方法 java.lang.Object

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

构造器详细资料

ClasspathResourceLoader

public ClasspathResourceLoader()

方法详细资料

init

public void init(org.apache.commons.collections.ExtendedProperties configuration)

This is abstract in the base class, so we need it

指定者:

init 在类中 ResourceLoader

参数:

configuration -

getResourceStream

public java.io.InputStream getResourceStream(java.lang.String name)
                                      throws ResourceNotFoundException

Get an InputStream so that the Runtime can build a template with it.

指定者:

getResourceStream 在类中 ResourceLoader

参数:

name - name of template to get

返回:

InputStream containing the template

抛出:

ResourceNotFoundException - if template not found in classpath.

isSourceModified

public boolean isSourceModified(Resource resource)

从类复制的说明: ResourceLoader

Given a template, check to see if the source of InputStream has been modified.

指定者:

isSourceModified 在类中 ResourceLoader

返回:

True if the resource has been modified.

另请参阅:

ResourceLoader.isSourceModified(bboss.org.apache.velocity.runtime.resource.Resource)

getLastModified

public long getLastModified(Resource resource)

从类复制的说明: ResourceLoader

Get the last modified time of the InputStream source that was used to create the template. We need the template here because we have to extract the name of the template in order to locate the InputStream source.

指定者:

getLastModified 在类中 ResourceLoader

返回:

Time in millis when the resource has been modified.

另请参阅:

ResourceLoader.getLastModified(bboss.org.apache.velocity.runtime.resource.Resource)