com.puppycrawl.tools.checkstyle.checks.naming

Class TypeNameCheck

Implemented Interfaces:
Configurable, Contextualizable

public class TypeNameCheck
extends AbstractNameCheck

Checks that type 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="TypeName"/>
 

An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores is:

 <module name="TypeName">
    <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
 </module>
 
Author:
Oliver Burn

Constructor Summary

TypeNameCheck()
Creates a new TypeNameCheck instance.

Method Summary

int[]
getDefaultTokens()

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

mustCheckName, visitToken

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

getFormat, getRegexp, setCompileFlags, setFormat

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

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

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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

TypeNameCheck

public TypeNameCheck()
Creates a new TypeNameCheck instance.

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check