org.codehaus.mojo.license

Class ThirdPartyReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.license.AbstractThirdPartyReportMojo

org.codehaus.mojo.license.ThirdPartyReportMojo

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 ThirdPartyReportMojo
extends AbstractThirdPartyReportMojo

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.AbstractThirdPartyReportMojo

licenseMergesUrl

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 and Description
ThirdPartyReportMojo()

Method Summary

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

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

executeReport, getArtifactFilters, getArtifactFiltersUrl, getDescription, getEncoding, getName, getOutputDirectory, getProject, getSiteRenderer, init, isExcludeTransitiveDependencies, isIncludeTransitiveDependencies, isVerbose

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

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, 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

Constructor Detail

ThirdPartyReportMojo

public ThirdPartyReportMojo()

Method Detail

getOutputName

public String getOutputName()

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 AbstractThirdPartyReportMojo

Throws:

IOException

ThirdPartyToolException

org.apache.maven.project.ProjectBuildingException

org.apache.maven.plugin.MojoFailureException

DependenciesToolException

org.apache.maven.plugin.MojoExecutionException