Class GenericWhitespaceCheck
- 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.GenericWhitespaceCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class GenericWhitespaceCheck extends AbstractCheck
Checks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention. The convention is not configurable.Left angle bracket ("<"):
- should be preceded with whitespace only in generic methods definitions.
- should not be preceded with whitespace when it is preceded method name or constructor.
- should not be preceded with whitespace when following type name.
- should not be followed with whitespace in all cases.
Right angle bracket (">"):
- should not be preceded with whitespace in all cases.
- should be followed with whitespace in almost all cases, except diamond operators and when preceding a method name, constructor, or record header.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
ws.followed
-
ws.illegalFollow
-
ws.notPreceded
-
ws.preceded
- Since:
- 5.0
-
-
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 static String
CLOSE_ANGLE_BRACKET
Close angle bracket literal.private int
depth
Used to count the depth of a Generic expression.static String
MSG_WS_FOLLOWED
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_WS_ILLEGAL_FOLLOW
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_WS_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.private static String
OPEN_ANGLE_BRACKET
Open angle bracket literal.
-
Constructor Summary
Constructors Constructor Description GenericWhitespaceCheck()
-
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 static boolean
containsWhitespaceBefore(int before, int... line)
Returns whether the specified string contains only whitespace up to specified index.private static boolean
containsWhitespaceBetween(int fromIndex, int toIndex, int... line)
Returns whether the specified string contains only whitespace between specified indices.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
isAfterMethodReference(DetailAST genericEnd)
Checks if current generic end ('>') is located aftermethod reference operator
.private static boolean
isCharacterValidAfterGenericEnd(char charAfter)
Checks whether given character is valid to be right after generic ends.private static boolean
isGenericAfterNew(DetailAST ast)
Checks if generic is afterLITERAL_NEW
.private static boolean
isGenericBeforeCtorInvocation(DetailAST ast)
Checks if generic is before constructor invocation.private static boolean
isGenericBeforeMethod(DetailAST ast)
Is generic before method reference.private static boolean
isGenericBeforeRecordHeader(DetailAST ast)
Checks if generic is before record header.private void
processEnd(DetailAST ast)
Checks the token for the end of Generics.private void
processNestedGenerics(DetailAST ast, int[] line, int after)
Process Nested generics.private void
processSingleGeneric(DetailAST ast, int[] line, int after)
Process Single-generic.private void
processStart(DetailAST ast)
Checks the token for the start of Generics.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, 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_WS_PRECEDED
public static final String MSG_WS_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_WS_FOLLOWED
public static final String MSG_WS_FOLLOWED
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_WS_NOT_PRECEDED
public static final String MSG_WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_WS_ILLEGAL_FOLLOW
public static final String MSG_WS_ILLEGAL_FOLLOW
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
OPEN_ANGLE_BRACKET
private static final String OPEN_ANGLE_BRACKET
Open angle bracket literal.- See Also:
- Constant Field Values
-
CLOSE_ANGLE_BRACKET
private static final String CLOSE_ANGLE_BRACKET
Close angle bracket literal.- See Also:
- Constant Field Values
-
depth
private int depth
Used to count the depth of a Generic expression.
-
-
Constructor Detail
-
GenericWhitespaceCheck
public GenericWhitespaceCheck()
-
-
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
-
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
-
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
-
processEnd
private void processEnd(DetailAST ast)
Checks the token for the end of Generics.- Parameters:
ast
- the token to check
-
processNestedGenerics
private void processNestedGenerics(DetailAST ast, int[] line, int after)
Process Nested generics.- Parameters:
ast
- tokenline
- unicode code points array of lineafter
- position after
-
processSingleGeneric
private void processSingleGeneric(DetailAST ast, int[] line, int after)
Process Single-generic.- Parameters:
ast
- tokenline
- unicode code points array of lineafter
- position after
-
isGenericBeforeRecordHeader
private static boolean isGenericBeforeRecordHeader(DetailAST ast)
Checks if generic is before record header. Identifies two cases:- In record def, eg:
record Session<T>()
- In record pattern def, eg:
o instanceof Session<String>(var s)
- Parameters:
ast
- ast- Returns:
- true if generic is before record header
- In record def, eg:
-
isGenericBeforeCtorInvocation
private static boolean isGenericBeforeCtorInvocation(DetailAST ast)
Checks if generic is before constructor invocation. Identifies two cases:new ArrayList<>();
new Outer.Inner<>();
- Parameters:
ast
- ast- Returns:
- true if generic is before constructor invocation
-
isGenericAfterNew
private static boolean isGenericAfterNew(DetailAST ast)
Checks if generic is afterLITERAL_NEW
. Identifies three cases:new <String>Object();
new <String>Outer.Inner();
new <@A Outer>@B Inner();
- Parameters:
ast
- ast- Returns:
- true if generic after
LITERAL_NEW
-
isGenericBeforeMethod
private static boolean isGenericBeforeMethod(DetailAST ast)
Is generic before method reference.- Parameters:
ast
- ast- Returns:
- true if generic before a method ref
-
isAfterMethodReference
private static boolean isAfterMethodReference(DetailAST genericEnd)
Checks if current generic end ('>') is located aftermethod reference operator
.- Parameters:
genericEnd
-TokenTypes.GENERIC_END
- Returns:
- true if '>' follows after method reference.
-
processStart
private void processStart(DetailAST ast)
Checks the token for the start of Generics.- Parameters:
ast
- the token to check
-
containsWhitespaceBetween
private static boolean containsWhitespaceBetween(int fromIndex, int toIndex, int... line)
Returns whether the specified string contains only whitespace between specified indices.- Parameters:
fromIndex
- the index to start the search from. InclusivetoIndex
- the index to finish the search. Exclusiveline
- the unicode code points array of line to check- Returns:
- whether there are only whitespaces (or nothing)
-
containsWhitespaceBefore
private static boolean containsWhitespaceBefore(int before, int... line)
Returns whether the specified string contains only whitespace up to specified index.- Parameters:
before
- the index to finish the search. Exclusiveline
- the unicode code points array of line to check- Returns:
true
if there are only whitespaces, false if there is nothing before or some other characters
-
isCharacterValidAfterGenericEnd
private static boolean isCharacterValidAfterGenericEnd(char charAfter)
Checks whether given character is valid to be right after generic ends.- Parameters:
charAfter
- character to check- Returns:
- checks if given character is valid
-
-