Class UncommentedMainCheck
- 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.UncommentedMainCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class UncommentedMainCheck extends AbstractCheck
Detects uncommentedmain
methods.Rationale: A
main
method is often used for debugging purposes. When debugging is finished, developers often forget to remove the method, which changes the API and increases the size of the resulting class or JAR file. Except for the real program entry points, allmain
methods should be removed or commented out of the sources.-
Property
excludedClasses
- Specify pattern for qualified names of classes which are allowed to have amain
method. Type isjava.util.regex.Pattern
. Default value is"^$"
.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
uncommented.main
- Since:
- 3.2
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private int
classDepth
Class definition depth.private String
currentClass
Current class name.private Pattern
excludedClasses
Specify pattern for qualified names of classes which are allowed to have amain
method.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.private FullIdent
packageName
Current package.private static Set<String>
STRING_PARAMETER_NAMES
Set of possible String array types.
-
Constructor Summary
Constructors Constructor Description UncommentedMainCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
Called before the starting to process a tree.private boolean
checkClassName()
Checks that current class is not excluded.private static boolean
checkModifiers(DetailAST method)
Checks that method has final and static modifiers.private static boolean
checkName(DetailAST method)
Checks that method name is @quot;main@quot;.private static boolean
checkParams(DetailAST method)
Checks that method has onlyString[]
or onlyString...
param.private static boolean
checkType(DetailAST method)
Checks that return type isvoid
.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.private static boolean
isStringType(DetailAST typeAst)
Whether the type is java.lang.String.void
leaveToken(DetailAST ast)
Called after all the child nodes have been process.void
setExcludedClasses(Pattern excludedClasses)
Setter to specify pattern for qualified names of classes which are allowed to have amain
method.private void
visitClassOrRecordDef(DetailAST classOrRecordDef)
If not inner class then change current class name.private void
visitMethodDef(DetailAST method)
Checks method definition if this ispublic static void main(String[])
.private void
visitPackageDef(DetailAST packageDef)
Sets current package.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, log, log, log, 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.AbstractAutomaticBean
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
-
STRING_PARAMETER_NAMES
private static final Set<String> STRING_PARAMETER_NAMES
Set of possible String array types.
-
excludedClasses
private Pattern excludedClasses
Specify pattern for qualified names of classes which are allowed to have amain
method.
-
currentClass
private 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(Pattern excludedClasses)
Setter to specify pattern for qualified names of classes which are allowed to have amain
method.- Parameters:
excludedClasses
- a pattern- Since:
- 3.2
-
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
-
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
-
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
-
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 classAbstractCheck
- 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 classAbstractCheck
- Parameters:
ast
- the token leaving
-
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
-
visitPackageDef
private void visitPackageDef(DetailAST packageDef)
Sets current package.- Parameters:
packageDef
- node for package definition
-
visitClassOrRecordDef
private void visitClassOrRecordDef(DetailAST classOrRecordDef)
If not inner class then change current class name.- Parameters:
classOrRecordDef
- node for class or record definition
-
visitMethodDef
private void visitMethodDef(DetailAST method)
Checks method definition if this ispublic 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 isvoid
.- Parameters:
method
- the METHOD_DEF node- Returns:
- true if check passed, false otherwise
-
checkParams
private static boolean checkParams(DetailAST method)
Checks that method has onlyString[]
or onlyString...
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.
-
-