org.apache.velocity.runtime.resource

Class Resource

Known Direct Subclasses:
ContentResource, Template

public abstract class Resource
extends java.lang.Object

This class represent a general text resource that may have been retrieved from any number of possible sources.

Version:
$Id: Resource.java,v 1.9 2001/10/22 03:53:25 jon Exp $

Authors:
Jason van Zyl
Geir Magnusson Jr.

Field Summary

protected static long
MILLIS_PER_SECOND
The number of milliseconds in a minute, used to calculate the check interval.
protected Object
data
Resource might require ancillary storage of some kind
protected String
encoding
Character encoding of this resource
protected long
lastModified
The file modification time (in milliseconds) for the cached template.
protected long
modificationCheckInterval
How often the file modification time is checked (in milliseconds).
protected String
name
Name of the resource
protected long
nextCheck
The next time the file modification time will be checked (in milliseconds).
protected ResourceLoader
resourceLoader
The template loader that initially loaded the input stream for this template, and knows how to check the source of the input stream for modification.
protected RuntimeServices
rsvc

Constructor Summary

Resource()
Default constructor

Method Summary

Object
getData()
Get arbitrary data object that might be used by the resource.
String
getEncoding()
get the encoding of this resource for example, "ISO-8859-1"
long
getLastModified()
Return the lastModifed time of this template.
String
getName()
Get the name of this template.
ResourceLoader
getResourceLoader()
Return the template loader that pulled in the template stream
boolean
isSourceModified()
boolean
process()
Perform any subsequent processing that might need to be done by a resource.
boolean
requiresChecking()
Is it time to check to see if the resource source has been updated?
void
setData(Object data)
Set arbitrary data object that might be used by the resource.
void
setEncoding(String encoding)
set the encoding of this resource for example, "ISO-8859-1"
void
setLastModified(long lastModified)
Set the last modified time for this template.
void
setModificationCheckInterval(long modificationCheckInterval)
Set the modification check interval.
void
setName(String name)
Set the name of this resource, for example test.vm.
void
setResourceLoader(ResourceLoader resourceLoader)
Set the template loader for this template.
void
setRuntimeServices(RuntimeServices rs)
void
touch()
'Touch' this template and thereby resetting the nextCheck field.

Field Details

MILLIS_PER_SECOND

protected static final long MILLIS_PER_SECOND
The number of milliseconds in a minute, used to calculate the check interval.

Field Value:
1000L


data

protected Object data
Resource might require ancillary storage of some kind


encoding

protected String encoding
Character encoding of this resource


lastModified

protected long lastModified
The file modification time (in milliseconds) for the cached template.


modificationCheckInterval

protected long modificationCheckInterval
How often the file modification time is checked (in milliseconds).


name

protected String name
Name of the resource


nextCheck

protected long nextCheck
The next time the file modification time will be checked (in milliseconds).


resourceLoader

protected ResourceLoader resourceLoader
The template loader that initially loaded the input stream for this template, and knows how to check the source of the input stream for modification.


rsvc

protected RuntimeServices rsvc

Constructor Details

Resource

public Resource()
Default constructor

Method Details

getData

public Object getData()
Get arbitrary data object that might be used by the resource.


getEncoding

public String getEncoding()
get the encoding of this resource for example, "ISO-8859-1"


getLastModified

public long getLastModified()
Return the lastModifed time of this template.


getName

public String getName()
Get the name of this template.


getResourceLoader

public ResourceLoader getResourceLoader()
Return the template loader that pulled in the template stream


isSourceModified

public boolean isSourceModified()


process

public boolean process()
            throws ResourceNotFoundException,
                   ParseErrorException,
                   Exception
Perform any subsequent processing that might need to be done by a resource. In the case of a template the actual parsing of the input stream needs to be performed.


requiresChecking

public boolean requiresChecking()
Is it time to check to see if the resource source has been updated?


setData

public void setData(Object data)
Set arbitrary data object that might be used by the resource.


setEncoding

public void setEncoding(String encoding)
set the encoding of this resource for example, "ISO-8859-1"


setLastModified

public void setLastModified(long lastModified)
Set the last modified time for this template.


setModificationCheckInterval

public void setModificationCheckInterval(long modificationCheckInterval)
Set the modification check interval.

Parameters:


setName

public void setName(String name)
Set the name of this resource, for example test.vm.


setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)
Set the template loader for this template. Set when the Runtime determines where this template came from the list of possible sources.


setRuntimeServices

public void setRuntimeServices(RuntimeServices rs)


touch

public void touch()
'Touch' this template and thereby resetting the nextCheck field.


Copyright © 2003 Apache Software Foundation. All Rights Reserved.