Package com.puppycrawl.tools.checkstyle.checks.coding
Contains the Coding checks that are
bundled with the main distribution.
-
Class Summary Class Description AbstractSuperCheck Abstract class for checking that an overriding method with no parameters invokes the super method.AbstractSuperCheck.MethodNode Stack node for a method definition and a record of whether the method has a call to the super method.ArrayTrailingCommaCheck Checks that array initialization contains a trailing comma.AvoidDoubleBraceInitializationCheck Detects double brace initialization.AvoidInlineConditionalsCheck Detects inline conditionals.AvoidNoArgumentSuperConstructorCallCheck Checks if call to superclass constructor without arguments is present.ConstructorsDeclarationGroupingCheck Checks that all constructors are grouped together.CovariantEqualsCheck Checks that classes and records which define a covariantequals()
method also override methodequals(Object)
.DeclarationOrderCheck Checks that the parts of a class, record, or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.DeclarationOrderCheck.ScopeState Private class to encapsulate the state.DefaultComesLastCheck Check that thedefault
is after all the cases in aswitch
statement.EmptyStatementCheck Detects empty statements (standalone";"
semicolon).EqualsAvoidNullCheck Checks that any combination of String literals is on the left side of anequals()
comparison.EqualsAvoidNullCheck.FieldFrame Holds the names of fields of a type.EqualsHashCodeCheck Checks that classes that either overrideequals()
orhashCode()
also overrides the other.ExplicitInitializationCheck Checks if any class or object member is explicitly initialized to default for its type value (null
for object references, zero for numeric types andchar
andfalse
forboolean
.FallThroughCheck Checks for fall-through inswitch
statements.FinalLocalVariableCheck Checks that local variables that never have their values changed are declared final.FinalLocalVariableCheck.FinalVariableCandidate Represents information about final local variable candidate.FinalLocalVariableCheck.ScopeData Holder for the scope data.HiddenFieldCheck Checks that a local variable or a parameter does not shadow a field that is defined in the same class.HiddenFieldCheck.FieldFrame Holds the names of static and instance fields of a type.IllegalCatchCheck Checks that certain exception types do not appear in acatch
statement.IllegalInstantiationCheck Checks for illegal instantiations where a factory method is preferred.IllegalThrowsCheck Checks that specified types are not declared to be thrown.IllegalTokenCheck Checks for illegal tokens.IllegalTokenTextCheck Checks specified tokens text for matching an illegal pattern.IllegalTypeCheck Checks that particular classes or interfaces are never used.InnerAssignmentCheck Checks for assignments in subexpressions, such as inString s = Integer.toString(i = 2);
.MagicNumberCheck Checks that there are no "magic numbers" where a magic number is a numeric literal that is not defined as a constant.MatchXpathCheck Evaluates Xpath query and report violation on all matching AST nodes.MissingCtorCheck Checks that classes (except abstract ones) define a constructor and don't rely on the default one.MissingNullCaseInSwitchCheck Checks that a given switch statement or expression that use a reference type in its selector expression has anull
case label.MissingSwitchDefaultCheck Checks that switch statement has adefault
clause.ModifiedControlVariableCheck Checks that for loop control variables are not modified inside the for block.MultipleStringLiteralsCheck Checks for multiple occurrences of the same string literal within a single file.MultipleVariableDeclarationsCheck Checks that each variable declaration is in its own statement and on its own line.NestedForDepthCheck Restricts nestedfor
blocks to a specified depth.NestedIfDepthCheck Restricts nested if-else blocks to a specified depth.NestedTryDepthCheck Restricts nested try-catch-finally blocks to a specified depth.NoArrayTrailingCommaCheck Checks that array initialization do not contain a trailing comma.NoCloneCheck Checks that the clone method is not overridden from the Object class.NoEnumTrailingCommaCheck Checks that enum definition does not contain a trailing comma.NoFinalizerCheck Checks that there is no methodfinalize
with zero parameters.OneStatementPerLineCheck Checks that there is only one statement per line.OverloadMethodsDeclarationOrderCheck Checks that overloaded methods are grouped together.PackageDeclarationCheck Ensures that a class has a package declaration, and (optionally) whether the package name matches the directory name for the source file.ParameterAssignmentCheck Disallows assignment of parameters.RequireThisCheck Checks that references to instance variables and methods of the present object are explicitly of the form "this.varName" or "this.methodName(args)" and that those references don't rely on the default behavior when "this." is absent.RequireThisCheck.AbstractFrame A declaration frame.RequireThisCheck.AnonymousClassFrame An anonymous class frame; holds instance variable names.RequireThisCheck.BlockFrame A frame initiated on entering a statement list; holds local variable names.RequireThisCheck.CatchFrame A frame initiated on entering a catch block; holds local catch variable names.RequireThisCheck.ClassFrame A frame initiated at class, enum or interface definition; holds instance variable names.RequireThisCheck.ConstructorFrame A frame initiated at constructor definition.RequireThisCheck.ForFrame A frame initiated on entering a for block; holds local for variable names.RequireThisCheck.MethodFrame A frame initiated at method definition; holds a method definition token.RequireThisCheck.TryWithResourcesFrame A frame initiated on entering a try-with-resources construct; holds local resources for the try block.ReturnCountCheck Restricts the number of return statements in methods, constructors and lambda expressions.SimplifyBooleanExpressionCheck Checks for over-complicated boolean expressions.SimplifyBooleanReturnCheck Checks for over-complicated boolean return or yield statements.StringLiteralEqualityCheck Checks that string literals are not used with==
or!=
.SuperCloneCheck Checks that an overridingclone()
method invokessuper.clone()
.SuperFinalizeCheck Checks that an overridingfinalize()
method invokessuper.finalize()
.UnnecessaryParenthesesCheck Checks if unnecessary parentheses are used in a statement or expression.UnnecessarySemicolonAfterOuterTypeDeclarationCheck Checks if unnecessary semicolon is used after type declaration.UnnecessarySemicolonAfterTypeMemberDeclarationCheck Checks if unnecessary semicolon is used after type member declaration.UnnecessarySemicolonInEnumerationCheck Checks if unnecessary semicolon is in enum definitions.UnnecessarySemicolonInTryWithResourcesCheck Checks if unnecessary semicolon is used in last resource declaration.UnusedCatchParameterShouldBeUnnamedCheck Ensures that catch parameters that are not used are declared as an unnamed variable.UnusedCatchParameterShouldBeUnnamedCheck.CatchParameterDetails Maintains information about the catch parameter.UnusedLambdaParameterShouldBeUnnamedCheck Ensures that lambda parameters that are not used are declared as an unnamed variable.UnusedLambdaParameterShouldBeUnnamedCheck.LambdaParameterDetails Maintains information about the lambda parameter.UnusedLocalVariableCheck Checks that a local variable is declared and/or assigned, but not used.UnusedLocalVariableCheck.TypeDeclDesc Maintains information about the type declaration.UnusedLocalVariableCheck.VariableDesc Maintains information about the variable.VariableDeclarationUsageDistanceCheck Checks the distance between declaration of variable and its first usage.WhenShouldBeUsedCheck Ensures thatwhen
is used instead of a singleif
statement inside a case block. -
Enum Summary Enum Description RequireThisCheck.FrameType An AbstractFrame type.