public abstract class AbstractClassCouplingCheck extends AbstractCheck
Modifier and Type | Class and Description |
---|---|
private class |
AbstractClassCouplingCheck.ClassContext
Encapsulates information about class coupling.
|
private class |
AbstractClassCouplingCheck.FileContext
Encapsulates information about classes coupling inside single file.
|
Modifier and Type | Field and Description |
---|---|
private static java.util.Set<java.lang.String> |
DEFAULT_EXCLUDED_CLASSES
Class names to ignore.
|
private static java.util.Set<java.lang.String> |
DEFAULT_EXCLUDED_PACKAGES
Package names to ignore.
|
private static java.lang.String |
DOT
A package separator - "."
|
private java.util.List<java.util.regex.Pattern> |
excludeClassesRegexps
User-configured regular expressions to ignore classes.
|
private java.util.Set<java.lang.String> |
excludedClasses
User-configured class names to ignore.
|
private java.util.Set<java.lang.String> |
excludedPackages
User-configured package names to ignore.
|
private AbstractClassCouplingCheck.FileContext |
fileContext
Current file context.
|
private int |
max
Allowed complexity.
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractClassCouplingCheck(int defaultMax)
Creates new instance of the check.
|
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST ast)
Called before the starting to process a tree.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
protected abstract java.lang.String |
getLogMessageId()
Returns message key we use for log violations.
|
int |
getMax()
Returns allowed complexity.
|
private void |
leaveClassDef()
Restores previous context.
|
void |
leaveToken(DetailAST ast)
Called after all the child nodes have been process.
|
void |
setExcludeClassesRegexps(java.lang.String... from)
Sets user-excluded regular expression of classes to ignore.
|
void |
setExcludedClasses(java.lang.String... excludedClasses)
Sets user-excluded classes to ignore.
|
void |
setExcludedPackages(java.lang.String... excludedPackages)
Sets user-excluded pakcages to ignore.
|
void |
setMax(int max)
Sets maximum allowed complexity.
|
private void |
visitClassDef(DetailAST classDef)
Creates new context for a given class.
|
private void |
visitPackageDef(DetailAST pkg)
Stores package of current class we check.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
private static final java.lang.String DOT
private static final java.util.Set<java.lang.String> DEFAULT_EXCLUDED_CLASSES
private static final java.util.Set<java.lang.String> DEFAULT_EXCLUDED_PACKAGES
private final java.util.List<java.util.regex.Pattern> excludeClassesRegexps
private java.util.Set<java.lang.String> excludedClasses
private java.util.Set<java.lang.String> excludedPackages
private int max
private AbstractClassCouplingCheck.FileContext fileContext
protected AbstractClassCouplingCheck(int defaultMax)
defaultMax
- default value for allowed complexity.protected abstract java.lang.String getLogMessageId()
public final int[] getDefaultTokens()
AbstractCheck
getDefaultTokens
in class AbstractCheck
TokenTypes
public final int getMax()
public final void setMax(int max)
max
- allowed complexity.public final void setExcludedClasses(java.lang.String... excludedClasses)
excludedClasses
- the list of classes to ignore.public void setExcludeClassesRegexps(java.lang.String... from)
from
- array representing regular expressions of classes to ignore.public final void setExcludedPackages(java.lang.String... excludedPackages)
excludedPackages
- the list of packages to ignore.public final void beginTree(DetailAST ast)
AbstractCheck
beginTree
in class AbstractCheck
ast
- the root of the treepublic void visitToken(DetailAST ast)
AbstractCheck
visitToken
in class AbstractCheck
ast
- the token to processpublic void leaveToken(DetailAST ast)
AbstractCheck
leaveToken
in class AbstractCheck
ast
- the token leavingprivate void visitPackageDef(DetailAST pkg)
pkg
- package definition.private void visitClassDef(DetailAST classDef)
classDef
- class definition node.private void leaveClassDef()