TypeNameCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.TypeNameCheck

SOURCE |

Download com.puppycrawl.tools.checkstyle.checks.TypeNameCheck

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.puppycrawl.tools.checkstyle.checks
Class TypeNameCheck

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.TypeNameCheck

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.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>

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

TypeNameCheck()
Creates a new TypeNameCheck instance.

Method Summary

int[] getDefaultTokens()
Returns the default token a check is interested in.

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

mustCheckName, 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