Package org.apache.maven.plugins.enforcer

Class RestrictImports

java.lang.Object
org.apache.maven.plugins.enforcer.RestrictImports
All Implemented Interfaces:
org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRule2, org.apache.maven.enforcer.rule.api.EnforcerRuleBase
public class RestrictImports extends Object implements org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRule2
Enforcer rule which restricts the usage of certain packages or classes within a Java code base.

  • Constructor Details

    • RestrictImports

      public RestrictImports()

  • Method Details

    • getLevel

      public org.apache.maven.enforcer.rule.api.EnforcerLevel getLevel()
      Specified by:
      getLevel in interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase

    • execute

      public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) throws org.apache.maven.enforcer.rule.api.EnforcerRuleException
      Specified by:
      execute in interface org.apache.maven.enforcer.rule.api.EnforcerRule
      Throws:
      org.apache.maven.enforcer.rule.api.EnforcerRuleException

    • setParseFullCompilationUnit

      public void setParseFullCompilationUnit(boolean parseFullCompilationUnit)

    • setBasePackage

      public void setBasePackage(String basePackage)

    • setBasePackages

      public void setBasePackages(List<String> basePackages)

    • setBannedImport

      public void setBannedImport(String bannedImport)

    • setBannedImports

      public void setBannedImports(List<String> bannedPackages)

    • setAllowedImport

      public void setAllowedImport(String allowedImport)

    • setAllowedImports

      public void setAllowedImports(List<String> allowedImports)

    • setExclusion

      public void setExclusion(String exclusion)

    • setExclusions

      public void setExclusions(List<String> exclusions)

    • setReason

      public void setReason(String reason)

    • setGroups

      public void setGroups(List<BannedImportGroupDefinition> groups)

    • setIncludeCompileCode

      public final void setIncludeCompileCode(boolean includeCompileCode)

    • setIncludeTestCode

      public final void setIncludeTestCode(boolean includeTestCode)

    • setExcludedSourceRoot

      public final void setExcludedSourceRoot(File excludedSourceRoot)

    • setExcludedSourceRoots

      public final void setExcludedSourceRoots(List<File> excludedSourceRoots)

    • setNotFixable

      public void setNotFixable(NotFixableDefinition notFixable)

    • setNotFixables

      public final void setNotFixables(List<NotFixableDefinition> notFixables)

    • setFailBuild

      public void setFailBuild(boolean failBuild)

    • setSkip

      public void setSkip(boolean skip)

    • setParallel

      public void setParallel(boolean parallel)

    • getCacheId

      public String getCacheId()
      Specified by:
      getCacheId in interface org.apache.maven.enforcer.rule.api.EnforcerRule

    • isCacheable

      public boolean isCacheable()
      Specified by:
      isCacheable in interface org.apache.maven.enforcer.rule.api.EnforcerRule

    • isResultValid

      public boolean isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule rule)
      Specified by:
      isResultValid in interface org.apache.maven.enforcer.rule.api.EnforcerRule