BannedDependencies

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.BannedDependenciesBase
      - org.apache.maven.enforcer.rules.dependency.BannedDependencies

All Implemented Interfaces:

EnforcerRuleBase
```
@Named("bannedDependencies")
public final class BannedDependencies
extends BannedDependenciesBase
```
This rule checks that lists of dependencies are not included.

Constructor Summary

Constructors
Constructor Description

BannedDependencies(org.apache.maven.execution.MavenSession session, ResolverUtil resolverUtil)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`getErrorMessage()`
`java.lang.String`	`toString()`
`protected boolean`	`validate(org.apache.maven.artifact.Artifact artifact)`	Validates a dependency artifact if it fulfills the enforcer rule

Methods inherited from class org.apache.maven.enforcer.rules.dependency.BannedDependenciesBase
execute, getExcludes, getIncludes, getSession, isSearchTransitive, setExcludes, setIncludes, setSearchTransitive, validate

Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel

Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BannedDependencies
```
@Inject
BannedDependencies(org.apache.maven.execution.MavenSession session,
                   ResolverUtil resolverUtil)
```
- Method Detail
  - validate
```
protected boolean validate(org.apache.maven.artifact.Artifact artifact)
```
    Description copied from class: BannedDependenciesBase
    
    Validates a dependency artifact if it fulfills the enforcer rule
    
    Specified by:
    
    validate in class BannedDependenciesBase
    
    Parameters:
    
    artifact - dependency to be checked against the list of excludes
    
    Returns:
    
    true if the dependency passes the rule, false if the dependency triggers a validation error
  - getErrorMessage
```
protected java.lang.String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in class BannedDependenciesBase
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object