Package com.puppycrawl.tools.checkstyle.checks

Class UncommentedMainCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class UncommentedMainCheck
extends AbstractCheck
    Detects uncommented main methods. Basically detects any main method, since if it is detectable that means it is uncommented. 
     <module name="UncommentedMain"/>

    • 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

      • excludedClasses

        private java.util.regex.Pattern excludedClasses
        Compiled regexp to exclude classes from check.

      • currentClass

        private java.lang.String currentClass
        Current class name.

      • packageName

        private FullIdent packageName
        Current package.

      • classDepth

        private int classDepth
        Class definition depth.

    • Constructor Detail

      • UncommentedMainCheck

        public UncommentedMainCheck()

    • Method Detail

      • setExcludedClasses

        public void setExcludedClasses​(java.util.regex.Pattern excludedClasses)
        Set the excluded classes pattern.
        Parameters:
        excludedClasses - a pattern

      • 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

      • 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

      • 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

      • 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

      • leaveToken

        public void leaveToken​(DetailAST ast)
        Description copied from class: AbstractCheck
        Called after all the child nodes have been process.
        Overrides:
        leaveToken in class AbstractCheck
        Parameters:
        ast - the token leaving

      • visitPackageDef

        private void visitPackageDef​(DetailAST packageDef)
        Sets current package.
        Parameters:
        packageDef - node for package definition

      • visitClassDef

        private void visitClassDef​(DetailAST classDef)
        If not inner class then change current class name.
        Parameters:
        classDef - node for class definition

      • visitMethodDef

        private void visitMethodDef​(DetailAST method)
        Checks method definition if this is public static void main(String[]).
        Parameters:
        method - method definition node

      • checkClassName

        private boolean checkClassName()
        Checks that current class is not excluded.
        Returns:
        true if check passed, false otherwise

      • checkName

        private static boolean checkName​(DetailAST method)
        Checks that method name is @quot;main@quot;.
        Parameters:
        method - the METHOD_DEF node
        Returns:
        true if check passed, false otherwise

      • checkModifiers

        private static boolean checkModifiers​(DetailAST method)
        Checks that method has final and static modifiers.
        Parameters:
        method - the METHOD_DEF node
        Returns:
        true if check passed, false otherwise

      • checkType

        private static boolean checkType​(DetailAST method)
        Checks that return type is void.
        Parameters:
        method - the METHOD_DEF node
        Returns:
        true if check passed, false otherwise

      • checkParams

        private static boolean checkParams​(DetailAST method)
        Checks that method has only String[] or only String... param.
        Parameters:
        method - the METHOD_DEF node
        Returns:
        true if check passed, false otherwise

      • isStringType

        private static boolean isStringType​(DetailAST typeAst)
        Whether the type is java.lang.String.
        Parameters:
        typeAst - the type to check.
        Returns:
        true, if the type is java.lang.String.