Class RequireUpperBoundDeps

java.lang.Object

org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase

org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule

org.apache.maven.enforcer.rules.dependency.RequireUpperBoundDeps

All Implemented Interfaces:

EnforcerRuleBase

@Named("requireUpperBoundDeps")
public final class RequireUpperBoundDeps
extends AbstractStandardEnforcerRule

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

Since:

1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RequireUpperBoundDeps.DependencyNodeHopCountPair
private static class	RequireUpperBoundDeps.RequireUpperBoundDepsVisitor

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	excludedScopes	Scope to exclude.
private List<String>	excludes	Dependencies to ignore.
private List<String>	includes	Dependencies to include.
private final ResolverUtil	resolverUtil
private boolean	uniqueVersions
private RequireUpperBoundDeps.RequireUpperBoundDepsVisitor	upperBoundDepsVisitor

Constructor Summary

Constructors

Constructor	Description
RequireUpperBoundDeps(ResolverUtil resolverUtil)

Method Summary

Modifier and Type	Method	Description
private String	buildErrorMessage(List<org.eclipse.aether.graph.DependencyNode> conflict)
private List<String>	buildErrorMessages(List<List<org.eclipse.aether.graph.DependencyNode>> conflicts)
private StringBuilder	buildTreeString(org.eclipse.aether.graph.DependencyNode node)
void	execute()	This is the interface into the rule.
private String	getFullArtifactName(org.eclipse.aether.graph.DependencyNode node, boolean usePremanaged)
void	setExcludes(List<String> excludes)	Sets dependencies to exclude.
void	setIncludes(List<String> includes)	Sets dependencies to include.

Methods inherited from class AbstractStandardEnforcerRule

formatLocation, getMessage, setMessage

Methods inherited from class AbstractEnforcerRule

getCacheId, getLevel, getRuleName

Methods inherited from class AbstractEnforcerRuleBase

getLog, setLog

Methods inherited from class Object

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

Field Details

uniqueVersions

private boolean uniqueVersions

Since:

1.3

excludes

private List<String> excludes

Dependencies to ignore.

Since:

TBD

includes

private List<String> includes

Dependencies to include.

Since:

3.0.0

excludedScopes

private List<String> excludedScopes

Scope to exclude.

upperBoundDepsVisitor

private RequireUpperBoundDeps.RequireUpperBoundDepsVisitor upperBoundDepsVisitor

resolverUtil

private final ResolverUtil resolverUtil

Constructor Details

RequireUpperBoundDeps

@Inject
public RequireUpperBoundDeps(ResolverUtil resolverUtil)

Method Details

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()
             throws EnforcerRuleException

Description copied from class: AbstractEnforcerRule

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 and rule level if it should stop or just log the message as a warning.

Specified by:

execute in class AbstractEnforcerRule

Throws:

EnforcerRuleException - the enforcer rule exception

buildErrorMessages

private List<String> buildErrorMessages(List<List<org.eclipse.aether.graph.DependencyNode>> conflicts)

buildErrorMessage

private String buildErrorMessage(List<org.eclipse.aether.graph.DependencyNode> conflict)

buildTreeString

private StringBuilder buildTreeString(org.eclipse.aether.graph.DependencyNode node)

getFullArtifactName

private String getFullArtifactName(org.eclipse.aether.graph.DependencyNode node,
 boolean usePremanaged)