jdiff

Class JDiffAntTask

public class JDiffAntTask extends Object

An Ant task to produce a simple JDiff report. More complex reports still need parameters that are controlled by the Ant Javadoc task.

Nested Class Summary
static class	JDiffAntTask.ProjectInfo This class handles the information about a project, whether it is the older or newer version.

Method Summary
void	addConfiguredNew(JDiffAntTask.ProjectInfo projInfo) Used to store the child element named "new", which is under the JDiff task XML element.
void	addConfiguredOld(JDiffAntTask.ProjectInfo projInfo) Used to store the child element named "old", which is under the JDiff task XML element.
protected void	addSourcePaths(Javadoc jd, JDiffAntTask.ProjectInfo proj) Add the root directories for the given project to the Javadoc sourcepath.
protected void	compareXML(String oldapiname, String newapiname) Convenient method to create a Javadoc task, configure it and run it to compare the XML representations of two instances of a project's source files, and generate an HTML report summarizing the differences.
protected void	copyFile(String src, String dst) Copy a file from src to dst.
void	execute()
protected void	generateJavadoc(JDiffAntTask.ProjectInfo proj) Generate the Javadoc for the project.
protected void	generateXML(JDiffAntTask.ProjectInfo proj) Convenient method to create a Javadoc task, configure it and run it to generate the XML representation of a project's source files.
File	getDestdir()
boolean	getDocchanges()
protected String	getPackageList(JDiffAntTask.ProjectInfo proj) Return the comma-separated list of packages.
boolean	getStats()
boolean	getVerbose()
protected Javadoc	initJavadoc(String logMsg) Create a fresh new Javadoc task object and initialize it.
void	setDestdir(File value) Used to store the destdir attribute of the JDiff task XML element.
void	setDocchanges(boolean value)
void	setProject(Project proj) Used as part of Ant's startup.
void	setStats(boolean value)
void	setVerbose(boolean value)

Method Detail

addConfiguredNew

public void addConfiguredNew(JDiffAntTask.ProjectInfo projInfo)

Used to store the child element named "new", which is under the JDiff task XML element.

addConfiguredOld

public void addConfiguredOld(JDiffAntTask.ProjectInfo projInfo)

Used to store the child element named "old", which is under the JDiff task XML element.

addSourcePaths

protected void addSourcePaths(Javadoc jd, JDiffAntTask.ProjectInfo proj)

Add the root directories for the given project to the Javadoc sourcepath.

compareXML

protected void compareXML(String oldapiname, String newapiname)

Convenient method to create a Javadoc task, configure it and run it to compare the XML representations of two instances of a project's source files, and generate an HTML report summarizing the differences.

Parameters: oldapiname The name of the older version of the project newapiname The name of the newer version of the project

copyFile

protected void copyFile(String src, String dst)

Copy a file from src to dst. Also checks that "destdir/changes" exists

execute

public void execute()

generateJavadoc

protected void generateJavadoc(JDiffAntTask.ProjectInfo proj)

Generate the Javadoc for the project. If you want to generate the Javadoc report for the project with different parameters from the simple ones used here, then use the Javadoc Ant task directly, and set the javadoc attribute to the "old" or "new" element.

Parameters: proj The current Project

generateXML

protected void generateXML(JDiffAntTask.ProjectInfo proj)

Convenient method to create a Javadoc task, configure it and run it to generate the XML representation of a project's source files.

Parameters: proj The current Project

Parameters: logMsg String which appears as a prefix in the Ant log

Returns: The new task.Javadoc object