-
Notifications
You must be signed in to change notification settings - Fork 2
1. StartupHeroes CheckStyle Rules
ozlmulg edited this page Aug 11, 2021
·
4 revisions
Rule | Owner | Context | Description | Link | Props |
---|---|---|---|---|---|
AnnotationLocationCheck | CHECKSTYLE | Annotation | Checks location of annotation on language elements. By default, Check enforce to locate annotations immediately after documentation block and before target element, annotation should be located on separate line from target element. This check also verifies that the annotations are on the same indenting level as the annotated element if they are not on the same line. | https://checkstyle.sourceforge.io/config_annotation.html#AnnotationLocation | |
PackageAnnotationCheck | CHECKSTYLE | Annotation | Checks that all package annotations are in the package-info.java file. For Java SE8 and above, placement of package annotations in the package-info.java file is enforced by the compiler and this check is not necessary. For Java SE7 and below, the Java Language Specification highly recommends but doesn't require that annotations are placed in the package-info.java file, and this check can help to enforce that placement. |
https://checkstyle.sourceforge.io/config_annotation.html#PackageAnnotation | |
AvoidNestedBlocksCheck | CHECKSTYLE | Block | Finds nested blocks (blocks that are used freely in the code). | https://checkstyle.sourceforge.io/config_blocks.html#AvoidNestedBlocks | |
EmptyBlockCheck | CHECKSTYLE | Block | Checks for empty blocks. This check does not validate sequential blocks. | https://checkstyle.sourceforge.io/config_blocks.html#EmptyBlock | |
EmptyCatchBlockCheck | CHECKSTYLE | Block | Checks for empty catch blocks. By default check allows empty catch block with any comment inside. | https://checkstyle.sourceforge.io/config_blocks.html#EmptyCatchBlock | |
LeftCurlyCheck | CHECKSTYLE | Block | Checks for the placement of left curly braces ('{') for code blocks. | https://checkstyle.sourceforge.io/config_blocks.html#LeftCurly | |
NeedBracesCheck | CHECKSTYLE | Block | Checks for braces around code blocks. | https://checkstyle.sourceforge.io/config_blocks.html#NeedBraces | |
RightCurlyCheck | CHECKSTYLE | Block | Checks the placement of right curly braces ('}') for code blocks. | https://checkstyle.sourceforge.io/config_blocks.html#RightCurly | |
AvoidNoArgumentSuperConstructorCallCheck | CHECKSTYLE | Coding | Checks if call to superclass constructor without arguments is present. Such invocation is redundant because constructor body implicitly begins with a superclass constructor invocation super(); | https://checkstyle.sourceforge.io/config_coding.html#AvoidNoArgumentSuperConstructorCall | exceptionVariableName=expected |
CovariantEqualsCheck | CHECKSTYLE | Coding | Checks that classes and records which define a covariant equals() method also override method equals(Object). | https://checkstyle.sourceforge.io/config_coding.html#CovariantEquals | |
DeclarationOrderCheck | CHECKSTYLE | Coding | 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. | https://checkstyle.sourceforge.io/config_coding.html#DeclarationOrder | |
DefaultComesLastCheck | CHECKSTYLE | Coding | Check that the default is after all the cases in a switch statement. | https://checkstyle.sourceforge.io/config_coding.html#DefaultComesLast | |
EmptyStatementCheck | CHECKSTYLE | Coding | Detects empty statements (standalone ";" semicolon). Empty statements often introduce bugs that are hard to spot. | https://checkstyle.sourceforge.io/config_coding.html#EmptyStatement | |
EqualsAvoidNullCheck | CHECKSTYLE | Coding | Checks that any combination of String literals is on the left side of an equals() comparison. Also checks for String literals assigned to some field (such as someString.equals(anotherString = "text")). | https://checkstyle.sourceforge.io/config_coding.html#EqualsAvoidNull | |
EqualsHashCodeCheck | CHECKSTYLE | Coding | Checks that classes that either override equals() or hashCode() also overrides the other. This check only verifies that the method declarations match Object.equals(Object) and Object.hashCode() exactly to be considered an override. This check does not verify invalid method names, parameters other than Object, or anything else. | https://checkstyle.sourceforge.io/config_coding.html#EqualsHashCode | |
ExplicitInitializationCheck | CHECKSTYLE | Coding | Checks if any class or object member is explicitly initialized to default for its type value (null for object references, zero for numeric types and char and false for boolean. | https://checkstyle.sourceforge.io/config_coding.html#ExplicitInitialization | |
FallThroughCheck | CHECKSTYLE | Coding | Checks for fall-through in switch statements. Finds locations where a case contains Java code but lacks a break, return, throw or continue statement. | https://checkstyle.sourceforge.io/config_coding.html#FallThrough | |
InnerAssignmentCheck | CHECKSTYLE | Coding | Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);. | https://checkstyle.sourceforge.io/config_coding.html#InnerAssignment | |
IllegalInstantiationCheck | CHECKSTYLE | Coding | Checks for illegal instantiations where a factory method is preferred. | https://checkstyle.sourceforge.io/config_coding.html#IllegalInstantiation | |
IllegalTokenTextCheck | CHECKSTYLE | Coding | Checks specified tokens text for matching an illegal pattern. By default no tokens are specified. | https://checkstyle.sourceforge.io/config_coding.html#IllegalTokenText | token=STRING_LITERAL, CHAR_LITERAL, format=\\u00(08 |
MagicNumberCheck | CHECKSTYLE | Coding | Checks that there are no "magic numbers" where a magic number is a numeric literal that is not defined as a constant. By default, -1, 0, 1, and 2 are not considered to be magic numbers. | https://checkstyle.sourceforge.io/config_coding.html#MagicNumber | ignoreHashCodeMethod=true, ignoreAnnotation=true, ignoreFieldDeclaration=true |
MissingSwitchDefaultCheck | CHECKSTYLE | Coding | Checks that switch statement has a default clause. | https://checkstyle.sourceforge.io/config_coding.html#MissingSwitchDefault | |
MultipleVariableDeclarationsCheck | CHECKSTYLE | Coding | Checks that each variable declaration is in its own statement and on its own line. | https://checkstyle.sourceforge.io/config_coding.html#MultipleVariableDeclarations | |
NoCloneCheck | CHECKSTYLE | Coding | Checks that the clone method is not overridden from the Object class. | https://checkstyle.sourceforge.io/config_coding.html#NoClone | |
NoFinalizerCheck | CHECKSTYLE | Coding | Checks that there is no method finalize with zero parameters. | https://checkstyle.sourceforge.io/config_coding.html#NoFinalizer | |
OneStatementPerLineCheck | CHECKSTYLE | Coding | Checks that there is only one statement per line. | https://checkstyle.sourceforge.io/config_coding.html#OneStatementPerLine | |
PackageDeclarationCheck | CHECKSTYLE | Coding | Ensures that a class has a package declaration, and (optionally) whether the package name matches the directory name for the source file. | https://checkstyle.sourceforge.io/config_coding.html#PackageDeclaration | |
RequireThisCheck | CHECKSTYLE | Coding | 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. | https://checkstyle.sourceforge.io/config_coding.html#RequireThis | |
SimplifyBooleanExpressionCheck | CHECKSTYLE | Coding | Checks for over-complicated boolean expressions. Currently finds code like if (b == true), b | true, !false, etc. | |
SimplifyBooleanReturnCheck | CHECKSTYLE | Coding | Checks for over-complicated boolean return statements. | https://checkstyle.sourceforge.io/config_coding.html#SimplifyBooleanReturn | |
StringLiteralEqualityCheck | CHECKSTYLE | Coding | Checks that string literals are not used with == or !=. Since == will compare the object references, not the actual value of the strings, String.equals() should be used. | https://checkstyle.sourceforge.io/config_coding.html#StringLiteralEquality | |
SuperCloneCheck | CHECKSTYLE | Coding | Checks that an overriding clone() method invokes super.clone(). Does not check native methods, as they have no possible java defined implementation. | https://checkstyle.sourceforge.io/config_coding.html#SuperClone | |
SuperFinalizeCheck | CHECKSTYLE | Coding | Checks that an overriding finalize() method invokes super.finalize(). Does not check native methods, as they have no possible java defined implementation. | https://checkstyle.sourceforge.io/config_coding.html#SuperFinalize | |
UnnecessaryParenthesesCheck | CHECKSTYLE | Coding | Checks if unnecessary parentheses are used in a statement or expression. | https://checkstyle.sourceforge.io/config_coding.html#UnnecessaryParentheses | |
UnnecessarySemicolonAfterOuterTypeDeclarationCheck | CHECKSTYLE | Coding | Checks if unnecessary semicolon is used after type declaration. | https://checkstyle.sourceforge.io/config_coding.html#UnnecessarySemicolonAfterOuterTypeDeclaration | |
UnnecessarySemicolonAfterTypeMemberDeclarationCheck | CHECKSTYLE | Coding | Checks if unnecessary semicolon is used after type member declaration. | https://checkstyle.sourceforge.io/config_coding.html#UnnecessarySemicolonAfterTypeMemberDeclaration | |
UnnecessarySemicolonInEnumerationCheck | CHECKSTYLE | Coding | Checks if unnecessary semicolon is in enum definitions. Semicolon is not needed if enum body contains only enum constants. | https://checkstyle.sourceforge.io/config_coding.html#UnnecessarySemicolonInEnumeration | |
UnnecessarySemicolonInTryWithResourcesCheck | CHECKSTYLE | Coding | Checks if unnecessary semicolon is used in last resource declaration. | https://checkstyle.sourceforge.io/config_coding.html#UnnecessarySemicolonInTryWithResources | |
InnerTypeLastCheck | CHECKSTYLE | Design | Checks nested (internal) classes/interfaces are declared at the bottom of the primary (top-level) class after all init and static init blocks, method, constructor and field declarations. | https://checkstyle.sourceforge.io/config_design.html#InnerTypeLast | |
InterfaceIsTypeCheck | CHECKSTYLE | Design | Implements Joshua Bloch, Effective Java, Item 17 - Use Interfaces only to define types. According to Bloch, an interface should describe a type. It is therefore inappropriate to define an interface that does not contain any methods but only constants. The Standard interface javax.swing.SwingConstants is an example of an interface that would be flagged by this check. The check can be configured to also disallow marker interfaces like java.io.Serializable, that do not contain methods or constants at all. |
https://checkstyle.sourceforge.io/config_design.html#InterfaceIsType | |
MutableExceptionCheck | CHECKSTYLE | Design | Ensures that exception classes (classes with names conforming to some regular expression and explicitly extending classes with names conforming to other regular expression) are immutable, that is, that they have only final fields. The current algorithm is very simple: it checks that all members of exception are final. The user can still mutate an exception's instance (e.g. Throwable has a method called setStackTrace which changes the exception's stack trace). But, at least, all information provided by this exception type is unchangeable. |
https://checkstyle.sourceforge.io/config_design.html#MutableException | |
OneTopLevelClassCheck | CHECKSTYLE | Design | Checks that each top-level class, interface, enum or annotation resides in a source file of its own. Official description of a 'top-level' term: 7.6. Top Level Type Declarations. If file doesn't contains public class, interface, enum or annotation, top-level type is the first type in file. | https://checkstyle.sourceforge.io/config_design.html#OneTopLevelClass | |
VisibilityModifierCheck | CHECKSTYLE | Design | Checks visibility of class members. Only static final, immutable or annotated by specified annotation members may be public; other class members must be private unless the property protectedAllowed or packageAllowed is set. | https://checkstyle.sourceforge.io/config_design.html#VisibilityModifier | protectedAllowed=true |
AvoidStarImportCheck | CHECKSTYLE | Import | Checks that there are no import statements that use the * notation. | https://checkstyle.sourceforge.io/config_imports.html#AvoidStarImport | |
IllegalImportCheck | CHECKSTYLE | Import | Checks for imports from a set of illegal packages. | https://checkstyle.sourceforge.io/config_imports.html#IllegalImport | |
RedundantImportCheck | CHECKSTYLE | Import | Checks for redundant import statements. An import statement is considered redundant if: It is a duplicate of another import. This is, when a class is imported more than once. The class non-statically imported is from the java.lang package, e.g. importing java.lang.String. The class non-statically imported is from the same package as the current package. |
https://checkstyle.sourceforge.io/config_imports.html#RedundantImport | |
UnusedImportsCheck | CHECKSTYLE | Import | Checks for unused import statements. Checkstyle uses a simple but very reliable algorithm to report on unused import statements. An import statement is considered unused if: It is not referenced in the file. The algorithm does not support wild-card imports like import java.io.*;. Most IDE's provide very sophisticated checks for imports that handle wild-card imports. It is a duplicate of another import. This is when a class is imported more than once. The class imported is from the java.lang package. For example importing java.lang.String. The class imported is from the same package. Optionally: it is referenced in Javadoc comments. This check is on by default, but it is considered bad practice to introduce a compile time dependency for documentation purposes only. As an example, the import java.util.List would be considered referenced with the Javadoc comment {@link List}. The alternative to avoid introducing a compile time dependency would be to write the Javadoc comment as {@link java.util.List}. The main limitation of this check is handling the case where an imported type has the same name as a declaration, such as a member variable. |
https://checkstyle.sourceforge.io/config_imports.html#UnusedImports | |
ModifierOrderCheck | CHECKSTYLE | Modifier | Checks that the order of modifiers conforms to the suggestions in the Java Language specification, § 8.1.1, 8.3.1, 8.4.3 and 9.4. | https://checkstyle.sourceforge.io/config_modifier.html#ModifierOrder | |
RedundantModifierCheck | CHECKSTYLE | Modifier | Checks for redundant modifiers. The Java Language Specification strongly discourages the usage of public and abstract for method declarations in interface definitions as a matter of style. |
https://checkstyle.sourceforge.io/config_modifier.html#RedundantModifier | |
AbstractClassNameCheck | CHECKSTYLE | Naming | Ensures that the names of abstract classes conforming to some regular expression and check that abstract modifier exists. | https://checkstyle.sourceforge.io/config_naming.html#AbstractClassName | ignoreName=true |
CatchParameterNameCheck | CHECKSTYLE | Naming | Checks that catch parameter names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#CatchParameterName | |
ClassTypeParameterNameCheck | CHECKSTYLE | Naming | Checks that class type parameter names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#ClassTypeParameterName | format=^[A-Z]*$ |
ConstantNameCheck | CHECKSTYLE | Naming | Checks that constant names conform to a specified pattern. A constant is a static and final field or an interface/annotation field, except serialVersionUID and serialPersistentFields. | https://checkstyle.sourceforge.io/config_naming.html#ConstantName | |
InterfaceTypeParameterNameCheck | CHECKSTYLE | Naming | Checks that interface type parameter names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#InterfaceTypeParameterName | format=^[A-Z]*$ |
LambdaParameterNameCheck | CHECKSTYLE | Naming | Checks lambda parameter names. | https://checkstyle.sourceforge.io/config_naming.html#LambdaParameterName | |
LocalFinalVariableNameCheck | CHECKSTYLE | Naming | Checks that local final variable names conform to a specified pattern. A catch parameter and resources in try statements are considered to be a local, final variables. | https://checkstyle.sourceforge.io/config_naming.html#LocalFinalVariableName | |
LocalVariableNameCheck | CHECKSTYLE | Naming | Checks that local, non-final variable names conform to a specified pattern. A catch parameter is considered to be a local variable. | https://checkstyle.sourceforge.io/config_naming.html#LocalVariableName | |
MemberNameCheck | CHECKSTYLE | Naming | Checks that instance variable names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#MemberName | |
MethodNameCheck | CHECKSTYLE | Naming | Checks that method names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#MethodName | |
MethodTypeParameterNameCheck | CHECKSTYLE | Naming | Checks that method type parameter names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#MethodTypeParameterName | format=^[A-Z]*$ |
PackageNameCheck | CHECKSTYLE | Naming | Checks that package names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#PackageName | format=^[a-z]+(\.[a-z][a-z0-9]*)*$ |
ParameterNameCheck | CHECKSTYLE | Naming | Checks that method parameter names conform to a specified pattern. By using accessModifiers property it is possible to specify different formats for methods at different visibility levels. | https://checkstyle.sourceforge.io/config_naming.html#ParameterName | |
StaticVariableNameCheck | CHECKSTYLE | Naming | Checks that static, non-final variable names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#StaticVariableName | |
TypeNameCheck | CHECKSTYLE | Naming | Checks that type names conform to a specified pattern. | https://checkstyle.sourceforge.io/config_naming.html#TypeName | |
MethodLengthCheck | CHECKSTYLE | Size | Checks for long methods and constructors. | https://checkstyle.sourceforge.io/config_sizes.html#MethodLength | token=METHOD_DEF, max=40, countEmpty=false |
EmptyForIteratorPadCheck | CHECKSTYLE | Whitespace | Checks the padding of an empty for iterator; that is whether a white space is required at an empty for iterator, or such white space is forbidden. No check occurs if there is a line wrap at the iterator. | https://checkstyle.sourceforge.io/config_whitespace.html#EmptyForIteratorPad | |
EmptyLineSeparatorCheck | CHECKSTYLE | Whitespace | Checks for empty line separators before package, all import declarations, fields, constructors, methods, nested classes, static initializers and instance initializers. Checks for empty line separators before not only statements but implementation and documentation comments and blocks as well. |
https://checkstyle.sourceforge.io/config_whitespace.html#EmptyLineSeparator | allowMultipleEmptyLines=false, allowMultipleEmptyLinesInsideClassMembers=false |
GenericWhitespaceCheck | CHECKSTYLE | Whitespace | Checks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention. The convention is not configurable. Left angle bracket ("<"): should be preceded with whitespace only in generic methods definitions. should not be preceded with whitespace when it is precede method name or constructor. should not be preceded with whitespace when following type name. should not be followed with whitespace in all cases. Right angle bracket (">"): should not be preceded with whitespace in all cases. should be followed with whitespace in almost all cases, except diamond operators and when preceding method name or constructor. |
https://checkstyle.sourceforge.io/config_whitespace.html#GenericWhitespace | |
MethodParamPadCheck | CHECKSTYLE | Whitespace | Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list. That is, if the identifier and left parenthesis are on the same line, checks whether a space is required immediately after the identifier or such a space is forbidden. If they are not on the same line, reports a violation, unless configured to allow line breaks. To allow linebreaks after the identifier, set property allowLineBreaks to true. | https://checkstyle.sourceforge.io/config_whitespace.html#MethodParamPad | |
NoLineWrapCheck | CHECKSTYLE | Whitespace | Checks that chosen statements are not line-wrapped. By default this Check restricts wrapping import and package statements, but it's possible to check any statement. | https://checkstyle.sourceforge.io/config_whitespace.html#NoLineWrap | |
NoWhitespaceAfterCheck | CHECKSTYLE | Whitespace | Checks that there is no whitespace after a token. More specifically, it checks that it is not followed by whitespace, or (if linebreaks are allowed) all characters on the line after are whitespace. To forbid linebreaks after a token, set property allowLineBreaks to false. | https://checkstyle.sourceforge.io/config_whitespace.html#NoWhitespaceAfter | |
NoWhitespaceBeforeCheck | CHECKSTYLE | Whitespace | Checks that there is no whitespace before a token. More specifically, it checks that it is not preceded with whitespace, or (if linebreaks are allowed) all characters on the line before are whitespace. To allow linebreaks before a token, set property allowLineBreaks to true. No check occurs before semi-colons in empty for loop initializers or conditions. | https://checkstyle.sourceforge.io/config_whitespace.html#NoWhitespaceBefore | |
ParenPadCheck | CHECKSTYLE | Whitespace | Checks the policy on the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden. No check occurs at the right parenthesis after an empty for iterator, at the left parenthesis before an empty for initialization, or at the right parenthesis of a try-with-resources resource specification where the last resource variable has a trailing semi-colon. Use Check EmptyForIteratorPad to validate empty for iterators and EmptyForInitializerPad to validate empty for initializers. Typecasts are also not checked, as there is TypecastParenPad to validate them. | https://checkstyle.sourceforge.io/config_whitespace.html#ParenPad | |
SeparatorWrapCheck/SeparatorWrapDotCheck | CHECKSTYLE | Whitespace | Checks line wrapping with separators. | https://checkstyle.sourceforge.io/config_whitespace.html#SeparatorWrap | id=SeparatorWrapDotCheck, tokens=DOT, option=nl |
SeparatorWrapCheck/SeparatorWrapCommaCheck | CHECKSTYLE | Whitespace | Checks line wrapping with separators. | https://checkstyle.sourceforge.io/config_whitespace.html#SeparatorWrap | id=SeparatorWrapCommaCheck, tokens=COMMA, option=EOL |
SingleSpaceSeparatorCheck | CHECKSTYLE | Whitespace | Checks that non-whitespace characters are separated by no more than one whitespace. Separating characters by tabs or multiple spaces will be reported. Currently the check doesn't permit horizontal alignment. To inspect whitespaces before and after comments, set the property validateComments to true. | https://checkstyle.sourceforge.io/config_whitespace.html#SingleSpaceSeparator | validateComments=false |
TypecastParenPadCheck | CHECKSTYLE | Whitespace | Checks the policy on the padding of parentheses for typecasts. That is, whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden. | https://checkstyle.sourceforge.io/config_whitespace.html#TypecastParenPad | |
WhitespaceAfterCheck | CHECKSTYLE | Whitespace | Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator. Use Check EmptyForIteratorPad to validate empty for iterators. | https://checkstyle.sourceforge.io/config_whitespace.html#WhitespaceAfter | |
WhitespaceAroundCheck | CHECKSTYLE | Whitespace | Checks that a token is surrounded by whitespace. Empty constructor, method, class, enum, interface, loop bodies (blocks), lambdas of the form | https://checkstyle.sourceforge.io/config_whitespace.html#WhitespaceAround | |
ArrayTypeStyleCheck | CHECKSTYLE | Misc | Checks the style of array type definitions. Some like Java style: public static void main(String[] args) and some like C style: public static void main(String args[]). | https://checkstyle.sourceforge.io/config_misc.html#ArrayTypeStyle | |
OuterTypeFilenameCheck | CHECKSTYLE | Misc | Checks that the outer type name and the file name match. For example, the class Foo must be in a file named Foo.java. | https://checkstyle.sourceforge.io/config_misc.html#OuterTypeFilename | |
UpperEllCheck | CHECKSTYLE | Misc | Checks that long constants are defined with an upper ell. That is 'L' and not 'l'. This is in accordance with the Java Language Specification, Section 3.10.1. | https://checkstyle.sourceforge.io/config_misc.html#UpperEll | |
SuppressionCommentFilter | CHECKSTYLE | Filter | Filter SuppressionCommentFilter uses pairs of comments to suppress audit events. | https://checkstyle.sourceforge.io/config_filters.html#SuppressionCommentFilter | |
SuppressWarningsHolder | CHECKSTYLE | Annotation | Maintains a set of check suppressions from @SuppressWarnings annotations. It allows to prevent Checkstyle from reporting violations from parts of code that were annotated with @SuppressWarnings and using name of the check to be excluded. You can also define aliases for check names that need to be suppressed. | https://checkstyle.sourceforge.io/config_annotation.html#SuppressWarningsHolder | |
RegexpSinglelineCheck/RegexpSinglelineTrailingSpaceCheck | CHECKSTYLE | Regexp | Checks that a specified pattern matches a single line in any file type. | https://checkstyle.sourceforge.io/config_regexp.html#RegexpSingleline | id=RegexpSinglelineTrailingSpaceCheck, format=\s+$, minimum=0, maximum=0, message=Line has trailing spaces. |
RegexpSinglelineCheck/RegexpSinglelineParenthesisCheck | CHECKSTYLE | Regexp | Checks that a specified pattern matches a single line in any file type. | https://checkstyle.sourceforge.io/config_regexp.html#RegexpSingleline | id=RegexpSinglelineParenthesisCheck, format=^\s*(for |
RegexpSinglelineCheck/RegexpSinglelineEnhancedForLoopCheck | CHECKSTYLE | Regexp | Checks that a specified pattern matches a single line in any file type. | https://checkstyle.sourceforge.io/config_regexp.html#RegexpSingleline | id=RegexpSinglelineEnhancedForLoopCheck, format=^\s*for \(.*?([^ ]: |
RegexpSinglelineCheck (no author check) | CHECKSTYLE | Regexp | Checks that a specified pattern matches a single line in any file type. Used for max class author size check. | https://checkstyle.sourceforge.io/config_regexp.html#RegexpSingleline | fileExtensions=java, format=^\s*\*\s*@author, minimum=1, maximum=10, message=Javadoc has illegal ''@author'' tag. |
RegexpSinglelineCheck (System.out.print check) | CHECKSTYLE | Regexp | Checks that a specified pattern matches a single line in any file type. Using System.out.print is forbidden. | https://checkstyle.sourceforge.io/config_regexp.html#RegexpSingleline | fileExtensions=java, format=System.out.print, message=Using System.out.print is forbidden. Please log. |
RegexpSinglelineCheck (System.err.print check) | CHECKSTYLE | Regexp | Checks that a specified pattern matches a single line in any file type. Using System.err.print is forbidden. | https://checkstyle.sourceforge.io/config_regexp.html#RegexpSingleline | fileExtensions=java, format=System.err.print, message=Using System.err.print is forbidden. Please log. |
RegexpSinglelineCheck (printStackTrace() check) | CHECKSTYLE | Regexp | Checks that a specified pattern matches a single line in any file type. Using .printStackTrace() is forbidden. | https://checkstyle.sourceforge.io/config_regexp.html#RegexpSingleline | fileExtensions=java, format=.printStackTrace(), message=Using e.printStackTrace() is forbidden. Rethrow, log or handle the exception. |
FileLengthCheck | CHECKSTYLE | Size | Checks for long source files. | https://checkstyle.sourceforge.io/config_sizes.html#FileLength | fileExtensions=java, max=1500 |
LineLengthCheck | CHECKSTYLE | Size | Checks for long lines. | https://checkstyle.sourceforge.io/config_sizes.html#LineLength | fileExtensions=java, max=120, ignorePattern=^package.* |
FileTabCharacterCheck | CHECKSTYLE | Whitespace | Checks that there are no tab characters ('\t') in the source code. | https://checkstyle.sourceforge.io/config_whitespace.html#FileTabCharacter | eachLine=true |
TranslationCheck | CHECKSTYLE | Misc | Ensures the correct translation of code by checking property files for consistency regarding their keys. Two property files describing one and the same context are consistent if they contain the same keys. TranslationCheck also can check an existence of required translations which must exist in project, if requiredTranslations option is used. | https://checkstyle.sourceforge.io/config_misc.html#Translation | |
UniquePropertiesCheck | CHECKSTYLE | Misc | Detects duplicated keys in properties files. | https://checkstyle.sourceforge.io/config_misc.html#UniqueProperties | |
SuppressionSingleFilter/MagicNumber | CHECKSTYLE | Filter | Filter SuppressionSingleFilter suppresses audit events for Checks violations in the specified file, class, checks, message, module id, lines, and columns. Used to skip MagicNumber check on tests. | https://checkstyle.sourceforge.io/config_filters.html#SuppressionSingleFilter | checks=MagicNumber, files=.*[\\/]src[\\/](test |
SuppressionSingleFilter/MethodLength | CHECKSTYLE | Filter | Filter SuppressionSingleFilter suppresses audit events for Checks violations in the specified file, class, checks, message, module id, lines, and columns. Used to skip MethodLength check on tests. | https://checkstyle.sourceforge.io/config_filters.html#SuppressionSingleFilter | checks=MethodLength, files=.*[\\/]src[\\/](test |
SuppressWarningsFilter | CHECKSTYLE | Filter | Filter SuppressWarningsFilter uses annotation {@code SuppressWarnings} to suppress audit events. | https://checkstyle.sourceforge.io/config_filters.html#SuppressWarningsFilter | |
SuppressWithPlainTextCommentFilter | CHECKSTYLE | Filter | Filter SuppressWithPlainTextCommentFilter uses plain text to suppress audit events. The filter can be used only to suppress audit events received from the checks which implement FileSetCheck interface. In other words, the checks which have Checker as a parent module. The filter knows nothing about AST, it treats only plain text comments and extracts the information required for suppression from the plain text comments. Currently the filter supports only single line comments. | https://checkstyle.sourceforge.io/config_filters.html#SuppressWithPlainTextCommentFilter | |
ForbiddenAnnotationCheck | SH | Annotation | Checks for prevent to use blocked annotations on class or interface. | forbiddenAnnotations=com.clovify.lyso.core.annotation.LysoRepository | |
ForbiddenAnnotationKeyCheck | SH | Annotation | Checks to forbidden usage the given key inside given annotation. | annotationForbiddenKeysMap=javax.persistence.Column:unique | |
GeneratedPrimaryKeyNameCheck | SH | Naming | Checks for generated primary key name of the typed class, it should be 'id'. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass, idAnnotation=javax.persistence.Id, generatedValueAnnotation=javax.persistence.GeneratedValue, suggestedGeneratedPrimaryKeyName=id | |
LogDataTableCheck | SH | Design | Checks the variables in log table and show variables to move to the log data table. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass, columnAnnotation=javax.persistence.Column, limitLength=255 | |
MissingAbstractModifierCheck | SH | Modifier | Checks 'abstract' modifier for entity mapped super classes. | abstractTypeAnnotation=javax.persistence.MappedSuperclass | |
MissingEqualsHashCodeCheck | SH | Method | Checks whether there is or not a default equals and hashCode methods in typed class. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass, idAnnotation=javax.persistence.Id | |
MissingGetterCheck | SH | Method | Checks if there is no getter for a variable of typed class. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass | |
MissingSetterCheck | SH | Method | Checks if there is no setter for a variable of typed class. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass | |
MissingToStringCheck | SH | Method | Checks whether there is or not toString method in typed class. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass | |
MissingVariableCheck | SH | Variable | Checks that mandatory to declare some variables in typed class. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass, mandatoryVariables=createdAt | |
TableIdentifierNameCheck/IndexNameCheck | SH | Naming | Checks the index name format of the class, it should be like table_name_field1_name_field2_name_index and checks the unique constraint name format of the class | id=IndexNameCheck, tableAnnotation=javax.persistence.Table, identifierAnnotation=javax.persistence.Index, key=indexes, keyName=name, keyColumns=columnList, suggestedSuffix=index, maxLength=64, regex=^[a-z0-9_]*$ | |
TableIdentifierNameCheck/UniqueConstraintNameCheck | SH | Naming | Checks the unique constraint name format of the class, it should be like table_name_field1_name_field2_name_uk. | id=UniqueConstraintNameCheck, tableAnnotation=javax.persistence.Table, identifierAnnotation=javax.persistence.UniqueConstraint, key=uniqueConstraints, keyName=name, keyColumns=columnNames, suggestedSuffix=uk, maxLength=64, regex=^[a-z0-9_]*$ | |
VariableAnnotationKeyValueCheck | SH | Annotation | Checks that a variable has given key and value pair in given annotation. | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass, variableAnnotationKeyValueTable=createdAt:javax.persistence.Column:nullable:false, lastUpdatedAt:javax.persistence.Column:nullable:false | |
VariableDeclarationOrderCheck | SH | Coding | Checks for variable definitions should be at the given order of the class. | variableName=LOGGER, declarationOrder=1 | |
VariableNameCheck | SH | Naming | Checks for variable's names of the class, names should not be in context of the class name. | typeAnnotation=javax.persistence.Entity | |
ColumnDefaultCheck | SH | Annotation | Check assign value and column default annotation value matching for fields of a class | typeAnnotation=javax.persistence.Entity, abstractTypeAnnotation=javax.persistence.MappedSuperclass, columnAnnotation=javax.persistence.Column, columnDefaultAnnotation=org.hibernate.annotations.ColumnDefault, excludedColumnDefaultAnnotationValueRegex=^.*?(\bCURRENT_TIMESTAMP\b |