org.apache.maven.plugins.enforcer

Class RequireUpperBoundDeps

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.RequireUpperBoundDeps

All Implemented Interfaces:

EnforcerRule, EnforcerRule2

public class RequireUpperBoundDeps
extends AbstractNonCacheableEnforcerRule

Rule to enforce that the resolved dependency is also the most recent one of all transitive dependencies.

Since:

1.1

Author:

Geoffrey De Smet

Constructor Summary

Constructors

Constructor and Description
RequireUpperBoundDeps()

Method Summary

Modifier and Type	Method and Description
void	execute(EnforcerRuleHelper helper) This is the interface into the rule.
void	setExcludes(List<String> excludes) Sets dependencies to exclude.
void	setIncludes(List<String> includes) Sets dependencies to include.
void	setUniqueVersions(boolean uniqueVersions) Set to true if timestamped snapshots should be used.

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

RequireUpperBoundDeps

public RequireUpperBoundDeps()

Method Detail

setUniqueVersions

public void setUniqueVersions(boolean uniqueVersions)

Set to true if timestamped snapshots should be used.

Parameters:

uniqueVersions -

Since:

1.3

setExcludes

public void setExcludes(List<String> excludes)

Sets dependencies to exclude.

Parameters:

excludes - a list of groupId:artifactId names

setIncludes

public void setIncludes(List<String> includes)

Sets dependencies to include.

Parameters:

includes - a list of groupId:artifactId names

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.

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