org.howardism.ant
Interface WebTemplatePlugin

All Known Implementing Classes:

FreeMarkerPlugin, StringTemplatePlugin

public interface WebTemplatePlugin

This defines the plugin interface for template engine wrappers for the WebTemplate Ant task.

Method Summary

void	convert(java.io.File srcParent, java.io.File destFile, java.lang.String template, java.util.Properties attributes) Converts a single file using the template engine.
void	setParent(org.apache.tools.ant.Task parent) Allows the WebTemplate task to pass the plugin a reference to the Parent (the caller) so that it can send it log messages.

Method Detail

convert

public void convert(java.io.File srcParent,
                    java.io.File destFile,
                    java.lang.String template,
                    java.util.Properties attributes)
             throws org.apache.tools.ant.BuildException

Converts a single file using the template engine.

The parameters include the source data file and the template as well as the destination file where the resulting converted file will be written by this method.

Parameters:

srcParent - name of the input file's parent for locating the template file.

destFile - name of the destination file.

template - name of the template file

attributes - A java.util.Properties file that contains the data and content

Throws:

org.apache.tools.ant.BuildException

setParent

public void setParent(org.apache.tools.ant.Task parent)

Allows the WebTemplate task to pass the plugin a reference to the Parent (the caller) so that it can send it log messages.

Parameters:

parent -