org.jamon.compiler
Class FileTemplateSource

java.lang.Object
  org.jamon.compiler.FileTemplateSource

All Implemented Interfaces:

org.jamon.api.TemplateSource

public class FileTemplateSource
extends java.lang.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

FileTemplateSource(java.io.File p_templateSourceDir)
Construct a FileTemplateSource, using the default extension ".jamon".

FileTemplateSource(java.io.File p_templateSourceDir, java.lang.String p_extension)
Construct a FileTemplateSource, specifying a filename extension for templates.

FileTemplateSource(java.lang.String p_templateSourceDir)
Construct a FileTemplateSource

Method Summary

boolean	available(java.lang.String p_templatePath)
java.lang.String	getExternalIdentifier(java.lang.String p_templatePath)
java.io.InputStream	getStreamFor(java.lang.String p_templatePath)
org.jamon.api.TemplateLocation	getTemplateLocation(java.lang.String p_templatePath)
long	lastModified(java.lang.String p_templatePath)
void	loadProperties(java.lang.String p_path, java.util.Properties p_properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTemplateSource

public FileTemplateSource(java.lang.String p_templateSourceDir)

Construct a FileTemplateSource

Parameters:

p_templateSourceDir - the source directory

FileTemplateSource

public FileTemplateSource(java.io.File p_templateSourceDir)

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

Parameters:

p_templateSourceDir - the source directory

FileTemplateSource

public FileTemplateSource(java.io.File p_templateSourceDir,
                          java.lang.String p_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:

p_templateSourceDir - the source directory

p_extension - the filename extension for templates

Method Detail

lastModified

public long lastModified(java.lang.String p_templatePath)

Specified by:

lastModified in interface org.jamon.api.TemplateSource

available

public boolean available(java.lang.String p_templatePath)

Specified by:

available in interface org.jamon.api.TemplateSource

getStreamFor

public java.io.InputStream getStreamFor(java.lang.String p_templatePath)
                                 throws java.io.IOException

Specified by:

getStreamFor in interface org.jamon.api.TemplateSource

Throws:

java.io.IOException

getExternalIdentifier

public java.lang.String getExternalIdentifier(java.lang.String p_templatePath)

Specified by:

getExternalIdentifier in interface org.jamon.api.TemplateSource

getTemplateLocation

public org.jamon.api.TemplateLocation getTemplateLocation(java.lang.String p_templatePath)

Specified by:

getTemplateLocation in interface org.jamon.api.TemplateSource

loadProperties

public void loadProperties(java.lang.String p_path,
                           java.util.Properties p_properties)
                    throws java.io.IOException

Specified by:

loadProperties in interface org.jamon.api.TemplateSource

Throws:

java.io.IOException