org.jamon.compiler

Class FileTemplateSource

java.lang.Object

org.jamon.compiler.FileTemplateSource

All Implemented Interfaces:

org.jamon.api.TemplateSource

public class FileTemplateSource
extends Object
implements org.jamon.api.TemplateSource

The standard implementation of TemplateSource which retrieves templates from the filesystem location under a specified root directory. By default, templates are expected to have extens ".jamon"; this can be overridden.

Constructor Summary

Constructors

Constructor and Description
FileTemplateSource(File templateSourceDir) Construct a FileTemplateSource, using the default extension ".jamon".
FileTemplateSource(File templateSourceDir, String extension) Construct a FileTemplateSource, specifying a filename extension for templates.
FileTemplateSource(String templateSourceDir) Construct a FileTemplateSource

Method Summary

Modifier and Type	Method and Description
boolean	available(String templatePath)
String	getExternalIdentifier(String templatePath)
InputStream	getStreamFor(String templatePath)
org.jamon.api.TemplateLocation	getTemplateLocation(String templatePath)
long	lastModified(String templatePath)
void	loadProperties(String path, Properties properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTemplateSource

public FileTemplateSource(String templateSourceDir)

Construct a FileTemplateSource

Parameters:

templateSourceDir - the source directory

FileTemplateSource

public FileTemplateSource(File templateSourceDir)

Construct a FileTemplateSource, using the default extension ".jamon".

Parameters:

templateSourceDir - the source directory

FileTemplateSource

public FileTemplateSource(File templateSourceDir,
                          String extension)

Construct a FileTemplateSource, specifying a filename extension for templates. If the supplied extension is null or empty, no extension is expected, otherwise the extension should NOT include a leading ".".

Parameters:

templateSourceDir - the source directory

extension - the filename extension for templates

Method Detail

lastModified

public long lastModified(String templatePath)

Specified by:

lastModified in interface org.jamon.api.TemplateSource

available

public boolean available(String templatePath)

Specified by:

available in interface org.jamon.api.TemplateSource

getStreamFor

public InputStream getStreamFor(String templatePath)
                         throws IOException

Specified by:

getStreamFor in interface org.jamon.api.TemplateSource

Throws:

IOException

getExternalIdentifier

public String getExternalIdentifier(String templatePath)

Specified by:

getExternalIdentifier in interface org.jamon.api.TemplateSource

getTemplateLocation

public org.jamon.api.TemplateLocation getTemplateLocation(String templatePath)

Specified by:

getTemplateLocation in interface org.jamon.api.TemplateSource

loadProperties

public void loadProperties(String path,
                           Properties properties)
                    throws IOException

Specified by:

loadProperties in interface org.jamon.api.TemplateSource

Throws:

IOException