Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.checks
Class MemberNameCheck  

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
                  com.puppycrawl.tools.checkstyle.checks.AbstractNameCheck
                      com.puppycrawl.tools.checkstyle.checks.MemberNameCheck

All Implemented Interfaces:

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

---

public class MemberNameCheck

extends AbstractNameCheck

Checks that instance variable names conform to a format specified by the format property. The format is a regular expression and defaults to ^[a-z][a-zA-Z0-9]*$.

An example of how to configure the check is:

 <module name="MemberName"/>
 

An example of how to configure the check for names that begin with "m", followed by an upper case letter, and then letters and digits is:

 <module name="MemberName">
    <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
 </module>
 

Version:

1.0

---

Field Summary

 

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

 

Fields inherited from class com.puppycrawl.tools.checkstyle.api.Check

 

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

 

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

 

Constructor Summary

MemberNameCheck()           Creates a new MemberNameCheck instance.

 

Method Summary
int[]	getDefaultTokens()           Returns the default token a check is interested in.
protected  boolean	mustCheckName(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Decides whether the name of an AST should be checked against the format regexp.

 

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

visitToken

 

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

getFormat, getRegexp, setFormat

 

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

 

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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, setSeverity

 

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

 

Methods inherited from class java.lang.Object

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

 

Constructor Detail

MemberNameCheck

public MemberNameCheck()

Creates a new MemberNameCheck instance.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

---

mustCheckName

protected final boolean mustCheckName(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Description copied from class: AbstractNameCheck

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

Overrides:

mustCheckName in class AbstractNameCheck

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---