Class TypeNameCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks that type names conform to a specified pattern.
-
Property
format
- Specifies valid identifiers. Type isjava.util.regex.Pattern
. Default value is"^[A-Z][a-zA-Z0-9]*$"
. -
Property
applyToPublic
- Controls whether to apply the check to public member. Type isboolean
. Default value istrue
. -
Property
applyToProtected
- Controls whether to apply the check to protected member. Type isboolean
. Default value istrue
. -
Property
applyToPackage
- Controls whether to apply the check to package-private member. Type isboolean
. Default value istrue
. -
Property
applyToPrivate
- Controls whether to apply the check to private member. Type isboolean
. Default value istrue
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, RECORD_DEF.
To configure the check:
<module name="TypeName"/>
Code Example:
public interface FirstName {} // OK protected class SecondName {} // OK enum Third_Name {} // violation, name 'Third_Name' must match pattern '^[A-Z][a-zA-Z0-9]*$' private class FourthName_ {} // violation, name 'FourthName_' // must match pattern '^[A-Z][a-zA-Z0-9]*$'
An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores. Also, suppress the check from being applied to protected and private type:
<module name="TypeName"> <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/> <property name="applyToProtected" value="false"/> <property name="applyToPrivate" value="false"/> </module>
Code Example:
public interface firstName {} // OK public class SecondName {} // violation, name 'SecondName' // must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$' protected class ThirdName {} // OK private class FourthName {} // OK
The following configuration element ensures that interface names begin with "I_"
,
followed by letters and digits:
<module name="TypeName"> <property name="format" value="^I_[a-zA-Z0-9]*$"/> <property name="tokens" value="INTERFACE_DEF"/> </module>
Code Example:
public interface I_firstName {} // OK interface SecondName {} // violation, name 'SecondName' // must match pattern '^I_[a-zA-Z0-9]*$'
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
name.invalidPattern
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsFields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
MSG_INVALID_PATTERN
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
mustCheckName, setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScope
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
setFormat, visitToken
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
-
Field Details
-
DEFAULT_PATTERN
Default pattern for type name.- See Also:
-
-
Constructor Details
-
TypeNameCheck
public TypeNameCheck()Creates a newTypeNameCheck
instance.
-
-
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 classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public int[] getRequiredTokens()Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-