org.codehaus.mojo.license

Class ThirdPartyReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.license.AbstractLicenseReportMojo

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",
      requiresProject=true,
      requiresDependencyResolution=RUNTIME)
public class ThirdPartyReportMojo
extends AbstractLicenseReportMojo
implements MavenProjectDependenciesConfigurator

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

Since:

1.1

Author:

tchemit

Field Summary

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

Methods

Modifier and Type	Method and Description
protected void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) Generates the report.
String	getExcludedArtifacts()
String	getExcludedGroups()
List<String>	getExcludedScopes()
String	getIncludedArtifacts()
String	getIncludedGroups()
List<String>	getIncludedScopes()
String	getOutputName()
boolean	isIncludeTransitiveDependencies()
boolean	isSkip() When is sets to true, will skip execution.

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

executeReport, getDescription, getEncoding, getHelper, getI18n, getName, getOutputDirectory, getProject, getSiteRenderer, getText, isVerbose

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

canGenerateReport, closeReport, execute, generate, generate, generate, getCategoryName, 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

Methods inherited from interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator

isVerbose

Constructor Detail

ThirdPartyReportMojo

public ThirdPartyReportMojo()

Method Detail

getOutputName

public String getOutputName()

Specified by:

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

isSkip

public boolean isSkip()

When is sets to true, will skip execution.

This will take effect in at the very begin of the AbstractMavenReport.execute() before any initialisation of goal.

Specified by:

isSkip in class AbstractLicenseReportMojo

Returns:

true if goal will not be executed

doGenerateReport

protected void doGenerateReport(Locale locale,
                    org.apache.maven.doxia.sink.Sink sink)
                         throws org.apache.maven.reporting.MavenReportException,
                                org.apache.maven.plugin.MojoExecutionException,
                                org.apache.maven.plugin.MojoFailureException

Generates the report.

Specified by:

doGenerateReport in class AbstractLicenseReportMojo

Parameters:

locale - the locale to generate the report for.

sink - the report formatting tool.

Throws:

org.apache.maven.reporting.MavenReportException - when things go wrong.

org.apache.maven.plugin.MojoExecutionException - when things go wrong.

org.apache.maven.plugin.MojoFailureException - when things go wrong.

getExcludedScopes

public List<String> getExcludedScopes()

Specified by:

getExcludedScopes in interface MavenProjectDependenciesConfigurator

Returns:

list of scopes to exclude while loading dependencies, if null is setted, then include all scopes.

getIncludedScopes

public List<String> getIncludedScopes()

Specified by:

getIncludedScopes in interface MavenProjectDependenciesConfigurator

Returns:

list of scopes to include while loading dependencies, if null is setted, then include all scopes.

getExcludedGroups

public String getExcludedGroups()

Specified by:

getExcludedGroups in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to exclude dependencies by their artifactId, if null is setted the no exclude is done on artifactId.

getIncludedGroups

public String getIncludedGroups()

Specified by:

getIncludedGroups in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to include dependencies by their groupId, if null is setted then include all artifacts.

getExcludedArtifacts

public String getExcludedArtifacts()

Specified by:

getExcludedArtifacts in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to exclude dependencies by their groupId, if null is setted then no exclude is done on groupId.

getIncludedArtifacts

public String getIncludedArtifacts()

Specified by:

getIncludedArtifacts in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to include dependencies by thier artificatId, if null is setted then include all artifacts.

isIncludeTransitiveDependencies

public boolean isIncludeTransitiveDependencies()

Specified by:

isIncludeTransitiveDependencies in interface MavenProjectDependenciesConfigurator

Returns:

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