public class EmptyCatchBlockCheck extends AbstractCheck
Checks for empty catch blocks. By default check allows empty catch block with any comment inside.
There are two options to make validation more precise: exceptionVariableName and commentFormat. If both options are specified - they are applied by any of them is matching.
exceptionVariableName - Specify the RegExp for the name of the variable
associated with exception. If check meets variable name matching specified value - empty
block is suppressed.
Default value is "^$" (empty).
commentFormat - Specify the RegExp for the first comment inside empty
catch block. If check meets comment inside empty catch block matching specified format
- empty block is suppressed. If it is multi-line comment - only its first line is analyzed.
Default value is ".*".
To configure the check to suppress empty catch block if exception's variable name is
expected or ignore or there's any comment inside:
<module name="EmptyCatchBlock"> <property name="exceptionVariableName" value="expected|ignore"/> </module>
Such empty blocks would be both suppressed:
try {
throw new RuntimeException();
} catch (RuntimeException expected) {
}
try {
throw new RuntimeException();
} catch (RuntimeException ignore) {
}
To configure the check to suppress empty catch block if single-line comment inside is "//This is expected":
<module name="EmptyCatchBlock"> <property name="commentFormat" value="This is expected"/> </module>
Such empty block would be suppressed:
try {
throw new RuntimeException();
} catch (RuntimeException ex) {
//This is expected
}
To configure the check to suppress empty catch block if single-line comment inside is "//This is expected" or exception's variable name is "myException" (any option is matching):
<module name="EmptyCatchBlock"> <property name="commentFormat" value="This is expected"/> <property name="exceptionVariableName" value="myException"/> </module>
Such empty blocks would be suppressed:
try {
throw new RuntimeException();
} catch (RuntimeException e) {
//This is expected
}
...
try {
throw new RuntimeException();
} catch (RuntimeException e) {
// This is expected
}
...
try {
throw new RuntimeException();
} catch (RuntimeException e) {
// This is expected
// some another comment
}
...
try {
throw new RuntimeException();
} catch (RuntimeException e) {
/* This is expected */
}
...
try {
throw new RuntimeException();
} catch (RuntimeException e) {
/*
*
* This is expected
* some another comment
*/
}
...
try {
throw new RuntimeException();
} catch (RuntimeException myException) {
}
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
MSG_KEY_CATCH_BLOCK_EMPTY
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
EmptyCatchBlockCheck() |
| Modifier and Type | Method and Description |
|---|---|
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.
|
boolean |
isCommentNodesRequired()
Whether comment nodes are required or not.
|
void |
setCommentFormat(java.util.regex.Pattern commentPattern)
Setter to specify the RegExp for the first comment inside empty catch block.
|
void |
setExceptionVariableName(java.util.regex.Pattern exceptionVariablePattern)
Setter to specify the RegExp for the name of the variable associated with exception.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final java.lang.String MSG_KEY_CATCH_BLOCK_EMPTY
public EmptyCatchBlockCheck()
public void setExceptionVariableName(java.util.regex.Pattern exceptionVariablePattern)
exceptionVariablePattern - pattern of exception's variable name.public void setCommentFormat(java.util.regex.Pattern commentPattern)
commentPattern - pattern of comment.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic boolean isCommentNodesRequired()
AbstractCheckisCommentNodesRequired in class AbstractCheckpublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractCheckast - the token to processCopyright © 2001-2019. All Rights Reserved.