diff --git a/README.md b/README.md index 08bbd34..ced14f8 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,215 @@ You need to include `checkstyle` as the version bundled with the `maven-checksty ```` +## All Checks + +* [AbbreviationAsWordInName](#AbbreviationAsWordInName) - checkstyle - enabled +* [AbstractClassName](#AbstractClassName) - checkstyle - enabled +* [AnnotationLocation](#AnnotationLocation) - checkstyle - enabled +* [AnnotationUseStyle](#AnnotationUseStyle) - checkstyle - enabled +* [AnonInnerLength](#AnonInnerLength) - checkstyle - enabled +* [ArrayTypeStyle](#ArrayTypeStyle) - checkstyle - enabled +* [AtclauseOrder](#AtclauseOrder) - checkstyle - enabled +* [AvoidEscapedUnicodeCharacters](#AvoidEscapedUnicodeCharacters) - checkstyle - enabled +* [AvoidNestedBlocks](#AvoidNestedBlocks) - checkstyle - enabled +* [AvoidStarImport](#AvoidStarImport) - checkstyle - enabled +* [AvoidStaticImport](#AvoidStaticImport) - checkstyle - enabled +* [BooleanExpressionComplexity](#BooleanExpressionComplexity) - checkstyle - enabled +* [CatchParameterName](#CatchParameterName) - checkstyle - enabled +* [ClassDataAbstractionCoupling](#ClassDataAbstractionCoupling) - checkstyle - enabled +* [ClassFanOutComplexity](#ClassFanOutComplexity) - checkstyle - enabled +* [ClassTypeParameterName](#ClassTypeParameterName) - checkstyle - enabled +* [CommentsIndentation](#CommentsIndentation) - checkstyle - enabled +* [ConstantName](#ConstantName) - checkstyle - enabled +* [CovariantEquals](#CovariantEquals) - checkstyle - enabled +* [CyclomaticComplexity](#CyclomaticComplexity) - checkstyle - enabled +* [DeclarationOrder](#DeclarationOrder) - checkstyle - enabled +* [DefaultComesLast](#DefaultComesLast) - checkstyle - enabled +* [DesignForExtension](#DesignForExtension) - checkstyle - enabled +* [EmptyBlock](#EmptyBlock) - checkstyle - enabled +* [EmptyCatchBlock](#EmptyCatchBlock) - checkstyle - enabled +* [EmptyForInitializerPad](#EmptyForInitializerPad) - checkstyle - enabled +* [EmptyForIteratorPad](#EmptyForIteratorPad) - checkstyle - enabled +* [EmptyLineSeparator](#EmptyLineSeparator) - checkstyle - enabled +* [EmptyStatement](#EmptyStatement) - checkstyle - enabled +* [EqualsHashCode](#EqualsHashCode) - checkstyle - enabled +* [ExecutableStatementCount](#ExecutableStatementCount) - checkstyle - enabled +* [ExplicitInitialization](#ExplicitInitialization) - checkstyle - enabled +* [FallThrough](#FallThrough) - checkstyle - enabled +* [FileLength](#FileLength) - checkstyle - enabled +* [FileTabCharacter](#FileTabCharacter) - checkstyle - enabled +* [FinalClass](#FinalClass) - checkstyle - enabled +* [FinalParameters](#FinalParameters) - checkstyle - enabled +* [GenericWhitespace](#GenericWhitespace) - checkstyle - enabled +* [HiddenField](#HiddenField) - checkstyle - enabled +* [HideUtilityClassConstructor](#HideUtilityClassConstructor) - checkstyle - enabled +* [IllegalCatch](#IllegalCatch) - checkstyle - enabled +* [IllegalImport](#IllegalImport) - checkstyle - enabled +* [IllegalThrows](#IllegalThrows) - checkstyle - enabled +* [IllegalType](#IllegalType) - checkstyle - enabled +* [InnerAssignment](#InnerAssignment) - checkstyle - enabled +* [InnerTypeLast](#InnerTypeLast) - checkstyle - enabled +* [InterfaceIsType](#InterfaceIsType) - checkstyle - enabled +* [JavadocMethod](#JavadocMethod) - checkstyle - enabled +* [JavadocPackage](#JavadocPackage) - checkstyle - enabled +* [JavadocParagraph](#JavadocParagraph) - checkstyle - enabled +* [JavadocStyle](#JavadocStyle) - checkstyle - enabled +* [JavadocType](#JavadocType) - checkstyle - enabled +* [JavaNCSS](#JavaNCSS) - checkstyle - enabled +* [LeftCurly](#LeftCurly) - checkstyle - enabled +* [LineLength](#LineLength) - checkstyle - enabled +* [LocalFinalVariableName](#LocalFinalVariableName) - checkstyle - enabled +* [LocalVariableName](#LocalVariableName) - checkstyle - enabled +* [MagicNumber](#MagicNumber) - checkstyle - enabled +* [MemberName](#MemberName) - checkstyle - enabled +* [MethodCount](#MethodCount) - checkstyle - enabled +* [MethodLength](#MethodLength) - checkstyle - enabled +* [MethodName](#MethodName) - checkstyle - enabled +* [MethodParamPad](#MethodParamPad) - checkstyle - enabled +* [MissingDeprecated](#MissingDeprecated) - checkstyle - enabled +* [MissingSwitchDefault](#MissingSwitchDefault) - checkstyle - enabled +* [ModifiedControlVariable](#ModifiedControlVariable) - checkstyle - enabled +* [ModifierOrder](#ModifierOrder) - checkstyle - enabled +* [MultipleStringLiterals](#MultipleStringLiterals) - checkstyle - enabled +* [MultipleVariableDeclarations](#MultipleVariableDeclarations) - checkstyle - enabled +* [MutableException](#MutableException) - checkstyle - enabled +* [NeedBraces](#NeedBraces) - checkstyle - enabled +* [NestedForDepth](#NestedForDepth) - checkstyle - enabled +* [NestedIfDepth](#NestedIfDepth) - checkstyle - enabled +* [NestedTryDepth](#NestedTryDepth) - checkstyle - enabled +* [NewlineAtEndOfFile](#NewlineAtEndOfFile) - checkstyle - enabled +* [NoClone](#NoClone) - checkstyle - enabled +* [NonEmptyAtclauseDescription](#NonEmptyAtclauseDescription) - checkstyle - enabled +* [NoWhitespaceAfter](#NoWhitespaceAfter) - checkstyle - enabled +* [NoWhitespaceBefore](#NoWhitespaceBefore) - checkstyle - enabled +* [NPathComplexity](#NPathComplexity) - checkstyle - enabled +* [OneStatementPerLine](#OneStatementPerLine) - checkstyle - enabled +* [OneTopLevelClass](#OneTopLevelClass) - checkstyle - enabled +* [OperatorWrap](#OperatorWrap) - checkstyle - enabled +* [OuterTypeFilename](#OuterTypeFilename) - checkstyle - enabled +* [OverloadMethodsDeclarationOrder](#OverloadMethodsDeclarationOrder) - checkstyle - enabled +* [PackageDeclaration](#PackageDeclaration) - checkstyle - enabled +* [PackageName](#PackageName) - checkstyle - enabled +* [ParameterName](#ParameterName) - checkstyle - enabled +* [ParameterNumber](#ParameterNumber) - checkstyle - enabled +* [ParenPad](#ParenPad) - checkstyle - enabled +* [RedundantImport](#RedundantImport) - checkstyle - enabled +* [RedundantModifier](#RedundantModifier) - checkstyle - enabled +* [ReturnCount](#ReturnCount) - checkstyle - enabled +* [RightCurly](#RightCurly) - checkstyle - enabled +* [SeparatorWrap](#SeparatorWrap) - checkstyle - enabled +* [SimplifyBooleanExpression](#SimplifyBooleanExpression) - checkstyle - enabled +* [SimplifyBooleanReturn](#SimplifyBooleanReturn) - checkstyle - enabled +* [SingleSpaceSeparator](#SingleSpaceSeparator) - checkstyle - enabled +* [StaticVariableName](#StaticVariableName) - checkstyle - enabled +* [StringLiteralEquality](#StringLiteralEquality) - checkstyle - enabled +* [SuppressWarningsHolder](#SuppressWarningsHolder) - checkstyle - enabled +* [ThrowsCount](#ThrowsCount) - checkstyle - enabled +* [TodoComment](#TodoComment) - checkstyle - enabled +* [TrailingComment](#TrailingComment) - checkstyle - enabled +* [TypecastParenPad](#TypecastParenPad) - checkstyle - enabled +* [TypeName](#TypeName) - checkstyle - enabled +* [UnnecessaryParentheses](#UnnecessaryParentheses) - checkstyle - enabled +* [UnusedImports](#UnusedImports) - checkstyle - enabled +* [UpperEll](#UpperEll) - checkstyle - enabled +* [VariableDeclarationUsageDistance](#VariableDeclarationUsageDistance) - checkstyle - enabled +* [VisibilityModifier](#VisibilityModifier) - checkstyle - enabled +* [WhitespaceAfter](#WhitespaceAfter) - checkstyle - enabled +* [WhitespaceAround](#) - checkstyle - enabled + +* [AvoidConstantAsFirstOperandInCondition](#AvoidConstantAsFirstOperandInCondition) - sevntu - enabled +* [AvoidHidingCauseException](#AvoidHidingCauseException) - sevntu - enabled +* [AvoidNotShortCircuitOperatorsForBoolean](#AvoidNotShortCircuitOperatorsForBoolean) - sevntu - enabled +* [ConfusingCondition](#ConfusingCondition) - sevntu - enabled +* [ConstructorWithoutParams](#ConstructorWithoutParams) - sevntu - enabled +* [DiamondOperatorForVariableDefinition](#DiamondOperatorForVariableDefinition) - sevntu - enabled +* [EitherLogOrThrow](#EitherLogOrThrow) - sevntu - enabled +* [EnumValueName](#EnumValueName) - sevntu - enabled +* [ForbidCCommentsInMethods](#ForbidCCommentsInMethods) - sevntu - enabled +* [ForbidReturnInFinallyBlock](#ForbidReturnInFinallyBlock) - sevntu - enabled +* [ForbidThrowAnonymousExceptions](#ForbidThrowAnonymousExceptions) - sevntu - enabled +* [ForbidWildcardAsReturnType](#ForbidWildcardAsReturnType) - sevntu - enabled +* [HideUtilityClassConstructor](#HideUtilityClassConstructor) - sevntu - enabled +* [LogicConditionNeedOptimization](#LogicConditionNeedOptimization) - sevntu - enabled +* [MapIterationInForEachLoop](#MapIterationInForEachLoop) - sevntu - enabled +* [NameConventionForJunit4TestClasses](#NameConventionForJunit4TestClasses) - sevntu - enabled +* [NestedSwitch](#NestedSwitch) - sevntu - enabled +* [NoMainMethodInAbstractClass](#NoMainMethodInAbstractClass) - sevntu - enabled +* [NumericLiteralNeedsUnderscore](#NumericLiteralNeedsUnderscore) - sevntu - enabled +* [OverridableMethodInConstructor](#OverridableMethodInConstructor) - sevntu - enabled +* [PublicReferenceToPrivateType](#PublicReferenceToPrivateType) - sevntu - enabled +* [RedundantReturn](#RedundantReturn) - sevntu - enabled +* [ReturnBooleanFromTernary](#ReturnBooleanFromTernary) - sevntu - enabled +* [ReturnNullInsteadOfBoolean](#ReturnNullInsteadOfBoolean) - sevntu - enabled +* [SimpleAccessorNameNotation](#SimpleAccessorNameNotation) - sevntu - enabled +* [SingleBreakOrContinue](#SingleBreakOrContinue) - sevntu - enabled +* [TernaryPerExpressionCount](#TernaryPerExpressionCount) - sevntu - enabled +* [UniformEnumConstantName](#UniformEnumConstantName) - sevntu - enabled +* [UselessSingleCatch](#UselessSingleCatch) - sevntu - enabled +* [UselessSuperCtorCall](#UselessSuperCtorCall) - sevntu - enabled + +* [ArrayTrailingComma](#ArrayTrailingComma) - checkstyle - disabled +* [AvoidInlineConditionals](#AvoidInlineConditionals) - checkstyle - disabled +* [EqualsAvoidNull](#EqualsAvoidNull) - checkstyle - disabled +* [FinalLocalVariable](#FinalLocalVariable) - checkstyle - disabled +* [Header](#Header) - checkstyle - disabled +* [IllegalInstantiation](#IllegalInstantiation) - checkstyle - disabled +* [IllegalToken](#IllegalToken) - checkstyle - disabled +* [IllegalTokenText](#IllegalTokenText) - checkstyle - disabled +* [ImportControl](#ImportControl) - checkstyle - disabled +* [ImportOrder](#ImportOrder) - checkstyle - disabled +* [Indentation](#Indentation) - checkstyle - disabled +* [InterfaceTypeParameterName](#InterfaceTypeParameterName) - checkstyle - disabled +* [JavadocTagContinuationIndentation](#JavadocTagContinuationIndentation) - checkstyle - disabled +* [JavadocVariable](#JavadocVariable) - checkstyle - disabled +* [MethodTypeParameterName](#MethodTypeParameterName) - checkstyle - disabled +* [MissingCtor](#MissingCtor) - checkstyle - disabled +* [MissingOverride](#MissingOverride) - checkstyle - disabled +* [NoFinalizer](#NoFinalizer) - checkstyle - disabled +* [NoLineWrap](#NoLineWrap) - checkstyle - disabled +* [OuterTypeNumber](#OuterTypeNumber) - checkstyle - disabled +* [PackageAnnotation](#PackageAnnotation) - checkstyle - disabled +* [ParameterAssignment](#ParameterAssignment) - checkstyle - disabled +* [Regexp](#Regexp) - checkstyle - disabled +* [RegexpHeader](#RegexpHeader) - checkstyle - disabled +* [RegexpMultiline](#RegexpMultiline) - checkstyle - disabled +* [RegexpOnFilename](#RegexpOnFilename) - checkstyle - disabled +* [RegexpSingleline](#RegexpSingleline) - checkstyle - disabled +* [RegexpSingleline](#RegexpSingleline) - checkstyle - disabled +* [RequireThis](#RequireThis) - checkstyle - disabled +* [SingleLineJavadoc](#SingleLineJavadoc) - checkstyle - disabled +* [SummaryJavadoc](#SummaryJavadoc) - checkstyle - disabled +* [SuperClone](#SuperClone) - checkstyle - disabled +* [SuperFinalize](#SuperFinalize) - checkstyle - disabled +* [SuppressWarnings](#SuppressWarnings) - checkstyle - disabled +* [Translation](#Translation) - checkstyle - disabled +* [UncommentedMain](#UncommentedMain) - checkstyle - disabled +* [UniqueProperties](#UniqueProperties) - checkstyle - disabled +* [WriteTag](#WriteTag) - checkstyle - disabled + +* [AvoidConditionInversion](#AvoidConditionInversion) - sevntu - disabled +* [AvoidDefaultSerializableInInnerClasses](#AvoidDefaultSerializableInInnerClasses) - sevntu - disabled +* [AvoidModifiersForTypes](#AvoidModifiersForTypes) - sevntu - disabled +* [CauseParameterInException](#CauseParameterInException) - sevntu - disabled +* [ChildBlockLength](#ChildBlockLength) - sevntu - disabled +* [CustomDeclarationOrder](#CustomDeclarationOrder) - sevntu - disabled +* [EmptyPublicCtorInClass](#EmptyPublicCtorInClass) - sevntu - disabled +* [FinalizeImplementation](#FinalizeImplementation) - sevntu - disabled +* [ForbidAnnotation](#ForbidAnnotation) - sevntu - disabled +* [ForbidCertainImports](#ForbidCertainImports) - sevntu - disabled +* [ForbidInstantiation](#ForbidInstantiation) - sevntu - disabled +* [IllegalCatchExtended](#IllegalCatchExtended) - sevntu - disabled +* [InnerClass](#InnerClass) - sevntu - disabled +* [InterfaceTypeParameterName](#InterfaceTypeParameterName) - sevntu - disabled +* [LineLengthExtended](#LineLengthExtended) - sevntu - disabled +* [MultipleStringLiteralsExtended](#MultipleStringLiteralsExtended) - sevntu - disabled +* [MultipleVariableDeclarationsExtended](#MultipleVariableDeclarationsExtended) - sevntu - disabled +* [RequiredParameterForAnnotation](#RequiredParameterForAnnotation) - sevntu - disabled +* [ReturnCountExtended](#ReturnCountExtended) - sevntu - disabled +* [StaticMethodCandidate](#StaticMethodCandidate) - sevntu - disabled +* [UnnecessaryParenthesesExtended](#UnnecessaryParenthesesExtended) - sevntu - disabled +* [WhitespaceBeforeArrayInitializer](#WhitespaceBeforeArrayInitializer) - sevntu - disabled + ## Enabled Checks The following is a list of each of the checks and the expectations each has on your code.