org.spf4j.jdiff

Class JDiffRunner

java.lang.Object

org.spf4j.jdiff.JDiffRunner

public final class JDiffRunner
extends Object

Author:

Zoltan Farkas

Constructor Summary

Constructors

Constructor and Description
JDiffRunner()
JDiffRunner(org.apache.maven.plugin.MojoExecution mojoExec, org.apache.maven.toolchain.ToolchainManager toolchainManager, org.apache.maven.execution.MavenSession session, List<org.eclipse.aether.repository.RemoteRepository> remoteRepos, org.eclipse.aether.RepositorySystem repositorySystem, String javadocExec)

Method Summary

Modifier and Type	Method and Description
Set<String>	generateJDiffXML(Collection<File> sources, Collection<File> classPath, File destinationFolder, String apiName, Collection<String> includePackageNames)
void	generateReport(File srcDir, String oldApi, String newApi, String javadocOld, String javadocNew, Set<String> packages, File destinationDir)
void	runDiffBetweenReleases(String groupId, String artifactId, String versionRange, File destinationFolder, int maxNrOFDiffs)
void	runDiffBetweenReleases(String groupId, String artifactId, String version1, String version2, File destinationFolder, Set<String> includePackages)
String	toString()
void	writeChangesIndexHtml(File reportOutputDirectory, String fileName)

Methods inherited from class java.lang.Object

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

Constructor Detail

JDiffRunner

public JDiffRunner()

JDiffRunner

public JDiffRunner(org.apache.maven.plugin.MojoExecution mojoExec,
                   org.apache.maven.toolchain.ToolchainManager toolchainManager,
                   org.apache.maven.execution.MavenSession session,
                   List<org.eclipse.aether.repository.RemoteRepository> remoteRepos,
                   org.eclipse.aether.RepositorySystem repositorySystem,
                   String javadocExec)

Method Detail

generateJDiffXML

public Set<String> generateJDiffXML(Collection<File> sources,
                                    Collection<File> classPath,
                                    File destinationFolder,
                                    String apiName,
                                    Collection<String> includePackageNames)
                             throws JavadocExecutionException,
                                    IOException

Throws:

JavadocExecutionException

IOException

generateReport

public void generateReport(File srcDir,
                           String oldApi,
                           String newApi,
                           String javadocOld,
                           String javadocNew,
                           Set<String> packages,
                           File destinationDir)
                    throws JavadocExecutionException,
                           IOException

Throws:

JavadocExecutionException

IOException

runDiffBetweenReleases

public void runDiffBetweenReleases(String groupId,
                                   String artifactId,
                                   String versionRange,
                                   File destinationFolder,
                                   int maxNrOFDiffs)
                            throws org.eclipse.aether.resolution.DependencyResolutionException,
                                   org.eclipse.aether.resolution.VersionRangeResolutionException,
                                   IOException,
                                   org.eclipse.aether.resolution.ArtifactResolutionException,
                                   JavadocExecutionException

Throws:

org.eclipse.aether.resolution.DependencyResolutionException

org.eclipse.aether.resolution.VersionRangeResolutionException

IOException

org.eclipse.aether.resolution.ArtifactResolutionException

JavadocExecutionException

runDiffBetweenReleases

public void runDiffBetweenReleases(String groupId,
                                   String artifactId,
                                   String version1,
                                   String version2,
                                   File destinationFolder,
                                   Set<String> includePackages)
                            throws org.eclipse.aether.resolution.ArtifactResolutionException,
                                   org.eclipse.aether.resolution.DependencyResolutionException,
                                   IOException,
                                   JavadocExecutionException

Throws:

org.eclipse.aether.resolution.ArtifactResolutionException

org.eclipse.aether.resolution.DependencyResolutionException

IOException

JavadocExecutionException

writeChangesIndexHtml

public void writeChangesIndexHtml(File reportOutputDirectory,
                                  String fileName)
                           throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object