Package jdiff

Class JDiff

  • public class JDiff
extends com.sun.javadoc.Doclet
    Generates HTML describing the changes between two sets of Java source code. See the file LICENSE.txt for copyright details.

    • Constructor Summary

      Constructors 
      Constructor Description
      JDiff()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static com.sun.javadoc.LanguageVersion languageVersion()  
      static void main​(java.lang.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 int optionLength​(java.lang.String option)
      This method is called by Javadoc to parse the options it does not recognize.
      static int runAnt​(java.lang.String[] args)
      Invoke ANT by reflection.
      static void showUsage()
      Display usage information for JDiff.
      static boolean start​(com.sun.javadoc.RootDoc root)
      Doclet-mandated start method.
      protected boolean startGeneration​(com.sun.javadoc.RootDoc newRoot)
      Generate the summary of the APIs.
      static boolean validOptions​(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)
      After parsing the available options using optionLength(java.lang.String), Javadoc invokes this method with an array of options-arrays.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JDiff

        public JDiff()

    • Method Detail

      • languageVersion

        public static com.sun.javadoc.LanguageVersion languageVersion()

      • start

        public static boolean start​(com.sun.javadoc.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​(com.sun.javadoc.RootDoc newRoot)
        Generate the summary of the APIs.
        Parameters:
        root - the RootDoc object passed by Javadoc
        Returns:
        true if no problems encountered within JDiff

      • optionLength

        public static int optionLength​(java.lang.String option)
        This method is called by Javadoc to parse the options it does not recognize. It then calls validOptions(java.lang.String[][], com.sun.javadoc.DocErrorReporter) to validate them.
        Parameters:
        option - a String containing an option
        Returns:
        an int telling how many components that option has

      • validOptions

        public static boolean validOptions​(java.lang.String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)
        After parsing the available options using optionLength(java.lang.String), 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

      • main

        public static void main​(java.lang.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.

      • showUsage

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

      • runAnt

        public static int runAnt​(java.lang.String[] args)
        Invoke ANT by reflection.
        Returns:
        The integer return code from running ANT.