public class TypeNameCheck extends AbstractAccessControlNameCheck
Checks that type names conform to a specified pattern.
format - Specifies valid identifiers.
Type is java.util.regex.Pattern.
Default value is "^[A-Z][a-zA-Z0-9]*$".
applyToPublic - Controls whether to apply the check to public member.
Type is boolean.
Default value is true.
applyToProtected - Controls whether to apply the check to protected member.
Type is boolean.
Default value is true.
applyToPackage - Controls whether to apply the check to package-private member.
Type is boolean.
Default value is true.
applyToPrivate - Controls whether to apply the check to private member.
Type is boolean.
Default value is true.
tokens - tokens to check
Type is java.lang.String[].
Validation type is tokenSet.
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
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DEFAULT_PATTERN
Default pattern for type name.
|
MSG_INVALID_PATTERN| Constructor and Description |
|---|
TypeNameCheck()
Creates a new
TypeNameCheck instance. |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
mustCheckName, setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScopesetFormat, visitTokenbeginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final java.lang.String DEFAULT_PATTERN
public TypeNameCheck()
TypeNameCheck instance.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypesCopyright © 2001-2020. All Rights Reserved.