com.puppycrawl.tools.checkstyle.checks.imports

Class AbstractImportControl

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.imports.AbstractImportControl

Direct Known Subclasses:

FileImportControl, PkgImportControl

abstract class AbstractImportControl
extends java.lang.Object

Represents a tree of import rules for controlling whether packages or classes are allowed to be used. Each instance must have a single parent or be the root node.

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractImportControl	parent The parent.
private java.util.Deque<AbstractImportRule>	rules List of AbstractImportRule objects to check.
private MismatchStrategy	strategyOnMismatch Strategy in a case if matching allow/disallow rule was not found.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImportControl(AbstractImportControl parent, MismatchStrategy strategyOnMismatch) Construct a child node.

Method Summary

Modifier and Type	Method and Description
protected void	addImportRule(AbstractImportRule rule) Adds an AbstractImportRule to the node.
AccessResult	checkAccess(java.lang.String inPkg, java.lang.String inFileName, java.lang.String forImport) Returns whether a package or class is allowed to be imported.
private AccessResult	localCheckAccess(java.lang.String inPkg, java.lang.String inFileName, java.lang.String forImport) Checks whether any of the rules for this node control access to a specified package or file.
abstract AbstractImportControl	locateFinest(java.lang.String forPkg, java.lang.String forFileName) Search down the tree to locate the finest match for a supplied package.
protected abstract boolean	matchesExactly(java.lang.String pkg, java.lang.String fileName) Check for equality of this with pkg.

Methods inherited from class java.lang.Object

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

Field Detail

rules

private final java.util.Deque<AbstractImportRule> rules

List of AbstractImportRule objects to check.

parent

private final AbstractImportControl parent

The parent. Null indicates we are the root node.

strategyOnMismatch

private final MismatchStrategy strategyOnMismatch

Strategy in a case if matching allow/disallow rule was not found.

Constructor Detail

AbstractImportControl

protected AbstractImportControl(AbstractImportControl parent,
                                MismatchStrategy strategyOnMismatch)

Construct a child node.

Parameters:

parent - the parent node.

strategyOnMismatch - strategy in a case if matching allow/disallow rule was not found.

Method Detail

locateFinest

public abstract AbstractImportControl locateFinest(java.lang.String forPkg,
                                                   java.lang.String forFileName)

Search down the tree to locate the finest match for a supplied package.

Parameters:

forPkg - the package to search for.

forFileName - the file name to search for.

Returns:

the finest match, or null if no match at all.

matchesExactly

protected abstract boolean matchesExactly(java.lang.String pkg,
                                          java.lang.String fileName)

Check for equality of this with pkg.

Parameters:

pkg - the package to compare with.

fileName - the file name to compare with.

Returns:

if it matches.

addImportRule

protected void addImportRule(AbstractImportRule rule)

Adds an AbstractImportRule to the node.

Parameters:

rule - the rule to be added.

checkAccess

public AccessResult checkAccess(java.lang.String inPkg,
                                java.lang.String inFileName,
                                java.lang.String forImport)

Returns whether a package or class is allowed to be imported. The algorithm checks with the current node for a result, and if none is found then calls its parent looking for a match. This will recurse looking for match. If there is no clear result then AccessResult.UNKNOWN is returned.

Parameters:

inPkg - the package doing the import.

inFileName - the file name doing the import.

forImport - the import to check on.

Returns:

an AccessResult.

localCheckAccess

private AccessResult localCheckAccess(java.lang.String inPkg,
                                      java.lang.String inFileName,
                                      java.lang.String forImport)

Checks whether any of the rules for this node control access to a specified package or file.

Parameters:

inPkg - the package doing the import.

inFileName - the file name doing the import.

forImport - the import to check on.

Returns:

an AccessResult.