Class NoWhitespaceBeforeCaseDefaultColonCheck
- 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.whitespace.NoWhitespaceBeforeCaseDefaultColonCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class NoWhitespaceBeforeCaseDefaultColonCheck extends AbstractCheck
Checks that there is no whitespace before the colon in a switch block.Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
ws.preceded
- Since:
- 8.45
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Constructor Summary
Constructors Constructor Description NoWhitespaceBeforeCaseDefaultColonCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.private static int
getLastColumnNumberOf(DetailAST ast)
Returns the last column number of an ast.int[]
getRequiredTokens()
The tokens that this check must be registered for.boolean
isCommentNodesRequired()
Whether comment nodes are required or not.private static boolean
isInSwitch(DetailAST colonAst)
Checks if the colon is inside a switch block.private static boolean
isOnDifferentLineWithPreviousToken(DetailAST colonAst)
Checks if the colon is on same line as of case or default.private static boolean
isWhiteSpaceBeforeColon(DetailAST colonAst)
Checks if there is a whitespace before the colon of a switch case or switch default.private static boolean
isWhitespaceBeforeColonOfCase(DetailAST colonAst)
Checks if there is a whitespace before the colon of a switch case.private static boolean
isWhitespaceBeforeColonOfDefault(DetailAST colonAst)
Checks if there is a whitespace before the colon of a switch default.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, leaveToken, 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
-
-
Constructor Detail
-
NoWhitespaceBeforeCaseDefaultColonCheck
public NoWhitespaceBeforeCaseDefaultColonCheck()
-
-
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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
isCommentNodesRequired
public boolean isCommentNodesRequired()
Description copied from class:AbstractCheck
Whether comment nodes are required or not.- Overrides:
isCommentNodesRequired
in classAbstractCheck
- Returns:
- false as a default value.
-
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
-
isInSwitch
private static boolean isInSwitch(DetailAST colonAst)
Checks if the colon is inside a switch block.- Parameters:
colonAst
- DetailAST to check.- Returns:
- true, if colon case is inside a switch block.
-
isWhiteSpaceBeforeColon
private static boolean isWhiteSpaceBeforeColon(DetailAST colonAst)
Checks if there is a whitespace before the colon of a switch case or switch default.- Parameters:
colonAst
- DetailAST to check.- Returns:
- true, if there is whitespace preceding colonAst.
-
isWhitespaceBeforeColonOfCase
private static boolean isWhitespaceBeforeColonOfCase(DetailAST colonAst)
Checks if there is a whitespace before the colon of a switch case.- Parameters:
colonAst
- DetailAST to check.- Returns:
- true, if there is whitespace preceding colonAst.
-
isWhitespaceBeforeColonOfDefault
private static boolean isWhitespaceBeforeColonOfDefault(DetailAST colonAst)
Checks if there is a whitespace before the colon of a switch default.- Parameters:
colonAst
- DetailAST to check.- Returns:
- true, if there is whitespace preceding colonAst.
-
isOnDifferentLineWithPreviousToken
private static boolean isOnDifferentLineWithPreviousToken(DetailAST colonAst)
Checks if the colon is on same line as of case or default.- Parameters:
colonAst
- DetailAST to check.- Returns:
- true, if colon case is in different line as of case or default.
-
getLastColumnNumberOf
private static int getLastColumnNumberOf(DetailAST ast)
Returns the last column number of an ast.- Parameters:
ast
- DetailAST to check.- Returns:
- ast's last column number.
-
-