com.puppycrawl.tools.checkstyle.checks

Class OuterTypeFilenameCheck

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

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.regex.Pattern	FILE_EXTENSION_PATTERN Pattern matching any file extension with dot included.
private java.lang.String	fileName Current file name.
private boolean	hasPublic If file has public type.
static java.lang.String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.
private boolean	seenFirstToken Indicates whether the first token has been seen in the file.
private DetailAST	wrongType Outer type with mismatched file name.

Constructor Summary

Constructors

Constructor and Description
OuterTypeFilenameCheck()

Method Summary

Modifier and Type	Method and Description
void	beginTree(DetailAST rootAST) Called before the starting to process a tree.
void	finishTree(DetailAST rootAST) Called after finished processing a tree.
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
private java.lang.String	getFileName() Get source file name.
int[]	getRequiredTokens() The tokens that this check must be registered for.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

clearViolations, destroy, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

FILE_EXTENSION_PATTERN

private static final java.util.regex.Pattern FILE_EXTENSION_PATTERN

Pattern matching any file extension with dot included.

seenFirstToken

private boolean seenFirstToken

Indicates whether the first token has been seen in the file.

fileName

private java.lang.String fileName

Current file name.

hasPublic

private boolean hasPublic

If file has public type.

wrongType

private DetailAST wrongType

Outer type with mismatched file name.

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

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

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

getFileName

private java.lang.String getFileName()

Get source file name.

Returns:

source file name.