Package com.puppycrawl.tools.checkstyle.checks.naming

Class TypeNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class TypeNameCheck
extends AbstractAccessControlNameCheck

    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 Detail

      • DEFAULT_PATTERN

        public static final java.lang.String DEFAULT_PATTERN
        Default pattern for type name.
        See Also:
        Constant Field Values

    • Constructor Detail

      • TypeNameCheck

        public TypeNameCheck()
        Creates a new TypeNameCheck instance.

    • Method Detail

      • 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 class AbstractCheck
        Returns:
        the default tokens
        See Also:
        TokenTypes

      • 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 class AbstractCheck
        Returns:
        the token set this check is designed for.
        See Also:
        TokenTypes

      • getRequiredTokens

        public int[] getRequiredTokens()
        Description copied from class: AbstractCheck
        The tokens that this check must be registered for.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes