Class UnnecessaryTypeArgumentsWithRecordPatternCheck

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.coding.UnnecessaryTypeArgumentsWithRecordPatternCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class UnnecessaryTypeArgumentsWithRecordPatternCheck
extends AbstractCheck

Checks for unnecessary explicit type arguments in record patterns.

When a record pattern declares explicit type arguments that can be inferred by the compiler, those type arguments are redundant and reduce readability.

Since:

13.9.0

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_KEY	The error message key.

Constructor Summary

Constructors

Constructor	Description
UnnecessaryTypeArgumentsWithRecordPatternCheck()	Creates a new UnnecessaryTypeArgumentsWithRecordPatternCheck instance.

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	isUnnecessary(DetailAST typeArgs)	Determines whether explicit type arguments in a record pattern are unnecessary.
void	visitToken(DetailAST ast)	Called to process a token.

Methods inherited from class 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 AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class Object

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

Field Details

MSG_KEY

public static final String MSG_KEY

The error message key.

See Also:

• Constant Field Values

Constructor Details

UnnecessaryTypeArgumentsWithRecordPatternCheck

public UnnecessaryTypeArgumentsWithRecordPatternCheck()

Creates a new UnnecessaryTypeArgumentsWithRecordPatternCheck instance.

Method Details

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

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

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

isUnnecessary

private static boolean isUnnecessary(DetailAST typeArgs)

Determines whether explicit type arguments in a record pattern are unnecessary.

Parameters:

typeArgs - TYPE_ARGUMENTS ast node

Returns:

true if the type arguments are necessary, false otherwise