Package com.puppycrawl.tools.checkstyle.checks.imports

Class IllegalImportCheck

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.IllegalImportCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class IllegalImportCheck extends AbstractCheck
Checks for imports from a set of illegal packages.

Note: By default, the check rejects all sun.* packages since programs that contain direct calls to the sun.* packages are "not guaranteed to work on all Java-compatible platforms". To reject other packages, set property illegalPkgs to a list of the illegal packages.

  • Property illegalClasses - Specify class names to reject, if regexp property is not set, checks if import equals class name. If regexp property is set, then list of class names will be interpreted as regular expressions. Note, all properties for match will be used. Type is java.lang.String[]. Default value is "".
  • Property illegalPkgs - Specify packages to reject, if regexp property is not set, checks if import is the part of package. If regexp property is set, then list of packages will be interpreted as regular expressions. Note, all properties for match will be used. Type is java.lang.String[]. Default value is sun.
  • Property regexp - Control whether the illegalPkgs and illegalClasses should be interpreted as regular expressions. Type is boolean. Default value is false.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • import.illegal
Since:
3.0

  • Field Details

    • MSG_KEY

      public static final String MSG_KEY
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

    • illegalPkgsRegexps

      private final List<Pattern> illegalPkgsRegexps
      The compiled regular expressions for packages.

    • illegalClassesRegexps

      private final List<Pattern> illegalClassesRegexps
      The compiled regular expressions for classes.

    • illegalPkgs

      private String[] illegalPkgs
      Specify packages to reject, if regexp property is not set, checks if import is the part of package. If regexp property is set, then list of packages will be interpreted as regular expressions. Note, all properties for match will be used.

    • illegalClasses

      private String[] illegalClasses
      Specify class names to reject, if regexp property is not set, checks if import equals class name. If regexp property is set, then list of class names will be interpreted as regular expressions. Note, all properties for match will be used.

    • regexp

      private boolean regexp
      Control whether the illegalPkgs and illegalClasses should be interpreted as regular expressions.

  • Constructor Details

    • IllegalImportCheck

      public IllegalImportCheck()
      Creates a new IllegalImportCheck instance.

  • Method Details

    • setIllegalPkgs

      public final void setIllegalPkgs(String... from)
      Setter to specify packages to reject, if regexp property is not set, checks if import is the part of package. If regexp property is set, then list of packages will be interpreted as regular expressions. Note, all properties for match will be used.
      Parameters:
      from - illegal packages
      Since:
      3.0

    • setIllegalClasses

      public void setIllegalClasses(String... from)
      Setter to specify class names to reject, if regexp property is not set, checks if import equals class name. If regexp property is set, then list of class names will be interpreted as regular expressions. Note, all properties for match will be used.
      Parameters:
      from - illegal classes
      Since:
      7.8

    • setRegexp

      public void setRegexp(boolean regexp)
      Setter to control whether the illegalPkgs and illegalClasses should be interpreted as regular expressions.
      Parameters:
      regexp - a Boolean value
      Since:
      7.8

    • 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 class AbstractCheck
      Returns:
      the default tokens
      See Also:

    • 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 class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:

    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process

    • isIllegalImportByRegularExpressions

      private boolean isIllegalImportByRegularExpressions(String importText)
      Checks if an import matches one of the regular expressions for illegal packages or illegal class names.
      Parameters:
      importText - the argument of the import keyword
      Returns:
      if importText matches one of the regular expressions for illegal packages or illegal class names

    • isIllegalImportByPackagesAndClassNames

      private boolean isIllegalImportByPackagesAndClassNames(String importText)
      Checks if an import is from a package or class name that must not be used.
      Parameters:
      importText - the argument of the import keyword
      Returns:
      if importText contains an illegal package prefix or equals illegal class name

    • isIllegalImport

      private boolean isIllegalImport(String importText)
      Checks if an import is from a package or class name that must not be used.
      Parameters:
      importText - the argument of the import keyword
      Returns:
      if importText is illegal import