com.github.sevntu.checkstyle.checks.coding

Class SimpleAccessorNameNotationCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.github.sevntu.checkstyle.checks.coding.SimpleAccessorNameNotationCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class SimpleAccessorNameNotationCheck
extends com.puppycrawl.tools.checkstyle.api.AbstractCheck

This check verify incorrect name of setter and getter methods if it used field with other name.

For example, method has name 'setXXX', but define field with name 'YYY'. Setter and getter methods must have next view: XXXType getXXXName() {return XXXName} XXXType getXXXName() {return this.XXXName} void setXXXName(XXXType value) { this.XXXName = value} void setXXXName(XXXType value) { XXXName = value}

If name of field contains prefix,then must to be define parameter 'prefix' , for example:

 <module name="SimpleAccessorNameNotationCheck"> <
 property name="prefix" value="m_"/>
 </module>
 

Since:

1.9.0

Author:

Hidoyatov Victor, Ilja Dubinin

Nested Class Summary

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

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SimpleAccessorNameNotationCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens()
int[]	getDefaultTokens()
int[]	getRequiredTokens()
void	setPrefix(String prefix) Setter for prefix.
void	visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST methodDef)

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

beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY_GETTER

public static final String MSG_KEY_GETTER

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

See Also:

Constant Field Values

MSG_KEY_SETTER

public static final String MSG_KEY_SETTER

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

See Also:

Constant Field Values

Constructor Detail

SimpleAccessorNameNotationCheck

public SimpleAccessorNameNotationCheck()

Method Detail

setPrefix

public void setPrefix(String prefix)

Setter for prefix.

Parameters:

prefix - - prefix of field's name

getDefaultTokens

public int[] getDefaultTokens()

Specified by:

getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getAcceptableTokens

public int[] getAcceptableTokens()

Specified by:

getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getRequiredTokens

public int[] getRequiredTokens()

Specified by:

getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST methodDef)

Overrides:

visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck