Package com.puppycrawl.tools.checkstyle.checks

Class OuterTypeFilenameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class OuterTypeFilenameCheck
extends AbstractCheck

    Checks that the outer type name and the file name match. For example, the class Foo must be in a file named Foo.java.

    To configure the check: 

     <module name="OuterTypeFilename"/>

    Example of class Test in a file named Test.java

     public class Test { // OK

 }

    Example of class Foo in a file named Test.java

     class Foo { // violation

 }

    Example of interface Foo in a file named Test.java

     interface Foo { // violation

 }

    Example of enum Foo in a file named Test.java

     enum Foo { // violation

 }

    Example of record Foo in a file named Test.java

     record Foo { // violation

 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • type.file.mismatch
    Since:
    5.3

    • Field Detail

      • MSG_KEY

        public static final java.lang.String MSG_KEY
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • OuterTypeFilenameCheck

        public OuterTypeFilenameCheck()

    • 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

      • beginTree

        public void beginTree​(DetailAST rootAST)
        Description copied from class: AbstractCheck
        Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
        Overrides:
        beginTree in class AbstractCheck
        Parameters:
        rootAST - the root of the tree

      • finishTree

        public void finishTree​(DetailAST rootAST)
        Description copied from class: AbstractCheck
        Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.
        Overrides:
        finishTree in class AbstractCheck
        Parameters:
        rootAST - the root of the tree