Package org.apache.maven.plugins.enforcer

Class RestrictImports

java.lang.Object

org.apache.maven.plugins.enforcer.BannedImportGroupDefinition

org.apache.maven.plugins.enforcer.RestrictImports

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule, org.apache.maven.enforcer.rule.api.EnforcerRule2

public class RestrictImports
extends BannedImportGroupDefinition
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 Summary

Constructors

Constructor	Description
RestrictImports()

Method Summary

Modifier and Type	Method	Description
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
String	getCacheId()
org.apache.maven.enforcer.rule.api.EnforcerLevel	getLevel()
boolean	isCacheable()
boolean	isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule rule)
void	setAllowedImport(String allowedImport)
void	setAllowedImports(List<String> allowedImports)
void	setBannedImport(String bannedImport)
void	setBannedImports(List<String> bannedPackages)
void	setBasePackage(String basePackage)
void	setBasePackages(List<String> basePackages)
void	setExcludedSourceRoot(File excludedSourceRoot)
void	setExcludedSourceRoots(List<File> excludedSourceRoots)
void	setExclusion(String exclusion)
void	setExclusions(List<String> exclusions)
void	setFailBuild(boolean failBuild)
void	setGroups(List<BannedImportGroupDefinition> groups)
void	setIncludeCompileCode(boolean includeCompileCode)
void	setIncludeTestCode(boolean includeTestCode)
void	setParallel(boolean parallel)
void	setParseFullCompilationUnit(boolean parseFullCompilationUnit)
void	setReason(String reason)
void	setSkip(boolean skip)

Methods inherited from class org.apache.maven.plugins.enforcer.BannedImportGroupDefinition

createGroupFromPluginConfiguration, hasInput

Methods inherited from class java.lang.Object

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

Constructor Detail

RestrictImports

public RestrictImports()

Method Detail

getLevel

public org.apache.maven.enforcer.rule.api.EnforcerLevel getLevel()

Specified by:

getLevel in interface org.apache.maven.enforcer.rule.api.EnforcerRule2

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)

Overrides:

setBasePackage in class BannedImportGroupDefinition

setBasePackages

public void setBasePackages(List<String> basePackages)

Overrides:

setBasePackages in class BannedImportGroupDefinition

setBannedImport

public void setBannedImport(String bannedImport)

Overrides:

setBannedImport in class BannedImportGroupDefinition

setBannedImports

public void setBannedImports(List<String> bannedPackages)

Overrides:

setBannedImports in class BannedImportGroupDefinition

setAllowedImport

public void setAllowedImport(String allowedImport)

Overrides:

setAllowedImport in class BannedImportGroupDefinition

setAllowedImports

public void setAllowedImports(List<String> allowedImports)

Overrides:

setAllowedImports in class BannedImportGroupDefinition

setExclusion

public void setExclusion(String exclusion)

Overrides:

setExclusion in class BannedImportGroupDefinition

setExclusions

public void setExclusions(List<String> exclusions)

Overrides:

setExclusions in class BannedImportGroupDefinition

setReason

public void setReason(String reason)

Overrides:

setReason in class BannedImportGroupDefinition

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)

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