|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjdiff.JDiffAntTask
public class JDiffAntTask
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. |
Constructor Summary | |
---|---|
JDiffAntTask()
|
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(org.apache.tools.ant.taskdefs.Javadoc jd,
JDiffAntTask.ProjectInfo proj)
Add the root directories for the given project to the Javadoc sourcepath. |
protected void |
compareXML(java.lang.String oldapiname,
java.lang.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(java.lang.String src,
java.lang.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. |
java.io.File |
getDestdir()
|
boolean |
getDocchanges()
|
protected java.lang.String |
getPackageList(JDiffAntTask.ProjectInfo proj)
Return the comma-separated list of packages. |
java.lang.String |
getSource()
|
boolean |
getStats()
|
boolean |
getVerbose()
|
protected org.apache.tools.ant.taskdefs.Javadoc |
initJavadoc(java.lang.String logMsg)
Create a fresh new Javadoc task object and initialize it. |
void |
setDestdir(java.io.File value)
Used to store the destdir attribute of the JDiff task XML element. |
void |
setDocchanges(boolean value)
|
void |
setProject(org.apache.tools.ant.Project proj)
Used as part of Ant's startup. |
void |
setSource(java.lang.String source)
|
void |
setStats(boolean value)
|
void |
setVerbose(boolean value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JDiffAntTask()
Method Detail |
---|
public void execute() throws org.apache.tools.ant.BuildException
org.apache.tools.ant.BuildException
protected void generateXML(JDiffAntTask.ProjectInfo proj)
proj
- The current Projectprotected void compareXML(java.lang.String oldapiname, java.lang.String newapiname)
oldapiname
- The name of the older version of the projectnewapiname
- The name of the newer version of the projectprotected void generateJavadoc(JDiffAntTask.ProjectInfo proj)
proj
- The current Projectprotected org.apache.tools.ant.taskdefs.Javadoc initJavadoc(java.lang.String logMsg)
logMsg
- String which appears as a prefix in the Ant log
protected void addSourcePaths(org.apache.tools.ant.taskdefs.Javadoc jd, JDiffAntTask.ProjectInfo proj)
protected java.lang.String getPackageList(JDiffAntTask.ProjectInfo proj) throws org.apache.tools.ant.BuildException
org.apache.tools.ant.BuildException
protected void copyFile(java.lang.String src, java.lang.String dst)
public void setProject(org.apache.tools.ant.Project proj)
public void setDestdir(java.io.File value)
public java.io.File getDestdir()
public void setVerbose(boolean value)
public boolean getVerbose()
public void setDocchanges(boolean value)
public boolean getDocchanges()
public void setStats(boolean value)
public boolean getStats()
public void setSource(java.lang.String source)
public java.lang.String getSource()
public void addConfiguredOld(JDiffAntTask.ProjectInfo projInfo)
public void addConfiguredNew(JDiffAntTask.ProjectInfo projInfo)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |