|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.velocity.runtime.resource.loader.ResourceLoader
This is abstract class the all text resource loaders should extend.
| Field Summary | |
protected String |
className
Class name for this loader, for logging/debuggin purposes. |
protected boolean |
isCachingOn
Does this loader want templates produced with it cached in the Runtime. |
protected Log |
log
|
protected long |
modificationCheckInterval
This property will be passed on to the templates that are created with this loader. |
protected RuntimeServices |
rsvc
|
| Constructor Summary | |
ResourceLoader()
|
|
| Method Summary | |
void |
commonInit(RuntimeServices rs,
ExtendedProperties configuration)
This initialization is used by all resource loaders and must be called to set up common properties shared by all resource loaders |
String |
getClassName()
Return the class name of this resource Loader |
abstract long |
getLastModified(Resource resource)
Get the last modified time of the InputStream source that was used to create the template. |
long |
getModificationCheckInterval()
Get the interval at which the InputStream source should be checked for modifications. |
abstract InputStream |
getResourceStream(String source)
Get the InputStream that the Runtime will parse to create a template. |
abstract void |
init(ExtendedProperties configuration)
Initialize the template loader with a a resources class. |
boolean |
isCachingOn()
The Runtime uses this to find out whether this template loader wants the Runtime to cache templates created with InputStreams provided by this loader. |
abstract boolean |
isSourceModified(Resource resource)
Given a template, check to see if the source of InputStream has been modified. |
boolean |
resourceExists(String resourceName)
Check whether any given resource exists. |
void |
setCachingOn(boolean value)
Set the caching state. |
void |
setModificationCheckInterval(long modificationCheckInterval)
Set the interval at which the InputStream source should be checked for modifications. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected boolean isCachingOn
protected long modificationCheckInterval
protected String className
protected RuntimeServices rsvc
protected Log log
| Constructor Detail |
public ResourceLoader()
| Method Detail |
public void commonInit(RuntimeServices rs,
ExtendedProperties configuration)
rs - configuration - public abstract void init(ExtendedProperties configuration)
configuration -
public abstract InputStream getResourceStream(String source)
throws ResourceNotFoundException
source -
ResourceNotFoundExceptionpublic abstract boolean isSourceModified(Resource resource)
resource -
public abstract long getLastModified(Resource resource)
resource -
public String getClassName()
public void setCachingOn(boolean value)
value - public boolean isCachingOn()
public void setModificationCheckInterval(long modificationCheckInterval)
modificationCheckInterval - public long getModificationCheckInterval()
public boolean resourceExists(String resourceName)
resourceName - The name of a resource.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||