Class ClassMemberImpliedModifierCheck
- 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.modifier.ClassMemberImpliedModifierCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class ClassMemberImpliedModifierCheck extends AbstractCheck
Checks for implicit modifiers on nested types in classes.
This check is effectively the opposite of RedundantModifier. It checks the modifiers on nested types in classes, ensuring that certain modifiers are explicitly specified even though they are actually redundant.
Nested enums and interfaces within a class are always
static
and as such the compiler does not require thestatic
modifier. This check provides the ability to enforce that thestatic
modifier is explicitly coded and not implicitly added by the compiler.public final class Person { enum Age { // violation CHILD, ADULT } }
Rationale for this check: Nested enums and interfaces are treated differently from nested classes as they are only allowed to be
static
. Developers should not need to remember this rule, and this check provides the means to enforce that the modifier is coded explicitly.-
Property
violateImpliedStaticOnNestedEnum
- Control whether to enforce thatstatic
is explicitly coded on nested enums in classes. Default value istrue
. -
Property
violateImpliedStaticOnNestedInterface
- Control whether to enforce thatstatic
is explicitly coded on nested interfaces in classes. Default value istrue
.
This example checks that all implicit modifiers on nested interfaces and enums are explicitly specified in classes.
Configuration:
<module name="ClassMemberImpliedModifier" />
Code:
public final class Person { static interface Address1 { // valid } interface Address2 { // violation } static enum Age1 { // valid CHILD, ADULT } enum Age2 { // violation CHILD, ADULT } }
- Since:
- 8.16
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description ClassMemberImpliedModifierCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.void
setViolateImpliedStaticOnNestedEnum(boolean violateImplied)
Setter to control whether to enforce thatstatic
is explicitly coded on nested enums in classes.void
setViolateImpliedStaticOnNestedInterface(boolean violateImplied)
Setter to control whether to enforce thatstatic
is explicitly coded on nested interfaces in classes.void
visitToken(DetailAST ast)
Called to process a token.-
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 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
-
-
Method Detail
-
setViolateImpliedStaticOnNestedEnum
public void setViolateImpliedStaticOnNestedEnum(boolean violateImplied)
Setter to control whether to enforce thatstatic
is explicitly coded on nested enums in classes.- Parameters:
violateImplied
- True to perform the check, false to turn the check off.
-
setViolateImpliedStaticOnNestedInterface
public void setViolateImpliedStaticOnNestedInterface(boolean violateImplied)
Setter to control whether to enforce thatstatic
is explicitly coded on nested interfaces in classes.- Parameters:
violateImplied
- True to perform the check, false to turn the check off.
-
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:
TokenTypes
-
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:
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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
-