Class AvoidStaticImportCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class AvoidStaticImportCheck extends AbstractCheck
Checks that there are no static import statements.
Rationale: Importing static members can lead to naming conflicts between class' members. It may lead to poor code readability since it may no longer be clear what class a member resides in (without looking at the import statement).
If you exclude a starred import on a class this automatically excludes each member individually.
For example: Excluding
java.lang.Math.*
. will allow the import of each static member in the Math class individually likejava.lang.Math.PI, java.lang.Math.cos, ...
.-
Property
excludes
- Control whether to allow for certain classes via a star notation to be excluded such asjava.lang.Math.*
or specific static members to be excluded likejava.lang.System.out
for a variable orjava.lang.Math.random
for a method. See notes section for details. Type isjava.lang.String[]
. Default value is""
.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
import.avoidStatic
- Since:
- 5.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private String[]
excludes
Control whether to allow for certain classes via a star notation to be excluded such asjava.lang.Math.*
or specific static members to be excluded likejava.lang.System.out
for a variable orjava.lang.Math.random
for a method.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description AvoidStaticImportCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.int[]
getRequiredTokens()
The tokens that this check must be registered for.private boolean
isExempt(String classOrStaticMember)
Checks if a class or static member is exempt from known excludes.private static boolean
isStarImportOfPackage(String classOrStaticMember, String exclude)
Returns true if classOrStaticMember is a starred name of package, not just member name.void
setExcludes(String... excludes)
Setter to control whether to allow for certain classes via a star notation to be excluded such asjava.lang.Math.*
or specific static members to be excluded likejava.lang.System.out
for a variable orjava.lang.Math.random
for a method.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_KEY
public static final String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AvoidStaticImportCheck
public AvoidStaticImportCheck()
-
-
Method Detail
-
getDefaultTokens
public int[] getDefaultTokens()
Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
TokenTypes
-
getAcceptableTokens
public int[] getAcceptableTokens()
Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
getRequiredTokens
public int[] getRequiredTokens()
Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
setExcludes
public void setExcludes(String... excludes)
Setter to control whether to allow for certain classes via a star notation to be excluded such asjava.lang.Math.*
or specific static members to be excluded likejava.lang.System.out
for a variable orjava.lang.Math.random
for a method. See notes section for details.- Parameters:
excludes
- fully-qualified class names/specific static members where static imports are ok- Since:
- 5.0
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
isExempt
private boolean isExempt(String classOrStaticMember)
Checks if a class or static member is exempt from known excludes.- Parameters:
classOrStaticMember
- the class or static member- Returns:
- true if except false if not
-
isStarImportOfPackage
private static boolean isStarImportOfPackage(String classOrStaticMember, String exclude)
Returns true if classOrStaticMember is a starred name of package, not just member name.- Parameters:
classOrStaticMember
- - full name of memberexclude
- - current exclusion- Returns:
- true if member in exclusion list
-
-