Package de.skuzzle.enforcer.restrictimports.rule

Class RestrictImports

java.lang.Object

de.skuzzle.enforcer.restrictimports.rule.RestrictImports

All Implemented Interfaces:

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

Direct Known Subclasses:

RestrictImports

public class RestrictImports
extends Object
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	Description
RestrictImports()

Method Summary

Modifier and Type	Method	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)
void	setExclusion(String exclusion)
void	setExclusions(List<String> exclusions)
void	setIncludeTestCode(boolean includeTestCode)
void	setReason(String reason)
void	setSourceFileCharset(String sourceFileCharset)

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

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

setBasePackage

public final void setBasePackage(String basePackage)

setBasePackages

public final void setBasePackages(List<String> basePackages)

setBannedImport

public void setBannedImport(String bannedImport)

setBannedImports

public final void setBannedImports(List<String> bannedPackages)

setAllowedImport

public final void setAllowedImport(String allowedImport)

setAllowedImports

public final void setAllowedImports(List<String> allowedImports)

setExclusion

public final void setExclusion(String exclusion)

setExclusions

public final void setExclusions(List<String> exclusions)

setIncludeTestCode

public final void setIncludeTestCode(boolean includeTestCode)

setReason

public final void setReason(String reason)

setCommentLineBufferSize

public final void setCommentLineBufferSize(int commentLineBufferSize)

setSourceFileCharset

public final void setSourceFileCharset(String sourceFileCharset)