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

Class AvoidStarImportCheck

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.AvoidStarImportCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class AvoidStarImportCheck extends AbstractCheck
Checks that there are no import statements that use the * notation.

Rationale: Importing all classes from a package or static members from a class leads to tight coupling between packages or classes and might lead to problems when a new version of a library introduces name clashes.

Notes: Note that property excludes is not recursive, subpackages of excluded packages are not automatically excluded.

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:

    • MSG_COUNT

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

    • STAR_IMPORT_SUFFIX

      private static final String STAR_IMPORT_SUFFIX
      Suffix for the star import.
      See Also:

    • excludes

      private final Set<String> excludes
      Specify packages where starred class imports are allowed and classes where starred static member imports are allowed.

    • allowClassImports

      private boolean allowClassImports
      Control whether to allow starred class imports like import java.util.*;.

    • allowStaticMemberImports

      private boolean allowStaticMemberImports
      Control whether to allow starred static member imports like import static org.junit.Assert.*;.

    • maxAllowedStarImports

      private int maxAllowedStarImports
      Maximum number of allowed star imports.

    • currentStarImportsCount

      private int currentStarImportsCount
      Counter for used star imports.

  • Constructor Details

  • Method Details

    • 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:

    • setExcludes

      public void setExcludes(String... excludesParam)
      Setter to specify packages where starred class imports are allowed and classes where starred static member imports are allowed.
      Parameters:
      excludesParam - package names/fully-qualifies class names where star imports are ok
      Since:
      3.2

    • setAllowClassImports

      public void setAllowClassImports(boolean allow)
      Setter to control whether to allow starred class imports like import java.util.*;.
      Parameters:
      allow - true to allow false to disallow
      Since:
      5.3

    • setAllowStaticMemberImports

      public void setAllowStaticMemberImports(boolean allow)
      Setter to control whether to allow starred static member imports like import static org.junit.Assert.*;.
      Parameters:
      allow - true to allow false to disallow
      Since:
      5.3

    • setMaxAllowedStarImports

      public void setMaxAllowedStarImports(int count)
      Setter to control how many star imports are allowed.
      Parameters:
      count - the number of star imports allowed
      Since:
      13.5.0

    • beginTree

      public void beginTree(DetailAST rootAST)
      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 class AbstractCheck
      Parameters:
      rootAST - the root of the tree

    • 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

    • logsStarredImportViolation

      private void logsStarredImportViolation(DetailAST startingDot)
      Gets the full import identifier. If the import is a starred import and it's not excluded then a violation is logged.
      Parameters:
      startingDot - the starting dot for the import statement