Class RedundantImportCheck
- 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.RedundantImportCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class RedundantImportCheck extends AbstractCheck
Checks for redundant import statements. An import statement is considered redundant if:
- It is a duplicate of another import. This is, when a class is imported more than once.
- The class non-statically imported is from the
java.lang
package, e.g. importingjava.lang.String
. - The class non-statically imported is from the same package as the current package.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
import.duplicate
-
import.lang
-
import.same
- Since:
- 3.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 Set<FullIdent>
imports
Set of the imports.static String
MSG_DUPLICATE
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_LANG
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_SAME
A key is pointing to the warning message text in "messages.properties" file.private String
pkgName
Name of package in file.private Set<FullIdent>
staticImports
Set of static imports.
-
Constructor Summary
Constructors Constructor Description RedundantImportCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST aRootAST)
Called before the starting to process a tree.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 static boolean
isFromPackage(String importName, String pkg)
Determines if an import statement is for types from a specified package.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
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_LANG
public static final String MSG_LANG
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_SAME
public static final String MSG_SAME
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_DUPLICATE
public static final String MSG_DUPLICATE
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
staticImports
private final Set<FullIdent> staticImports
Set of static imports.
-
-
Constructor Detail
-
RedundantImportCheck
public RedundantImportCheck()
-
-
Method Detail
-
beginTree
public void beginTree(DetailAST aRootAST)
Description copied from class:AbstractCheck
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Overrides:
beginTree
in classAbstractCheck
- Parameters:
aRootAST
- the root of the tree
-
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
-
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
-
isFromPackage
private static boolean isFromPackage(String importName, String pkg)
Determines if an import statement is for types from a specified package.- Parameters:
importName
- the import namepkg
- the package name- Returns:
- whether from the package
-
-