org.apache.maven.plugins.enforcer

Class AbstractBanDependencies

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.AbstractBanDependencies

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule

Direct Known Subclasses:

BannedDependencies, NoSnapshots, RequireReleaseDeps

public abstract class AbstractBanDependencies
extends AbstractNonCacheableEnforcerRule

Abstract Rule for banning dependencies.

Version:

$Id$

Author:

Brian Fox

Field Summary

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

message

Constructor Summary

Constructors

Constructor and Description
AbstractBanDependencies()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Set<org.apache.maven.artifact.Artifact>	checkDependencies(Set<org.apache.maven.artifact.Artifact> dependencies, org.apache.maven.plugin.logging.Log log) Checks the set of dependencies against the list of excludes.
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Execute the rule.
protected Set<org.apache.maven.artifact.Artifact>	getDependenciesToCheck(org.apache.maven.project.MavenProject project)
protected CharSequence	getErrorMessage(org.apache.maven.artifact.Artifact artifact)
boolean	isSearchTransitive() Checks if is search transitive.
void	setSearchTransitive(boolean theSearchTransitive) Sets the search transitive.

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

getCacheId, isCacheable, isResultValid

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

getMessage, setMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractBanDependencies

public AbstractBanDependencies()

Method Detail

execute

public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Execute the rule.

Parameters:

helper - the helper

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException - the enforcer rule exception

getErrorMessage

protected CharSequence getErrorMessage(org.apache.maven.artifact.Artifact artifact)

getDependenciesToCheck

protected Set<org.apache.maven.artifact.Artifact> getDependenciesToCheck(org.apache.maven.project.MavenProject project)

checkDependencies

protected abstract Set<org.apache.maven.artifact.Artifact> checkDependencies(Set<org.apache.maven.artifact.Artifact> dependencies,
                                                        org.apache.maven.plugin.logging.Log log)
                                                                      throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Checks the set of dependencies against the list of excludes.

Parameters:

dependencies - the dependencies

log - the log

Returns:

the sets the

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException - the enforcer rule exception

isSearchTransitive

public boolean isSearchTransitive()

Checks if is search transitive.

Returns:

the searchTransitive

setSearchTransitive

public void setSearchTransitive(boolean theSearchTransitive)

Sets the search transitive.

Parameters:

theSearchTransitive - the searchTransitive to set