net.sf.jameleon.ant
Class GenSyntaxReferenceTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          net.sf.jameleon.ant.GenSyntaxReferenceTask

public class GenSyntaxReferenceTask
extends org.apache.tools.ant.Task

An Ant task that takes the registered FunctionalPoints and generates a syntax reference for each one.

Field Summary

protected File	outputFile
protected List	parameters
protected String	plugin
protected String	templateName

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

GenSyntaxReferenceTask()

Method Summary

void	addTemplateParam(org.apache.tools.ant.types.Parameter parameter) Adds a template parameter to be passed to the Velocity template
void	execute() Jameleon's implementation of Task.execute().
void	setOutputFile(File fileName) Set the file where the syntax reference will be generated.
void	setPlugin(String plugin) Sets the plugin to generate the syntax reference from.
void	setTemplateName(String templateName) Sets the name of the file, not including path of the template to use.

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Field Detail

outputFile

protected File outputFile

plugin

protected String plugin

templateName

protected String templateName

parameters

protected List parameters

Constructor Detail

GenSyntaxReferenceTask

public GenSyntaxReferenceTask()

Method Detail

addTemplateParam

public void addTemplateParam(org.apache.tools.ant.types.Parameter parameter)

Adds a template parameter to be passed to the Velocity template

Parameters:

parameter - a name/value parameter.

setTemplateName

public void setTemplateName(String templateName)

Sets the name of the file, not including path of the template to use. Defaults to 'syntaxReference.txt'.

Parameters:

templateName - - the name of the file, not including path of the template to use. NOTE: This fileName is loaded from the CLASSPATH.

setPlugin

public void setPlugin(String plugin)

Sets the plugin to generate the syntax reference from. Defaults to TestCaseTagDefs

Parameters:

plugin - - the plugin to generate the syntax reference from. For the htmlunit-plugin, pass in 'htmlunit-plugin'.

setOutputFile

public void setOutputFile(File fileName)

Set the file where the syntax reference will be generated.

Parameters:

fileName - - The name of the file.

execute

public final void execute()
                   throws org.apache.tools.ant.BuildException

Jameleon's implementation of Task.execute().

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - Ant's way of reporting exception