Package com.puppycrawl.tools.checkstyle.checks.naming

Class LambdaParameterNameCheck

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.naming.AbstractNameCheck

com.puppycrawl.tools.checkstyle.checks.naming.LambdaParameterNameCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class LambdaParameterNameCheck
extends AbstractNameCheck

Checks lambda parameter names.

Since:

8.11

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_INVALID_PATTERN	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
LambdaParameterNameCheck()	Creates new instance of LambdaParameterNameCheck.

Method Summary

Modifier and Type	Method	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.
private static boolean	isSwitchRuleLambda(DetailAST lambda)	Checks whether a lambda token represents a switch rule arrow.
protected boolean	mustCheckName(DetailAST ast)	Decides whether the name of an AST should be checked against the format regexp.
void	visitToken(DetailAST ast)	Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck

setFormat

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MSG_INVALID_PATTERN

public static final String MSG_INVALID_PATTERN

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

Constructor Details

LambdaParameterNameCheck

public LambdaParameterNameCheck()

Creates new instance of LambdaParameterNameCheck.

Method Details

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 class AbstractCheck

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 class AbstractCheck

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 class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

• TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractNameCheck

Parameters:

ast - the token to process

mustCheckName

protected boolean mustCheckName(DetailAST ast)

Description copied from class: AbstractNameCheck

Decides whether the name of an AST should be checked against the format regexp.

Specified by:

mustCheckName in class AbstractNameCheck

Parameters:

ast - the AST to check.

Returns:

true if the IDENT subnode of ast should be checked against the format regexp.

isSwitchRuleLambda

private static boolean isSwitchRuleLambda(DetailAST lambda)

Checks whether a lambda token represents a switch rule arrow. Switch rule arrows have no children, while lambda expressions do.

Parameters:

lambda - the lambda AST node

Returns:

true if the token represents a switch rule arrow