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

Class 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 like java.lang.Math.PI, java.lang.Math.cos, ....

    • Property excludes - Control whether to allow for certain classes via a star notation to be excluded such as java.lang.Math.* or specific static members to be excluded like java.lang.System.out for a variable or java.lang.Math.random for a method. See notes section for details. Type is java.lang.String[]. Default value is "".

    To configure the check: 

     <module name="AvoidStaticImport"/>

    To configure the check so that the java.lang.System.out member and all members from java.lang.Math are allowed: 

     <module name="AvoidStaticImport">
   <property name="excludes" value="java.lang.System.out,java.lang.Math.*"/>
 </module>

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • import.avoidStatic
    Since:
    5.0

    • Field Detail

      • MSG_KEY

        public static final java.lang.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 class AbstractCheck
        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 class AbstractCheck
        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 class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes

      • setExcludes

        public void setExcludes​(java.lang.String... excludes)
        Setter to control whether to allow for certain classes via a star notation to be excluded such as java.lang.Math.* or specific static members to be excluded like java.lang.System.out for a variable or java.lang.Math.random for a method. See notes section for details.
        Parameters:
        excludes - a list of fully-qualified class names/specific static members where static imports are ok