Package org.codehaus.mojo.license

Class ThirdPartyReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.license.AbstractThirdPartyReport

org.codehaus.mojo.license.ThirdPartyReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport, MavenProjectDependenciesConfigurator

@Mojo(name="third-party-report",
      requiresDependencyResolution=TEST)
public class ThirdPartyReport
extends AbstractThirdPartyReport

Generates a report of all third-parties detected in the module.

Since:

1.1

Author:

tchemit dev@tchemit.fr

Field Summary

Fields inherited from class org.codehaus.mojo.license.AbstractThirdPartyReport

licenseMergesUrl

Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ThirdPartyReport(org.codehaus.plexus.i18n.I18N i18n, DependenciesTool dependenciesTool, ThirdPartyTool thirdPartyTool)

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
protected Collection<ThirdPartyDetails>	createThirdPartyDetails()
String	getOutputName()	Deprecated.

Methods inherited from class org.codehaus.mojo.license.AbstractThirdPartyReport

executeReport, getArtifactFilters, getArtifactFiltersUrl, getDescription, getEncoding, getName, init, isExcludeTransitiveDependencies, isIncludeTransitiveDependencies, isVerbose

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Constructor Details

ThirdPartyReport

@Inject
public ThirdPartyReport(org.codehaus.plexus.i18n.I18N i18n,
 DependenciesTool dependenciesTool,
 ThirdPartyTool thirdPartyTool)

Method Details

getOutputName

@Deprecated
public String getOutputName()

Deprecated.

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

createThirdPartyDetails

protected Collection<ThirdPartyDetails> createThirdPartyDetails()
                                                         throws IOException,
ThirdPartyToolException,
org.apache.maven.project.ProjectBuildingException,
org.apache.maven.plugin.MojoFailureException,
DependenciesToolException,
org.apache.maven.plugin.MojoExecutionException

Specified by:

createThirdPartyDetails in class AbstractThirdPartyReport

Throws:

IOException

ThirdPartyToolException

org.apache.maven.project.ProjectBuildingException

org.apache.maven.plugin.MojoFailureException

DependenciesToolException

org.apache.maven.plugin.MojoExecutionException