Package org.apache.maven.enforcer.rules.dependency

Class 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 Details

    • BannedDependencies

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

  • Method Details

    • 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 String getErrorMessage()
      Specified by:
      getErrorMessage in class BannedDependenciesBase

    • toString

      public String toString()
      Overrides:
      toString in class Object