Package com.puppycrawl.tools.checkstyle.checks.imports

Class ModuleImportRule

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule

com.puppycrawl.tools.checkstyle.checks.imports.ModuleImportRule

class ModuleImportRule
extends AbstractImportRule

Represents whether a module is allowed to be imported or not.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	moduleName	Module to control access to.

Constructor Summary

Constructors

Constructor	Description
ModuleImportRule(boolean allow, boolean localOnly, String moduleName, boolean regExp)	Constructs an instance.

Method Summary

Modifier and Type	Method	Description
AccessResult	verifyImport(String forImport)	Verifies whether a module name is used.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportRule

calculateResult, isLocalOnly, isRegExp

Methods inherited from class java.lang.Object

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

Field Details

moduleName

private final String moduleName

Module to control access to.

Constructor Details

ModuleImportRule

ModuleImportRule(boolean allow,
 boolean localOnly,
 String moduleName,
 boolean regExp)

Constructs an instance.

Parameters:

allow - whether to allow access.

localOnly - whether the rule is to be applied locally only

moduleName - the module to apply the rule on.

regExp - whether the module name is to be interpreted as a regular expression.

Method Details

verifyImport

public AccessResult verifyImport(String forImport)

Verifies whether a module name is used.

Specified by:

verifyImport in class AbstractImportRule

Parameters:

forImport - the import to check.

Returns:

a result AccessResult indicating whether it can be used.