public abstract class Resource
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected java.lang.Object |
data
Resource might require ancillary storage of some kind
|
protected java.lang.String |
encoding
Character encoding of this resource
|
protected long |
lastModified
The file modification time (in milliseconds) for the cached template.
|
protected static long |
MILLIS_PER_SECOND
The number of milliseconds in a minute, used to calculate the
check interval.
|
protected long |
modificationCheckInterval
How often the file modification time is checked (in seconds).
|
protected java.lang.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 and Description |
---|
Resource()
Default constructor
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getData()
Get arbitrary data object that might be used
by the resource.
|
java.lang.String |
getEncoding()
get the encoding of this resource
for example, "ISO-8859-1"
|
long |
getLastModified()
Return the lastModifed time of this
template.
|
java.lang.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(java.lang.Object data)
Set arbitrary data object that might be used
by the resource.
|
void |
setEncoding(java.lang.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(java.lang.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.
|
protected RuntimeServices rsvc
protected ResourceLoader resourceLoader
protected static final long MILLIS_PER_SECOND
protected long modificationCheckInterval
protected long lastModified
protected long nextCheck
protected java.lang.String name
protected java.lang.String encoding
protected java.lang.Object data
public void setRuntimeServices(RuntimeServices rs)
public abstract boolean process() throws ResourceNotFoundException, ParseErrorException, java.lang.Exception
Template
or ContentResource
, this
indicates whether the resource could be read.ResourceNotFoundException
- Similar in semantics as
returning false
.ParseErrorException
java.lang.Exception
public boolean isSourceModified()
public void setModificationCheckInterval(long modificationCheckInterval)
interval
- The interval (in seconds).public boolean requiresChecking()
public void touch()
public void setName(java.lang.String name)
public java.lang.String getName()
public void setEncoding(java.lang.String encoding)
public java.lang.String getEncoding()
public long getLastModified()
public void setLastModified(long lastModified)
public ResourceLoader getResourceLoader()
public void setResourceLoader(ResourceLoader resourceLoader)
public void setData(java.lang.Object data)
public java.lang.Object getData()
Copyright ? 2002 Apache Software Foundation. All Rights Reserved.