Package com.puppycrawl.tools.checkstyle.checks.annotation

Class MissingOverrideOnRecordAccessorCheck

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.annotation.MissingOverrideOnRecordAccessorCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class MissingOverrideOnRecordAccessorCheck
extends AbstractCheck

Verifies that explicitly declared record accessor methods include the @Override annotation.

Per JEP 395, the meaning of the @Override annotation was extended to include explicitly declared accessor methods for record components.

This check focuses only on record component accessor methods. It does not attempt to detect general method overrides from interfaces or superclasses, due to Checkstyle's single-file analysis limitations.

Since:

13.1.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
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
MissingOverrideOnRecordAccessorCheck()

Method Summary

Modifier and Type	Method	Description
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
private static Set<String>	getRecordComponentNames(DetailAST recordDef)	Gets the set of record component names from a record definition.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
private static boolean	isRecordAccessorMethod(DetailAST ast)	Checks if the given method is an explicitly declared accessor for a record component.
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, 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_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 Details

MissingOverrideOnRecordAccessorCheck

public MissingOverrideOnRecordAccessorCheck()

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 AbstractCheck

Parameters:

ast - the token to process

isRecordAccessorMethod

private static boolean isRecordAccessorMethod(DetailAST ast)

Checks if the given method is an explicitly declared accessor for a record component.

Parameters:

ast - the METHOD_DEF AST node

Returns:

true if this method is a record accessor

getRecordComponentNames

private static Set<String> getRecordComponentNames(DetailAST recordDef)

Gets the set of record component names from a record definition.

Parameters:

recordDef - the RECORD_DEF AST node

Returns:

set of component names