org.apache.velocity.runtime.resource
Class Resource
java.lang.Object
org.apache.velocity.runtime.resource.Resource
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.
$Id: Resource.java,v 1.12.4.1 2004/03/03 23:23:01 geirm Exp $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 seconds).
|
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
|
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()
|
abstract 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.
|
MILLIS_PER_SECOND
protected static final long MILLIS_PER_SECOND
The number of milliseconds in a minute, used to calculate the
check interval.
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 seconds).
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.
Resource
public Resource()
Default constructor
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 abstract 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.
- Whether the resource could be processed successfully.
For a
Template
or ContentResource
, this
indicates whether the resource could be read.
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.
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.
touch
public void touch()
'Touch' this template and thereby resetting
the nextCheck field.
Copyright B) 2002 Apache Software Foundation. All Rights Reserved.