Uses of Class
com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
Packages that use AbstractCheck Package Description com.puppycrawl.tools.checkstyle.checks Contains the checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.annotation Contains the Annotation checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.blocks Contains the Block checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.coding Contains the Coding checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.design Contains the Class Design checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.imports Contains the Imports checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.indentation Contains all classes required for the indentation check.com.puppycrawl.tools.checkstyle.checks.javadoc Contains the Javadoc checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.metrics Contains the Metrics checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.modifier Contains the modifier checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.naming Contains the Naming conventions checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.regexp Contains the regular expression checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.sizes Contains the Size Violations checks that are bundled with the main distribution.com.puppycrawl.tools.checkstyle.checks.whitespace Contains the Whitespace checks that are bundled with the main distribution. -
-
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks Modifier and Type Class Description classArrayTypeStyleCheckChecks the style of array type definitions.classAvoidEscapedUnicodeCharactersCheckRestrict using Unicode escapes (such as\u221e).classDescendantTokenCheckChecks for restricted tokens beneath other tokens.classFinalParametersCheckCheck that method/constructor/catch/foreach parameters are final.classOuterTypeFilenameCheckChecks that the outer type name and the file name match.classSuppressWarningsHolderMaintains a set of check suppressions fromSuppressWarningsannotations.classTodoCommentCheckA check for 'TODO:' comments.classTrailingCommentCheckThe check to ensure that comments are the only thing on a line.classUncommentedMainCheckDetects uncommented main methods.classUpperEllCheckChecks that long constants are defined with an upper ell. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.annotation
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.annotation Modifier and Type Class Description classAnnotationLocationCheckCheck location of annotation on language elements.classAnnotationOnSameLineCheckThe check does verifying that annotations are located on the same line with their targets.classAnnotationUseStyleCheckThis check controls the style with the usage of annotations.classMissingDeprecatedCheckThis class is used to verify that both theDeprecatedannotation and the deprecated javadoc tag are present when either one is present.classMissingOverrideCheckThis class is used to verify that theOverrideannotation is present when the inheritDoc javadoc tag is present.classPackageAnnotationCheckThis check makes sure that all package annotations are in the package-info.java file.classSuppressWarningsCheckThis check allows you to specify what warnings thatSuppressWarningsis not allowed to suppress. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.blocks
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.blocks Modifier and Type Class Description classAvoidNestedBlocksCheckFinds nested blocks.classEmptyBlockCheckChecks for empty blocks.classEmptyCatchBlockCheckChecks for empty catch blocks.classLeftCurlyCheckChecks the placement of left curly braces.classNeedBracesCheckChecks for braces around code blocks.classRightCurlyCheckChecks the placement of right curly braces. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.coding
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.coding Modifier and Type Class Description classAbstractSuperCheckAbstract class for checking that an overriding method with no parameters invokes the super method.classArrayTrailingCommaCheckChecks if array initialization contains optional trailing comma.classAvoidInlineConditionalsCheckDetects inline conditionals.classCovariantEqualsCheckChecks that if a class defines a covariant method equals, then it defines method equals(java.lang.Object).classDeclarationOrderCheckChecks that the parts of a class or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.classDefaultComesLastCheckCheck that thedefaultis after all thecases in aswitchstatement.classEmptyStatementCheckDetects empty statements (standalone ';').classEqualsAvoidNullCheckChecks that any combination of String literals is on the left side of an equals() comparison.classEqualsHashCodeCheckChecks that classes that either overrideequals()orhashCode()also overrides the other.classExplicitInitializationCheckChecks if any class or object member explicitly initialized to default for its type value (nullfor object references, zero for numeric types andcharandfalseforboolean.classFallThroughCheckChecks for fall through in switch statements Finds locations where a case contains Java code - but lacks a break, return, throw or continue statement.classFinalLocalVariableCheckEnsures that local variables that never get their values changed, must be declared final.classHiddenFieldCheckChecks that a local variable or a parameter does not shadow a field that is defined in the same class.classIllegalCatchCheckCatching java.lang.Exception, java.lang.Error or java.lang.RuntimeException is almost never acceptable.classIllegalInstantiationCheckChecks for illegal instantiations where a factory method is preferred.classIllegalThrowsCheckThrowing java.lang.Error or java.lang.RuntimeException is almost never acceptable.classIllegalTokenCheckChecks for illegal tokens.classIllegalTokenTextCheckChecks for illegal token text.classIllegalTypeCheckChecks that particular classes or interfaces are never used.classInnerAssignmentCheckChecks for assignments in subexpressions, such as inString s = Integer.toString(i = 2);.classMagicNumberCheckChecks that there are no "magic numbers" where a magic number is a numeric literal that is not defined as a constant.classMissingCtorCheckChecks that classes (except abstract one) define a ctor and don't rely on the default one.classMissingSwitchDefaultCheckChecks that switch statement has "default" clause.classModifiedControlVariableCheckCheck for ensuring that for loop control variables are not modified inside the for block.classMultipleStringLiteralsCheckChecks for multiple occurrences of the same string literal within a single file.classMultipleVariableDeclarationsCheckChecks that each variable declaration is in its own statement and on its own line.classNestedForDepthCheckCheck the number of nestedfor-statements.classNestedIfDepthCheckRestricts nested if-else blocks to a specified depth (default = 1).classNestedTryDepthCheckRestricts nested try-catch-finally blocks to a specified depth (default = 1).classNoCloneCheckChecks that the clone method is not overridden from the Object class.classNoFinalizerCheckChecks that no method having zero parameters is defined using the name finalize.classOneStatementPerLineCheckRestricts the number of statements per line to one.classOverloadMethodsDeclarationOrderCheckChecks that overload methods are grouped together.classPackageDeclarationCheckEnsures there is a package declaration.classParameterAssignmentCheckDisallow assignment of parameters.classRequireThisCheckChecks that code doesn't rely on the "this" default.classReturnCountCheckRestricts the number of return statements in methods, constructors and lambda expressions (2 by default).classSimplifyBooleanExpressionCheckChecks for overly complicated boolean expressions.classSimplifyBooleanReturnCheckChecks for overly complicated boolean return statements.classStringLiteralEqualityCheckChecks that string literals are not used with==or!=.classSuperCloneCheckChecks that an overriding clone() method invokes super.clone().classSuperFinalizeCheckChecks that an overriding finalize() method invokes super.finalize().classUnnecessaryParenthesesCheckChecks if unnecessary parentheses are used in a statement or expression.classVariableDeclarationUsageDistanceCheckChecks the distance between declaration of variable and its first usage. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.design
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.design Modifier and Type Class Description classDesignForExtensionCheckThe check finds classes that are designed for extension (subclass creation).classFinalClassCheckChecks that class which has only private ctors is declared as final.classHideUtilityClassConstructorCheckMake sure that utility classes (classes that contain only static methods) do not have a public constructor.classInnerTypeLastCheckCheck nested (internal) classes/interfaces are declared at the bottom of the class after all method and field declarations.classInterfaceIsTypeCheckImplements Bloch, Effective Java, Item 17 - Use Interfaces only to define types.classMutableExceptionCheckEnsures that exceptions (classes with names conforming to some regular expression and explicitly extending classes with names conforming to other regular expression) are immutable.classOneTopLevelClassCheckChecks that each top-level class, interface or enum resides in a source file of its own.classThrowsCountCheckRestricts throws statements to a specified count (default = 4).classVisibilityModifierCheckChecks visibility of class members. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.imports
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.imports Modifier and Type Class Description classAvoidStarImportCheckCheck that finds import statements that use the * notation.classAvoidStaticImportCheckCheck that finds static imports.classCustomImportOrderCheckChecks that the groups of import declarations appear in the order specified by the user.classIllegalImportCheckChecks for imports from a set of illegal packages.classImportControlCheckCheck that controls what can be imported in each package and file.classImportOrderCheckChecks the ordering/grouping of imports.classRedundantImportCheckChecks for imports that are redundant.classUnusedImportsCheckChecks for unused import statements. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.indentation
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.indentation Modifier and Type Class Description classCommentsIndentationCheckThis Check controls the indentation between comments and surrounding code.classIndentationCheckChecks correct indentation of Java Code. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.javadoc
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.javadoc Modifier and Type Class Description classAbstractJavadocCheckBase class for Checks that process Javadoc comments.classAbstractTypeAwareCheckDeprecated.Checkstyle is not type aware tool and all Checks derived from this class are potentially unstable.classAtclauseOrderCheckChecks the order of javadoc block-tags or javadoc tags.classJavadocMethodCheckChecks the Javadoc of a method or constructor.classJavadocParagraphCheckChecks that: There is one blank line between each of two paragraphs and one blank line before the at-clauses block if it is present. Each paragraph but the first has <p> immediately before the first word, with no space after.classJavadocStyleCheckCustom Checkstyle Check to validate Javadoc.classJavadocTagContinuationIndentationCheckChecks the indentation of the continuation lines in at-clauses.classJavadocTypeCheckChecks the Javadoc of a type.classJavadocVariableCheckChecks that a variable has Javadoc comment.classNonEmptyAtclauseDescriptionCheckChecks that the at-clause tag is followed by description .classSingleLineJavadocCheckChecks that a JavaDoc block can fit on a single line and doesn't contain at-clauses.classSummaryJavadocCheckChecks that Javadoc summary sentence does not contain phrases that are not recommended to use.classWriteTagCheckOutputs a JavaDoc tag as information. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.metrics
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.metrics Modifier and Type Class Description classAbstractClassCouplingCheckBase class for coupling calculation.classBooleanExpressionComplexityCheckRestricts nested boolean operators (&&, ||, &, | and ^) to a specified depth (default = 3).classClassDataAbstractionCouplingCheckThis metric measures the number of instantiations of other classes within the given class.classClassFanOutComplexityCheckThe number of other classes a given class relies on.classCyclomaticComplexityCheckChecks cyclomatic complexity against a specified limit.classJavaNCSSCheckThis check calculates the Non Commenting Source Statements (NCSS) metric for java source files and methods.classNPathComplexityCheckChecks the npath complexity against a specified limit (default = 200). -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.modifier
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.modifier Modifier and Type Class Description classInterfaceMemberImpliedModifierCheckChecks for implicit modifiers on interface members and nested types.classModifierOrderCheckChecks that the order of modifiers conforms to the suggestions in the Java Language specification, sections 8.1.1, 8.3.1 and 8.4.3.classRedundantModifierCheckChecks for redundant modifiers in interface and annotation definitions, final modifier on methods of final classes, innerinterfacedeclarations that are declared asstatic, non public class constructors and enum constructors, nested enum definitions that are declared asstatic. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.naming
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.naming Modifier and Type Class Description classAbbreviationAsWordInNameCheckThe Check validate abbreviations(consecutive capital letters) length in identifier name, it also allows to enforce camel case naming.classAbstractAccessControlNameCheckAbstract class for checking a class member (field/method)'s name conforms to a format specified by the format property.classAbstractClassNameCheckEnsures that the names of abstract classes conforming to some regular expression and check thatabstractmodifier exists.classAbstractNameCheckAbstract class for checking that names conform to a specified format.classAbstractTypeParameterNameCheckDeprecated.Checkstyle will not support abstract checks anymore.classCatchParameterNameCheckChecks thatcatchparameter names conform to a format specified by the format property.classClassTypeParameterNameCheckChecks that class type parameter names conform to a format specified by the format property.classConstantNameCheckChecks that constant names conform to a format specified by the format property.classInterfaceTypeParameterNameCheckChecks that interface type parameter names conform to a format specified by the format property.classLambdaParameterNameCheckCheck to verify lambda parameter names.classLocalFinalVariableNameCheckChecks that local final variable names conform to a format specified by the format property.classLocalVariableNameCheckChecks that local, non-finalvariable names conform to a format specified by the format property.classMemberNameCheckChecks that instance variable names conform to a format specified by the format property.classMethodNameCheckChecks that method names conform to a format specified by the format property.classMethodTypeParameterNameCheckChecks that method type parameter names conform to a format specified by the format property.classPackageNameCheckChecks that package names conform to a format specified by the format property.classParameterNameCheckChecks that method parameter names conform to a format specified by the format property.classStaticVariableNameCheckChecks thatstatic, non-finalvariable names conform to a format specified by the format property.classTypeNameCheckChecks that type names for classes, interfaces, enums, and annotations conform to a format specified by the format property. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.regexp
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.regexp Modifier and Type Class Description classRegexpCheckA check that makes sure that a specified pattern exists (or not) in the file.classRegexpSinglelineJavaCheckImplementation of a check that looks for a single line in Java files. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.sizes
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.sizes Modifier and Type Class Description classAnonInnerLengthCheckChecks for long anonymous inner classes.classExecutableStatementCountCheckRestricts the number of executable statements to a specified limit (default = 30).classLineLengthCheckChecks for long lines.classMethodCountCheckChecks the number of methods declared in each type declaration by access modifier or total count.classMethodLengthCheckChecks for long methods.classOuterTypeNumberCheckChecks for the number of defined types at the "outer" level.classParameterNumberCheckChecks the number of parameters that a method or constructor has. -
Uses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.whitespace
Subclasses of AbstractCheck in com.puppycrawl.tools.checkstyle.checks.whitespace Modifier and Type Class Description classAbstractParenPadCheckAbstract class for checking the padding of parentheses.classEmptyForInitializerPadCheckChecks the padding of an empty for initializer; that is whether a space is required at an empty for initializer, or such spaces are forbidden.classEmptyForIteratorPadCheckChecks the padding of an empty for iterator; that is whether a space is required at an empty for iterator, or such spaces are forbidden.classEmptyLineSeparatorCheckChecks for empty line separators after header, package, all import declarations, fields, constructors, methods, nested classes, static initializers and instance initializers.classGenericWhitespaceCheckChecks that the whitespace around the Generic tokens (angle brackets) "<" and ">" are correct to the typical convention.classMethodParamPadCheckChecks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list.classNoLineWrapCheckChecks that chosen statements are not line-wrapped.classNoWhitespaceAfterCheckChecks that there is no whitespace after a token.classNoWhitespaceBeforeCheckChecks that there is no whitespace before a token.classOperatorWrapCheckChecks line wrapping for operators.classParenPadCheckChecks 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.classSeparatorWrapCheckChecks line wrapping with separators.classSingleSpaceSeparatorCheckChecks that non-whitespace characters are separated by no more than one whitespace.classTypecastParenPadCheckChecks the padding of parentheses for typecasts.classWhitespaceAfterCheckChecks 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.classWhitespaceAroundCheckChecks that a token is surrounded by whitespace.
-