Class IllegalImportCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class IllegalImportCheck extends AbstractCheck
Checks for imports from a set of illegal packages. By default, the check rejects all
sun.*
packages since programs that contain direct calls to thesun.*
packages are not 100% Pure Java.To reject other packages, set property illegalPkgs to a comma-separated list of the illegal packages.
An example of how to configure the check is:
<module name="IllegalImport"/>
An example of how to configure the check so that it rejects packages
java.io.*
andjava.sql.*
is<module name="IllegalImport"> <property name="illegalPkgs" value="java.io, java.sql"/> </module> Compatible with Java 1.5 source.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Constructor Summary
Constructors Constructor Description IllegalImportCheck()
Creates a newIllegalImportCheck
instance.
-
Method Summary
All 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.void
setIllegalClasses(String... from)
Set the list of illegal classes.void
setIllegalPkgs(String... from)
Set the list of illegal packages.void
setRegexp(boolean regexp)
Controls whether the packages or class names should be interpreted as regular expressions.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, 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.api.AutomaticBean
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
-
-
Method Detail
-
setIllegalPkgs
public final void setIllegalPkgs(String... from)
Set the list of illegal packages.- Parameters:
from
- array of illegal packages
-
setIllegalClasses
public void setIllegalClasses(String... from)
Set the list of illegal classes.- Parameters:
from
- array of illegal classes
-
setRegexp
public void setRegexp(boolean regexp)
Controls whether the packages or class names should be interpreted as regular expressions.- Parameters:
regexp
- aBoolean
value
-
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
-
-