org.codehaus.mojo.license

Class AbstractThirdPartyReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.license.AbstractThirdPartyReportMojo

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:

AggregatorThirdPartyReportMojo, ThirdPartyReportMojo

public abstract class AbstractThirdPartyReportMojo
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 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
AbstractThirdPartyReportMojo()

Method Summary

Modifier and Type	Method and Description
protected abstract Collection<ThirdPartyDetails>	createThirdPartyDetails()
protected void	executeReport(Locale locale)
String	getDescription(Locale locale)
String	getExcludedArtifacts()
String	getExcludedGroups()
List<String>	getExcludedScopes()
String	getIncludedArtifacts()
String	getIncludedGroups()
List<String>	getIncludedScopes()
String	getName(Locale locale)
protected String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isExcludeTransitiveDependencies()
boolean	isIncludeTransitiveDependencies()
boolean	isVerbose()

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

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

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

getOutputName

Constructor Detail

AbstractThirdPartyReportMojo

public AbstractThirdPartyReportMojo()

Method Detail

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

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

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

getProject

protected org.apache.maven.project.MavenProject getProject()

Overrides:

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

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Overrides:

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

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

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.

isExcludeTransitiveDependencies

public boolean isExcludeTransitiveDependencies()

Specified by:

isExcludeTransitiveDependencies in interface MavenProjectDependenciesConfigurator

Returns:

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

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in interface MavenProjectDependenciesConfigurator

Returns:

true if verbose mode is on, false otherwise.