org.jamon.api

Interface TemplateSource

public interface TemplateSource

An interface representing a "repository" of template sources. One obvious implementation would be a file-system based implementation (e.g. org.jamon.compiler.FileTemplateSource), but others might include storing templates in a database, or retrieving them remotely via HTTP.

Method Summary

Modifier and Type	Method and Description
boolean	available(String templatePath) Determines whether the indicated template source is available.
String	getExternalIdentifier(String templatePath) Get an identifying string for the specified template.
InputStream	getStreamFor(String templatePath) Get a InputStream for the source of the specified template.
TemplateLocation	getTemplateLocation(String templatePath)
long	lastModified(String templatePath) Determines when the indicated template was last modified, in ms since the epoch.
void	loadProperties(String path, Properties properties) Load any properties that might be used to influence the processing of templates within the specified directory.

Method Detail

lastModified

long lastModified(String templatePath)
           throws IOException

Determines when the indicated template was last modified, in ms since the epoch.

Parameters:

templatePath - the path to the template

Returns:

the timestamp of when the template was last modified

Throws:

IOException

available

boolean available(String templatePath)
           throws IOException

Determines whether the indicated template source is available.

Parameters:

templatePath - the path to the template

Returns:

whether the template source is available

Throws:

IOException

getStreamFor

InputStream getStreamFor(String templatePath)
                  throws IOException

Get a InputStream for the source of the specified template.

Parameters:

templatePath - the path to the template

Returns:

an InputStream for the data comprising the template

Throws:

IOException

getExternalIdentifier

String getExternalIdentifier(String templatePath)

Get an identifying string for the specified template.

Parameters:

templatePath - the path to the template

Returns:

an identifying string

getTemplateLocation

TemplateLocation getTemplateLocation(String templatePath)

loadProperties

void loadProperties(String path,
                    Properties properties)
             throws IOException

Load any properties that might be used to influence the processing of templates within the specified directory.

Parameters:

path - The directory to to look for

properties - The Properties instance to add any found properties to.

Throws:

IOException