com.puresoltechnologies.maven.plugins.license

Class AbstractValidationMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ReportMojo, ValidatorMojo

public abstract class AbstractValidationMojo
extends org.apache.maven.plugin.AbstractMojo

This abstract class provides basic functionality for all license validations.

Author:

Rick-Rainer Ludwig

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractValidationMojo()

Method Summary

Modifier and Type	Method and Description
protected Set<org.apache.maven.artifact.Artifact>	getArtifacts(boolean recursive) This method retrieves all artifacts of the current Maven module.
protected org.apache.maven.project.MavenProject	getMavenProject() This method returns the current MavenProject.
protected org.apache.maven.project.MavenProjectBuilder	getProjectBuilder() This method returns a MavenProjectBuilder.
protected DependencyTree	loadArtifacts(boolean recursive, boolean skipTestScope, boolean skipProvidedScope, boolean skipOptionals) This method retrieves all artifacts of the current Maven module.

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.plugin.Mojo

execute

Constructor Detail

AbstractValidationMojo

public AbstractValidationMojo()

Method Detail

getMavenProject

protected final org.apache.maven.project.MavenProject getMavenProject()

This method returns the current MavenProject.

Returns:

A MavenProject object is returned referencing the current Maven project.

getProjectBuilder

protected final org.apache.maven.project.MavenProjectBuilder getProjectBuilder()

This method returns a MavenProjectBuilder.

Returns:

A MavenProjectBuilder is returned.

getArtifacts

protected Set<org.apache.maven.artifact.Artifact> getArtifacts(boolean recursive)

This method retrieves all artifacts of the current Maven module. Attention(!): This method uses MavenProject.getDependencyArtifacts() and MavenProject.getArtifacts() which are lazily filled with the artifacts.

Returns:

A Set of Artifact is returned containing the artifacts found.

loadArtifacts

protected DependencyTree loadArtifacts(boolean recursive,
                                       boolean skipTestScope,
                                       boolean skipProvidedScope,
                                       boolean skipOptionals)
                                throws org.apache.maven.plugin.MojoExecutionException

This method retrieves all artifacts of the current Maven module.

Parameters:

recursive - is to be set to true is the dependencies shall be loaded recursively. false is set if wanted otherwise.

skipTestScope - is to be set to true is artifacts in test scope are to be skipped and neglected. false is set if wanted otherwise.

skipProvidedScope - is to be set to true if artifacts in provided scope are to be skipped and neglected. false is set if wanted otherwise.

skipOptionals - is to be set to true if artifacts in optional scope are to be skipped and neglected. false is set if wanted otherwise.

Returns:

A DependencyTree is returned containing the artifacts found.

Throws:

org.apache.maven.plugin.MojoExecutionException - is thrown in cases of issues.