public class AvoidStarImportCheck extends Check
Check that finds import statements that use the * notation.
Rationale: Importing all classes from a package leads to tight coupling between packages and might lead to problems when a new version of a library introduces name clashes.
An example of how to configure the check is:
<module name="AvoidStarImport"> <property name="excludes" value="java.io,java.net"/> </module>The optional "excludes" property allows for certain packages like java.io or java.net to be exempted from the rule. Note that the excludes property is not recursive, subpackages of excluded packages are not automatically excluded. Compatible with Java 1.5 source.
Constructor and Description |
---|
AvoidStarImportCheck() |
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
setExcludes(String[] aExcludes)
Sets the list of packages to exempt from the check.
|
void |
visitToken(DetailAST aAST)
Called to process a token.
|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public void setExcludes(String[] aExcludes)
aExcludes
- a list of package names where star imports are okpublic void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to process