jdiff

Class JDiff

public class JDiff extends Doclet

Generates HTML describing the changes between two sets of Java source code. See the file LICENSE.txt for copyright details.
Method Summary
static voidmain(String[] args)
This method is only called when running JDiff as a standalone application, and uses ANT to execute the build configuration in the XML configuration file passed in.
static intoptionLength(String option)
This method is called by Javadoc to parse the options it does not recognize.
static intrunAnt(String[] args)
Invoke ANT by reflection.
static voidshowUsage()
Display usage information for JDiff.
static booleanstart(RootDoc root)
Doclet-mandated start method.
protected booleanstartGeneration(RootDoc newRoot)
Generate the summary of the APIs.
static booleanvalidOptions(String[][] options, DocErrorReporter reporter)
After parsing the available options using JDiff, Javadoc invokes this method with an array of options-arrays.

Method Detail

main

public static void main(String[] args)
This method is only called when running JDiff as a standalone application, and uses ANT to execute the build configuration in the XML configuration file passed in.

optionLength

public static int optionLength(String option)
This method is called by Javadoc to parse the options it does not recognize. It then calls JDiff to validate them.

Parameters: option a String containing an option

Returns: an int telling how many components that option has

runAnt

public static int runAnt(String[] args)
Invoke ANT by reflection.

Returns: The integer return code from running ANT.

showUsage

public static void showUsage()
Display usage information for JDiff.

start

public static boolean start(RootDoc root)
Doclet-mandated start method. Everything begins here.

Parameters: root a RootDoc object passed by Javadoc

Returns: true if document generation succeeds

startGeneration

protected boolean startGeneration(RootDoc newRoot)
Generate the summary of the APIs.

Parameters: root the RootDoc object passed by Javadoc

Returns: true if no problems encountered within JDiff

validOptions

public static boolean validOptions(String[][] options, DocErrorReporter reporter)
After parsing the available options using JDiff, Javadoc invokes this method with an array of options-arrays.

Parameters: options an array of String arrays, one per option reporter a DocErrorReporter for generating error messages

Returns: true if no errors were found, and all options are valid