Class ChangeReport


  • public final class ChangeReport
    extends Object
    Reports public and protected API changes between two JAR files. Instructions about this command can be found one the Tools page. The arguments expected by the main methods are:
    Name Meaning Example
    oldVersion Old GeoAPI version number, as declared in Maven artefact. "3.0.1"
    newVersion New GeoAPI version number, as declared in Maven artefact. "3.1-M07"
    outputFile Name of the file to create. "Changes.html"
    Since:
    3.1
    • Constructor Detail

      • ChangeReport

        public ChangeReport​(Version oldVersion,
                            Version newVersion)
        Creates a new object for generating a report of the changes between two GeoAPI versions.
        Parameters:
        oldVersion - The old GeoAPI version.
        newVersion - The new GeoAPI version.
    • Method Detail

      • main

        public static void main​(String[] args)
                         throws Exception
        Generates the API difference between two GeoAPI versions. See class Javadoc for the list of expected arguments.
        Parameters:
        args - An array of length 4 containing the two GeoAPI versions to compare.
        Throws:
        Exception - If an I/O or reflection error occurred (too many checked exceptions for enumerating them all).
      • write

        public void write​(File outputFile)
                   throws Exception
        Implementation of the main(String[]) method after arguments parsing.
        Parameters:
        outputFile - The file where to write the report.
        Throws:
        Exception - If an I/O or reflection error occurred (too many checked exceptions for enumerating them all).