Class UncommentedMainCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Detects uncommented main
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.
With the exception of the real program entry points, all main
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"^$"
.
To configure the check:
<module name="UncommentedMain"/>
Example:
public class Game { public static void main(String... args){} // violation } public class Main { public static void main(String[] args){} // violation } public class Launch { //public static void main(String[] args){} // OK } public class Start { public void main(){} // OK } public record MyRecord1 { public void main(){} // violation } public record MyRecord2 { //public void main(){} // OK }
To configure the check to allow the main
method for all classes with "Main" name:
<module name="UncommentedMain"> <property name="excludedClasses" value="\.Main$"/> </module>
Example:
public class Game { public static void main(String... args){} // violation } public class Main { public static void main(String[] args){} // OK } public class Launch { //public static void main(String[] args){} // OK } public class Start { public void main(){} // OK } public record MyRecord1 { public void main(){} // OK }
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.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called before the starting to process a tree.int[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.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.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
-
Constructor Details
-
UncommentedMainCheck
public UncommentedMainCheck()
-
-
Method Details
-
setExcludedClasses
Setter to specify pattern for qualified names of classes which are allowed to have amain
method.- 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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
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:
-
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:
-
beginTree
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
Description copied from class:AbstractCheck
Called after all the child nodes have been process.- Overrides:
leaveToken
in classAbstractCheck
- Parameters:
ast
- the token leaving
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-