org.apache.maven.plugins.enforcer

Class RequireReleaseDeps

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.AbstractBanDependencies

org.apache.maven.plugins.enforcer.RequireReleaseDeps

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

public class RequireReleaseDeps
extends AbstractBanDependencies

This rule checks that no snapshots are included.

Author:

Brian Fox

Constructor Summary

Constructors

Constructor and Description
RequireReleaseDeps()

Method Summary

Modifier and Type	Method and Description
protected 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(EnforcerRuleHelper helper) This is the interface into the rule.
protected Set<org.apache.maven.artifact.Artifact>	filterArtifacts(Set<org.apache.maven.artifact.Artifact> dependencies)
List<String>	getExcludes()
List<String>	getIncludes()
boolean	isFailWhenParentIsSnapshot()
boolean	isOnlyWhenRelease()
void	setExcludes(List<String> excludes)
void	setFailWhenParentIsSnapshot(boolean failWhenParentIsSnapshot)
void	setIncludes(List<String> includes)
void	setOnlyWhenRelease(boolean onlyWhenRelease)

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

getDependenciesToCheck, getErrorMessage, isSearchTransitive, setSearchTransitive

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

getCacheId, isCacheable, isResultValid

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

getLevel, getMessage, setLevel, setMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

RequireReleaseDeps

public RequireReleaseDeps()

Method Detail

execute

public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException

Description copied from interface: EnforcerRule

This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag if it should stop or just log the message as a warning.

Specified by:

execute in interface EnforcerRule

Overrides:

execute in class AbstractBanDependencies

Parameters:

helper - The helper provides access to the log, MavenSession and has helpers to get common components. It is also able to lookup components by class name.

Throws:

EnforcerRuleException - the enforcer rule exception

checkDependencies

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

Description copied from class: AbstractBanDependencies

Checks the set of dependencies against the list of excludes.

Specified by:

checkDependencies in class AbstractBanDependencies

Parameters:

dependencies - the dependencies

log - the log

Returns:

the sets the

Throws:

EnforcerRuleException - the enforcer rule exception

filterArtifacts

protected Set<org.apache.maven.artifact.Artifact> filterArtifacts(Set<org.apache.maven.artifact.Artifact> dependencies)
                                                           throws EnforcerRuleException

Throws:

EnforcerRuleException

isOnlyWhenRelease

public final boolean isOnlyWhenRelease()

setOnlyWhenRelease

public final void setOnlyWhenRelease(boolean onlyWhenRelease)

isFailWhenParentIsSnapshot

public final boolean isFailWhenParentIsSnapshot()

setFailWhenParentIsSnapshot

public final void setFailWhenParentIsSnapshot(boolean failWhenParentIsSnapshot)

setExcludes

public final void setExcludes(List<String> excludes)

getExcludes

public final List<String> getExcludes()

setIncludes

public void setIncludes(List<String> includes)

getIncludes

public List<String> getIncludes()