de.skuzzle.enforcer.restrictimports.rule

Class RestrictImports

java.lang.Object

de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

de.skuzzle.enforcer.restrictimports.rule.RestrictImports

All Implemented Interfaces:

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

Direct Known Subclasses:

RestrictImports

public class RestrictImports
extends BannedImportGroupDefinition
implements org.apache.maven.enforcer.rule.api.EnforcerRule

Enforcer rule which restricts the usage of certain packages or classes within a Java code base.

Constructor Summary

Constructors

Constructor and Description
RestrictImports()

Method Summary

Modifier and Type	Method and Description
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
String	getCacheId()
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	setCommentLineBufferSize(int commentLineBufferSize) Deprecated.
void	setExclusion(String exclusion)
void	setExclusions(List<String> exclusions)
void	setFailBuild(boolean failBuild)
void	setGroups(List<BannedImportGroupDefinition> groups)
void	setIncludeTestCode(boolean includeTestCode)
void	setReason(String reason)
void	setSkip(boolean skip)

Methods inherited from class de.skuzzle.enforcer.restrictimports.rule.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

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

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)

setIncludeTestCode

public final void setIncludeTestCode(boolean includeTestCode)

setCommentLineBufferSize

@Deprecated
public final void setCommentLineBufferSize(int commentLineBufferSize)

Deprecated.

setFailBuild

public void setFailBuild(boolean failBuild)

setSkip

public void setSkip(boolean skip)

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