org.codehaus.mojo.license

Class AbstractDownloadLicensesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractDownloadLicensesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, MavenProjectDependenciesConfigurator

Direct Known Subclasses:

AggregateDownloadLicensesMojo, DownloadLicensesMojo

public abstract class AbstractDownloadLicensesMojo
extends org.apache.maven.plugin.AbstractMojo
implements MavenProjectDependenciesConfigurator

Created on 23/05/16.

Author:

Tony Chemit - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	LICENSE_MAP_KEY
protected boolean	organizeLicensesByDependencies A flag to organize the licenses by dependencies.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDownloadLicensesMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected abstract SortedMap<String,org.apache.maven.project.MavenProject>	getDependencies()
protected SortedMap<String,org.apache.maven.project.MavenProject>	getDependencies(org.apache.maven.project.MavenProject project)
String	getEncoding()
String	getExcludedArtifacts()
String	getExcludedGroups()
List<String>	getExcludedScopes()
String	getIncludedArtifacts()
String	getIncludedGroups()
List<String>	getIncludedScopes()
protected org.apache.maven.project.MavenProject	getProject()
boolean	isExcludeTransitiveDependencies()
boolean	isIncludeTransitiveDependencies()
protected abstract boolean	isSkip()
boolean	isSkipAll()
boolean	isVerbose()
void	setExcludedScopes(String excludedScopes)

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

Field Detail

LICENSE_MAP_KEY

public static final String LICENSE_MAP_KEY

See Also:

Constant Field Values

organizeLicensesByDependencies

@Parameter(property="license.organizeLicensesByDependencies",
           defaultValue="false")
protected boolean organizeLicensesByDependencies

A flag to organize the licenses by dependencies. When this is done, each dependency will get its full license file, even if already downloaded for another dependency.

Since:

1.9

Constructor Detail

AbstractDownloadLicensesMojo

public AbstractDownloadLicensesMojo()

Method Detail

isSkip

protected abstract boolean isSkip()

isSkipAll

public final boolean isSkipAll()

getProject

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

getEncoding

public String getEncoding()

getDependencies

protected abstract SortedMap<String,org.apache.maven.project.MavenProject> getDependencies()

getDependencies

protected SortedMap<String,org.apache.maven.project.MavenProject> getDependencies(org.apache.maven.project.MavenProject project)

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

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.

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.

setExcludedScopes

public void setExcludedScopes(String excludedScopes)

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.

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.

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.

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.

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.

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in interface MavenProjectDependenciesConfigurator

Returns:

true if verbose mode is on, false otherwise.