Package org.codehaus.mojo.license

Class AbstractThirdPartyReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.license.AbstractThirdPartyReport

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorThirdPartyReport, ThirdPartyReport

public abstract class AbstractThirdPartyReport
extends org.apache.maven.reporting.AbstractMavenReport
implements MavenProjectDependenciesConfigurator

Base class for third-party reports.

Since:

1.1

Author:

tchemit dev@tchemit.fr

Field Summary

Fields

Modifier and Type	Field	Description
protected String	licenseMergesUrl	Location of file with the merge licenses in order to be used by command line.

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

Modifier	Constructor	Description
protected	AbstractThirdPartyReport(org.codehaus.plexus.i18n.I18N i18n, DependenciesTool dependenciesTool, ThirdPartyTool thirdPartyTool)

Method Summary

Modifier and Type	Method	Description
protected abstract Collection<ThirdPartyDetails>	createThirdPartyDetails()
protected void	executeReport(Locale locale)
ArtifactFilters	getArtifactFilters()
String	getArtifactFiltersUrl()
String	getDescription(Locale locale)
String	getEncoding()
String	getName(Locale locale)
protected void	init()	Method to initialize the mojo before doing any concrete actions.
boolean	isExcludeTransitiveDependencies()
boolean	isIncludeTransitiveDependencies()
boolean	isVerbose()

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

canGenerateReport, 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

getOutputName, getOutputPath

Field Details

licenseMergesUrl

@Parameter(property="license.licenseMergesUrl")
protected String licenseMergesUrl

Location of file with the merge licenses in order to be used by command line. Note: This option overrides licenseMerges.

Since:

1.18

Constructor Details

AbstractThirdPartyReport

protected AbstractThirdPartyReport(org.codehaus.plexus.i18n.I18N i18n,
 DependenciesTool dependenciesTool,
 ThirdPartyTool thirdPartyTool)

Method Details

createThirdPartyDetails

protected abstract Collection<ThirdPartyDetails> createThirdPartyDetails()
                                                                  throws IOException,
ThirdPartyToolException,
org.apache.maven.project.ProjectBuildingException,
org.apache.maven.plugin.MojoFailureException,
org.apache.maven.project.artifact.InvalidDependencyVersionException,
org.apache.maven.artifact.resolver.ArtifactNotFoundException,
org.apache.maven.artifact.resolver.ArtifactResolutionException,
DependenciesToolException,
org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

ThirdPartyToolException

org.apache.maven.project.ProjectBuildingException

org.apache.maven.plugin.MojoFailureException

org.apache.maven.project.artifact.InvalidDependencyVersionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

org.apache.maven.artifact.resolver.ArtifactResolutionException

DependenciesToolException

org.apache.maven.plugin.MojoExecutionException

init

protected void init()
             throws IOException

Method to initialize the mojo before doing any concrete actions. Note: The method is invoked before the

invalid reference

#executeReport()

method.

Throws:

IOException

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getDescription

public String getDescription(Locale locale)

Specified by:

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

getName

public String getName(Locale locale)

Specified by:

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

isIncludeTransitiveDependencies

public boolean isIncludeTransitiveDependencies()

Specified by:

isIncludeTransitiveDependencies in interface MavenProjectDependenciesConfigurator

Returns:

true if should include transitive dependencies, false to include only direct dependencies.

isExcludeTransitiveDependencies

public boolean isExcludeTransitiveDependencies()

Specified by:

isExcludeTransitiveDependencies in interface MavenProjectDependenciesConfigurator

Returns:

true if should exclude transitive dependencies from excluded artifacts, else false.

getArtifactFilters

public ArtifactFilters getArtifactFilters()

Specified by:

getArtifactFilters in interface MavenProjectDependenciesConfigurator

Returns:

ArtifactFilters to apply when processing dependencies

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in interface MavenProjectDependenciesConfigurator

Returns:

true if verbose mode is on, false otherwise.

getArtifactFiltersUrl

public String getArtifactFiltersUrl()

getEncoding

public String getEncoding()