A

AbcMetricRule - Class in org.codenarc.rule.size

Rule that calculates the ABC metric score for methods/classes and checks against configured threshold values.

AbcMetricRule() - Constructor in AbcMetricRule

AbstractAstVisitor - Class in org.codenarc.rule

Abstract superclass for Groovy AST Visitors used with Rules

AbstractAstVisitorRule - Class in org.codenarc.rule

Abstract superclass for Rules that use a Groovy AST Visitor.

AbstractClassNameRule - Class in org.codenarc.rule.naming

Rule that verifies that the name of an abstract class matches a regular expression specified in the regex property.

AbstractClassNameRule() - Constructor in AbstractClassNameRule

AbstractClassWithoutAbstractMethodRule - Class in org.codenarc.rule.design

The abstract class does not contain any abstract methods.

AbstractClassWithoutAbstractMethodRule() - Constructor in AbstractClassWithoutAbstractMethodRule

AbstractClassWithPublicConstructorRule - Class in org.codenarc.rule.design

An abstract class cannot be instantiated, therefore a public constructor is useless and confusing.

AbstractClassWithPublicConstructorRule() - Constructor in AbstractClassWithPublicConstructorRule

AbstractCodeNarcPlugin - Class in org.codenarc.plugin

Abstract superclass for CodeNarcPlugin implementations.

AbstractCodeNarcPlugin() - Constructor in AbstractCodeNarcPlugin

AbstractConstructorCallAstVisitor - Class in org.codenarc.rule

Abstract superclass for AST Visitor classes that deal with constructor calls

AbstractConstructorCallAstVisitor() - Constructor in AbstractConstructorCallAstVisitor

AbstractEnhanceableAstVisitorRule - Class in org.codenarc.rule

Abstract superclass for Rules that use a Groovy AST Visitor and can optionally run in enhanced mode.

AbstractFieldVisitor - Class in org.codenarc.rule

This is the base class for AST Visitors that only need to visit the fields of a class.

AbstractFinallyAstVisitor - Class in org.codenarc.rule.basic

Abstract superclass for AST Visitor classes that check for conditions within a finally block

AbstractFinallyAstVisitor() - Constructor in AbstractFinallyAstVisitor

AbstractHtmlReportWriter - Class in org.codenarc.report

Abstract superclass for HTML ReportWriter classes.

AbstractHtmlReportWriter() - Constructor in AbstractHtmlReportWriter

AbstractImportRule - Class in org.codenarc.rule.imports

Abstract class with common functionalities for import-related rules.

AbstractImportRule() - Constructor in AbstractImportRule

AbstractJavadocEmptyTagRule - Class in org.codenarc.rule.comments

Abstract superclass for rules that checks for empty javadoc tags.

AbstractJavadocEmptyTagRule() - Constructor in AbstractJavadocEmptyTagRule

AbstractJavadocMissingDescriptionRule - Class in org.codenarc.rule.comments

Abstract superclass for rules that checks for missing descriptions on javadoc tags.

AbstractJavadocMissingDescriptionRule() - Constructor in AbstractJavadocMissingDescriptionRule

AbstractLastStatementInBlockAstVisitor - Class in org.codenarc.rule.unused

Abstract superclass for AstVisitor classes that need to determine whether a Statement is the last statement within a block.

AbstractLastStatementInBlockAstVisitor() - Constructor in AbstractLastStatementInBlockAstVisitor

AbstractMethodCallExpressionVisitor - Class in org.codenarc.rule

This is the base class for AST Visitors that only need to visit the MethodCallExpressions of a class.

AbstractMethodMetricAstVisitor - Class in org.codenarc.rule.size

Abstract superclass for AstVisitor classes that use method-level GMetrics Metrics.

AbstractMethodMetricAstVisitor() - Constructor in AbstractMethodMetricAstVisitor

AbstractMethodVisitor - Class in org.codenarc.rule

This is the base class for AST Visitors that only need to visit the methods of a class.

AbstractReportWriter - Class in org.codenarc.report

Abstract superclass for ReportWriter implementation classes.

AbstractReportWriter() - Constructor in AbstractReportWriter

AbstractRule - Class in org.codenarc.rule

Abstract superclass for Rules.

AbstractRuleTestCase - Class in org.codenarc.rule

Abstract generic superclass for tests of Rule classes

AbstractRuleTestCase() - Constructor in AbstractRuleTestCase

AbstractSharedAstVisitorRule - Class in org.codenarc.rule

Abstract superclass for Rules that use a single, shared AstVisitor across all ClassNodes in a source (file).

AbstractSingleSpaceAfterKeywordAstVisitor - Class in org.codenarc.rule.formatting

Abstract superclass for AstVisitor classes that checks that there is exactly one space (blank) after a keyword and before the opening parenthesis.

AbstractSingleSpaceAfterKeywordAstVisitor() - Constructor in AbstractSingleSpaceAfterKeywordAstVisitor

AbstractSourceAnalyzer - Class in org.codenarc.analyzer

Common functionality for SourceAnalyzers.

AbstractSourceAnalyzer() - Constructor in AbstractSourceAnalyzer

AbstractSourceCode - Class in org.codenarc.source

Abstract superclass for SourceCode implementations

AbstractSourceCode() - Constructor in AbstractSourceCode

AbstractSpaceAroundBraceAstVisitor - Class in org.codenarc.rule.formatting

Abstract superclass for AstVisitor classes dealing with space around braces

AbstractSpaceAroundBraceAstVisitor() - Constructor in AbstractSpaceAroundBraceAstVisitor

AbstractTestCase - Class in org.codenarc.test

Abstract superclass for tests

AbstractTestCase() - Constructor in AbstractTestCase

AbstractTypeNameAstVisitor - Class in org.codenarc.rule.naming

Abstract superclass for AstVisitor classes dealing with class/type names, e.g. classes, interfaces and abstract classes.

AbstractTypeNameAstVisitor() - Constructor in AbstractTypeNameAstVisitor

addChild(org.codenarc.results.Results) - Method in DirectoryResults

addConfiguredOption(org.codenarc.ant.ReportOption) - Method in Report

addConfiguredReport(org.codenarc.ant.Report) - Method in CodeNarcTask

Ant-defined method (by convention), called with each instance of a nested element within this task.

AddEmptyStringRule - Class in org.codenarc.rule.unnecessary

Finds empty string literals which are being added.

AddEmptyStringRule() - Constructor in AddEmptyStringRule

addError(java.lang.String, org.codehaus.groovy.ast.ASTNode) - Method in AbstractFieldVisitor

addError(java.lang.String, org.codehaus.groovy.ast.ASTNode) - Method in AbstractMethodCallExpressionVisitor

addError(java.lang.String, org.codehaus.groovy.ast.ASTNode) - Method in AbstractMethodVisitor

addExclude(java.lang.String) - Method in FilteredRuleSet

Add an exclude criteria.

addFileResultRecursive(org.codenarc.results.FileResults) - Method in DirectoryResults

Add file results to current DirectoryResult instance, or recursively in a child Directory result Child DirectoryResults are created if not existing

addFileset(org.apache.tools.ant.types.FileSet) - Method in CodeNarcTask

addInclude(java.lang.String) - Method in FilteredRuleSet

Add an include criteria.

additionalHibernateBasicTypes - Property in GrailsDomainReservedSqlKeywordNameRule

additionalReservedSqlKeywords - Property in GrailsDomainReservedSqlKeywordNameRule

addRule(org.codenarc.rule.Rule) - Method in CompositeRuleSet

Add a single Rule to this RuleSet

addRuleSet(org.codenarc.ruleset.RuleSet) - Method in CompositeRuleSet

Add all of the Rules within the specified RuleSet to this RuleSet

addViolation(org.codenarc.rule.Violation) - Method in AbstractAstVisitor

Add a new Violation to the list of violations found by this visitor.

addViolation(org.codehaus.groovy.ast.FieldNode, java.lang.String) - Method in AbstractFieldVisitor

Add a new Violation to the list of violations found by this visitor.

addViolation(org.codehaus.groovy.ast.expr.MethodCallExpression, java.lang.String) - Method in AbstractMethodCallExpressionVisitor

Add a new Violation to the list of violations found by this visitor.

addViolation(org.gmetrics.result.MetricResult, java.lang.String) - Method in AbstractMethodMetricAstVisitor

addViolation(org.codehaus.groovy.ast.ClassNode, java.lang.String) - Method in AbstractMethodVisitor

Add a new Violation to the list of violations found by this visitor.

addViolationForSunImport(org.codehaus.groovy.ast.ImportNode, org.codenarc.source.SourceCode, java.util.List) - Method in ImportFromSunPackagesRule

ALL_RULES - Field in LookupTable

ALL_RULESET_FILES - Property in RuleSets

allowBraceOnNextLineForMultilineDeclarations - Property in BracesForMethodRule

allowConstructorOnlyUsages - Property in UnusedPrivateFieldRule

allowDerivedClasses - Property in LoggerForDifferentClassRule

allowedFieldModifiersList - Field in IllegalClassMemberRule

allowedFieldModifiersString - Field in IllegalClassMemberRule

allowedMethodModifiersList - Field in IllegalClassMemberRule

allowedMethodModifiersString - Field in IllegalClassMemberRule

allowedPropertyModifiersList - Field in IllegalClassMemberRule

allowedPropertyModifiersString - Field in IllegalClassMemberRule

allowMultiline - Property in AbstractJavadocEmptyTagRule

allowMultiline - Property in AbstractJavadocMissingDescriptionRule

allowNonStaticLogger - Property in LoggerWithWrongModifiersRule

allowProtectedLogger - Property in LoggerWithWrongModifiersRule

allowUsingItAsParameterName - Property in ImplicitClosureParameterRule

AnalysisContext - Class in org.codenarc

Holds information related to the configuration and context for the source code analysis.

AnalysisContext() - Constructor in AnalysisContext

analyze(org.codenarc.ruleset.RuleSet) - Method in AntFileSetSourceAnalyzer

Analyze all source code using the specified RuleSet and return the report results.

analyze(org.codenarc.ruleset.RuleSet) - Method in FilesSourceAnalyzer

Analyze the source with the input list of files using the specified RuleSet and return the report results.

analyze(org.codenarc.ruleset.RuleSet) - Method in FilesystemSourceAnalyzer

Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.

analyze(org.codenarc.ruleset.RuleSet) - Method in SourceAnalyzer

Analyze all source code using the specified RuleSet and return the report results.

analyze(org.codenarc.ruleset.RuleSet) - Method in StringSourceAnalyzer

AnalyzerException - Class in org.codenarc.analyzer

Exception thrown by the SourceAnalyzer

AnalyzerException(java.lang.String) - Constructor in AnalyzerException

AntFileSetSourceAnalyzer - Class in org.codenarc.ant

SourceAnalyzer implementation that gets source files from one or more Ant FileSets.

AntFileSetSourceAnalyzer(org.apache.tools.ant.Project, org.apache.tools.ant.types.FileSet) - Constructor in AntFileSetSourceAnalyzer

Construct a new instance on the specified Ant FileSet.

applyRuleTo(java.lang.String) - Method in AbstractRuleTestCase

Apply the current Rule to the specified source (String) and return the resulting List of Violations.

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in AbstractAstVisitorRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in AbstractJavadocEmptyTagRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in AbstractJavadocMissingDescriptionRule

applyTo(org.codenarc.source.SourceCode) - Method in AbstractRule

Apply this rule to the specified source and return a list of violations (or an empty List).

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in AbstractSharedAstVisitorRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in BlankLineBeforePackageRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in BracesForClassRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in ClassJavadocRule

Apply the rule to the given source, writing violations to the given list.

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in ClassNameSameAsFilenameRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in ConsecutiveBlankLinesRule

Apply the rule to the given source, writing violations to the given list.

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in DuplicateImportRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in FileEndsWithoutNewlineRule

Apply the rule to the given source, writing violations to the given list.

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in IllegalRegexRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in IllegalStringRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in ImportFromSamePackageRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in ImportFromSunPackagesRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in IndentationRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in JavadocConsecutiveEmptyLinesRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in JavadocEmptyFirstLineRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in JavadocEmptyLastLineRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in LineLengthRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in MisorderedStaticImportsRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in MissingBlankLineAfterImportsRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in MissingBlankLineAfterPackageRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in NoTabCharacterRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in NoWildcardImportsRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in PackageNameMatchesFilePathRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in RequiredRegexRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in RequiredStringRule

applyTo(org.codenarc.source.SourceCode) - Method in Rule

Apply this rule to the specified source and return a list of violations (or an empty List)

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in SpaceAfterCommentDelimiterRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in SpaceBeforeCommentDelimiterRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in StubRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in TrailingWhitespaceRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in UnnecessaryGroovyImportRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in UnnecessarySemicolonRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in UnusedImportRule

applyTo(org.codenarc.source.SourceCode, List<Violation>) - Method in UnusedVariableRule

applyToClassNames - Property in ChainedTestRule

applyToClassNames - Property in CoupledTestCaseRule

applyToClassNames - Property in GrailsPublicControllerMethodRule

applyToClassNames - Property in GrailsStatelessServiceRule

applyToClassNames - Property in JUnitAssertAlwaysFailsRule

applyToClassNames - Property in JUnitAssertAlwaysSucceedsRule

applyToClassNames - Property in JUnitFailWithoutMessageRule

applyToClassNames - Property in JUnitLostTestRule

applyToClassNames - Property in JUnitPublicFieldRule

applyToClassNames - Property in JUnitPublicNonTestMethodRule

applyToClassNames - Property in JUnitPublicPropertyRule

applyToClassNames - Property in JUnitSetUpCallsSuperRule

applyToClassNames - Property in JUnitStyleAssertionsRule

applyToClassNames - Property in JUnitTearDownCallsSuperRule

applyToClassNames - Property in JUnitTestMethodWithoutAssertRule

applyToClassNames - Property in JUnitUnnecessarySetUpRule

applyToClassNames - Property in JUnitUnnecessaryTearDownRule

applyToClassNames - Property in JUnitUnnecessaryThrowsExceptionRule

applyToClassNames - Property in UnnecessaryFailRule

applyToClassNames - Property in UseAssertEqualsInsteadOfAssertTrueRule

applyToClassNames - Property in UseAssertFalseInsteadOfNegationRule

applyToClassNames - Property in UseAssertNullInsteadOfAssertEqualsRule

applyToClassNames - Property in UseAssertSameInsteadOfAssertTrueRule

applyToClassNames - Property in UseAssertTrueInsteadOfAssertEqualsRule

applyToClassNames - Property in UseAssertTrueInsteadOfNegationRule

applyToClosure - Property in StubRule

applyToFileNames - Property in ClassNotSerializableRule

applyToFileNames - Property in ClosureInGStringRule

applyToFileNames - Property in CpsCallFromNonCpsMethodRule

applyToFileNames - Property in ExpressionInCpsMethodNotSerializableRule

applyToFileNames - Property in ForbiddenCallInCpsMethodRule

applyToFileNames - Property in ObjectOverrideOnlyNonCpsMethods

applyToFileNames - Property in ParameterOrReturnTypeNotSerializableRule

applyToFileNames - Property in SourceCodeCriteria

Only apply to source code (file) names matching this value.

applyToFilesMatching - Property in GrailsDomainHasEqualsRule

applyToFilesMatching - Property in GrailsDomainHasToStringRule

applyToFilesMatching - Property in GrailsDomainReservedSqlKeywordNameRule

applyToFilesMatching - Property in GrailsDomainStringPropertyMaxSizeRule

applyToFilesMatching - Property in GrailsDomainWithServiceReferenceRule

applyToFilesMatching - Property in GrailsDuplicateConstraintRule

applyToFilesMatching - Property in GrailsDuplicateMappingRule

applyToFilesMatching - Property in GrailsPublicControllerMethodRule

applyToFilesMatching - Property in GrailsServletContextReferenceRule

applyToFilesMatching - Property in GrailsStatelessServiceRule

applyToFilesMatching - Property in JUnitAssertEqualsConstantActualValueRule

applyToFilesMatching - Property in SourceCodeCriteria

Apply only to source code (file) pathnames matching this regular expression.

applyToNonMainClasses - Property in ClassJavadocRule

applyVisitor(org.codenarc.rule.AstVisitor, org.codenarc.source.SourceCode) - Method in AbstractSharedAstVisitorRule

areJoinableConstants(org.codehaus.groovy.ast.expr.Expression, org.codehaus.groovy.ast.expr.Expression) - Method in ConsecutiveUtils

areTheSameConstantOrLiteralLists(org.codehaus.groovy.ast.expr.ListExpression, org.codehaus.groovy.ast.expr.ListExpression) - Method in DryUtil

Returns:

true only if both ListExpressions have the same set of constant or literal values, in the same order.

areTheSameConstantOrLiteralMapEntryExpression(org.codehaus.groovy.ast.expr.MapEntryExpression, org.codehaus.groovy.ast.expr.MapEntryExpression) - Method in DryUtil

Returns:

true only if both MapEntryExpressions have the same constant or literal key and value

areTheSameConstantOrLiteralMaps(org.codehaus.groovy.ast.expr.MapExpression, org.codehaus.groovy.ast.expr.MapExpression) - Method in DryUtil

Returns:

true only if both MapExpressions have the same set of constant or literal keys and values, in the same order.

assertClassImplementsRuleInterface(java.lang.Class) - Method in RuleSetUtil

assertInlineViolations(java.lang.String) - Method in AbstractRuleTestCase

Apply the current Rule to the specified source (String) and assert that it results in the violations specified inline within the source.

assertMethodPatterns - Property in JUnitTestMethodWithoutAssertRule

assertNoViolations(java.lang.String) - Method in AbstractRuleTestCase

Apply the current Rule to the specified source (String) and assert that it results in no violations.

assertSingleViolation(java.lang.String, groovy.lang.Closure) - Method in AbstractRuleTestCase

Apply the current Rule to the specified source (String) and assert that it results in a single violation and that the specified closure returns true.

assertTwoViolations(java.lang.String, java.lang.Integer, java.lang.String, java.lang.Object, java.lang.Integer, java.lang.String, java.lang.Object) - Method in AbstractRuleTestCase

Apply the current Rule to the specified source (String) and assert that it results in two violations with the specified line numbers and containing the specified source text values.

assertViolation(org.codenarc.rule.Violation, java.lang.Integer, java.lang.String, java.lang.Object) - Method in AbstractRuleTestCase

Assert that the specified violation is for the current rule, and has expected line number and contains the specified source text and message text.

assertViolations(java.lang.String, java.util.Map) - Method in AbstractRuleTestCase

Apply the current Rule to the specified source (String) and assert that it results in the violations specified in violationMaps.

AssertWithinFinallyBlockRule - Class in org.codenarc.rule.basic

Rule that checks for assert statements within a finally block.

AssertWithinFinallyBlockRule() - Constructor in AssertWithinFinallyBlockRule

AssignCollectionSortRule - Class in org.codenarc.rule.groovyism

The Collections.sort() method mutates the list and returns the list as a value.

AssignCollectionSortRule() - Constructor in AssignCollectionSortRule

AssignCollectionUniqueRule - Class in org.codenarc.rule.groovyism

The unique() method mutates the original list.

AssignCollectionUniqueRule() - Constructor in AssignCollectionUniqueRule

AssignmentInConditionalRule - Class in org.codenarc.rule.basic

An assignment operator (=) was used in a conditional test.

AssignmentInConditionalRule() - Constructor in AssignmentInConditionalRule

AssignmentToStaticFieldFromInstanceMethodRule - Class in org.codenarc.rule.design

Checks for assignment to a static field from an instance method.

AssignmentToStaticFieldFromInstanceMethodRule() - Constructor in AssignmentToStaticFieldFromInstanceMethodRule

AstUtil - Class in org.codenarc.util

Contains static utility methods and constants related to Groovy AST.

AstVisitor - Interface in org.codenarc.rule

Interface for Groovy AST Visitors used with Rules

astVisitorClass - Property in AbcMetricRule

astVisitorClass - Property in AbstractClassNameRule

astVisitorClass - Property in AbstractClassWithoutAbstractMethodRule

astVisitorClass - Property in AbstractClassWithPublicConstructorRule

astVisitorClass - Property in AddEmptyStringRule

astVisitorClass - Property in AssertWithinFinallyBlockRule

astVisitorClass - Property in AssignCollectionSortRule

astVisitorClass - Property in AssignCollectionUniqueRule

astVisitorClass - Property in AssignmentInConditionalRule

astVisitorClass - Property in AssignmentToStaticFieldFromInstanceMethodRule

astVisitorClass - Property in BigDecimalInstantiationRule

astVisitorClass - Property in BitwiseOperatorInConditionalRule

astVisitorClass - Property in BlockEndsWithBlankLineRule

astVisitorClass - Property in BlockStartsWithBlankLineRule

astVisitorClass - Property in BooleanGetBooleanRule

astVisitorClass - Property in BooleanMethodReturnsNullRule

astVisitorClass - Property in BracesForForLoopRule

astVisitorClass - Property in BracesForIfElseRule

astVisitorClass - Property in BracesForMethodRule

astVisitorClass - Property in BracesForTryCatchFinallyRule

astVisitorClass - Property in BrokenNullCheckRule

astVisitorClass - Property in BrokenOddnessCheckRule

astVisitorClass - Property in BuilderMethodWithSideEffectsRule

astVisitorClass - Property in BusyWaitRule

astVisitorClass - Property in ChainedTestRule

astVisitorClass - Property in ClassEndsWithBlankLineRule

astVisitorClass - Property in ClassForNameRule

astVisitorClass - Property in ClassNameRule

astVisitorClass - Property in ClassNameSameAsSuperclassRule

astVisitorClass - Property in ClassNotSerializableRule

astVisitorClass - Property in ClassSizeRule

astVisitorClass - Property in ClassStartsWithBlankLineRule

astVisitorClass - Property in CloneableWithoutCloneRule

astVisitorClass - Property in CloneWithoutCloneableRule

astVisitorClass - Property in CloseWithoutCloseableRule

astVisitorClass - Property in ClosureAsLastMethodParameterRule

astVisitorClass - Property in ClosureInGStringRule

astVisitorClass - Property in ClosureStatementOnOpeningLineOfMultipleLineClosureRule

astVisitorClass - Property in CollectAllIsDeprecatedRule

astVisitorClass - Property in CompareToWithoutComparableRule

astVisitorClass - Property in ComparisonOfTwoConstantsRule

astVisitorClass - Property in ComparisonWithSelfRule

astVisitorClass - Property in CompileStaticRule

astVisitorClass - Property in ConfusingClassNamedExceptionRule

astVisitorClass - Property in ConfusingMethodNameRule

astVisitorClass - Property in ConfusingMultipleReturnsRule

astVisitorClass - Property in ConfusingTernaryRule

astVisitorClass - Property in ConsecutiveLiteralAppendsRule

astVisitorClass - Property in ConsecutiveStringConcatenationRule

astVisitorClass - Property in ConstantAssertExpressionRule

astVisitorClass - Property in ConstantIfExpressionRule

astVisitorClass - Property in ConstantsOnlyInterfaceRule

astVisitorClass - Property in ConstantTernaryExpressionRule

astVisitorClass - Property in CouldBeElvisRule

astVisitorClass - Property in CouldBeSwitchStatementRule

astVisitorClass - Property in CoupledTestCaseRule

astVisitorClass - Property in CpsCallFromNonCpsMethodRule

astVisitorClass - Property in CyclomaticComplexityRule

astVisitorClass - Property in DeadCodeRule

astVisitorClass - Property in DirectConnectionManagementRule

astVisitorClass - Property in DoubleCheckedLockingRule

astVisitorClass - Property in DoubleNegativeRule

astVisitorClass - Property in DuplicateCaseStatementRule

astVisitorClass - Property in DuplicateListLiteralRule

astVisitorClass - Property in DuplicateMapKeyRule

astVisitorClass - Property in DuplicateMapLiteralRule

astVisitorClass - Property in DuplicateSetValueRule

astVisitorClass - Property in ElseBlockBracesRule

astVisitorClass - Property in EmptyCatchBlockRule

astVisitorClass - Property in EmptyClassRule

astVisitorClass - Property in EmptyElseBlockRule

astVisitorClass - Property in EmptyFinallyBlockRule

astVisitorClass - Property in EmptyForStatementRule

astVisitorClass - Property in EmptyIfStatementRule

astVisitorClass - Property in EmptyInstanceInitializerRule

astVisitorClass - Property in EmptyMethodInAbstractClassRule

astVisitorClass - Property in EmptyMethodRule

astVisitorClass - Property in EmptyStaticInitializerRule

astVisitorClass - Property in EmptySwitchStatementRule

astVisitorClass - Property in EmptySynchronizedStatementRule

astVisitorClass - Property in EmptyTryBlockRule

astVisitorClass - Property in EmptyWhileStatementRule

astVisitorClass - Property in EnumCustomSerializationIgnoredRule

astVisitorClass - Property in EqualsAndHashCodeRule

astVisitorClass - Property in EqualsOverloadedRule

astVisitorClass - Property in ExceptionExtendsErrorRule

astVisitorClass - Property in ExceptionExtendsThrowableRule

astVisitorClass - Property in ExceptionNotThrownRule

astVisitorClass - Property in ExplicitCallToAndMethodRule

astVisitorClass - Property in ExplicitCallToCompareToMethodRule

astVisitorClass - Property in ExplicitCallToDivMethodRule

astVisitorClass - Property in ExplicitCallToEqualsMethodRule

astVisitorClass - Property in ExplicitCallToGetAtMethodRule

astVisitorClass - Property in ExplicitCallToLeftShiftMethodRule

astVisitorClass - Property in ExplicitCallToMinusMethodRule

astVisitorClass - Property in ExplicitCallToModMethodRule

astVisitorClass - Property in ExplicitCallToMultiplyMethodRule

astVisitorClass - Property in ExplicitCallToOrMethodRule

astVisitorClass - Property in ExplicitCallToPlusMethodRule

astVisitorClass - Property in ExplicitCallToPowerMethodRule

astVisitorClass - Property in ExplicitCallToPutAtMethodRule

astVisitorClass - Property in ExplicitCallToRightShiftMethodRule

astVisitorClass - Property in ExplicitCallToXorMethodRule

astVisitorClass - Property in ExplicitGarbageCollectionRule

astVisitorClass - Property in ExpressionInCpsMethodNotSerializableRule

astVisitorClass - Property in FactoryMethodNameRule

astVisitorClass - Property in FieldNameRule

astVisitorClass - Property in FieldTypeRequiredRule

astVisitorClass - Property in FileCreateTempFileRule

astVisitorClass - Property in FinalClassWithProtectedMemberRule

astVisitorClass - Property in ForbiddenCallInCpsMethodRule

astVisitorClass - Property in ForLoopShouldBeWhileLoopRule

astVisitorClass - Property in ForStatementBracesRule

astVisitorClass - Property in GetterMethodCouldBePropertyRule

astVisitorClass - Property in GrailsDomainGormMethodsRule

astVisitorClass - Property in GrailsDomainHasEqualsRule

astVisitorClass - Property in GrailsDomainHasToStringRule

astVisitorClass - Property in GrailsDomainReservedSqlKeywordNameRule

astVisitorClass - Property in GrailsDomainStringPropertyMaxSizeRule

astVisitorClass - Property in GrailsDomainWithServiceReferenceRule

astVisitorClass - Property in GrailsDuplicateConstraintRule

astVisitorClass - Property in GrailsDuplicateMappingRule

astVisitorClass - Property in GrailsMassAssignmentRule

astVisitorClass - Property in GrailsPublicControllerMethodRule

astVisitorClass - Property in GrailsServletContextReferenceRule

astVisitorClass - Property in GroovyLangImmutableRule

astVisitorClass - Property in GStringAsMapKeyRule

astVisitorClass - Property in GStringExpressionWithinStringRule

astVisitorClass - Property in HardCodedWindowsFileSeparatorRule

astVisitorClass - Property in HardCodedWindowsRootDirectoryRule

astVisitorClass - Property in IfStatementBracesRule

astVisitorClass - Property in IfStatementCouldBeTernaryRule

astVisitorClass - Property in IllegalClassMemberRule

astVisitorClass - Property in IllegalPackageReferenceRule

astVisitorClass - Property in IllegalSubclassRule

astVisitorClass - Property in ImplementationAsTypeRule

astVisitorClass - Property in ImplicitClosureParameterRule

astVisitorClass - Property in ImplicitReturnStatementRule

astVisitorClass - Property in InconsistentPropertyLockingRule

astVisitorClass - Property in InconsistentPropertySynchronizationRule

astVisitorClass - Property in IndentationRule

astVisitorClass - Property in InsecureRandomRule

astVisitorClass - Property in InstanceofRule

astVisitorClass - Property in IntegerGetIntegerRule

astVisitorClass - Property in InterfaceNameRule

astVisitorClass - Property in InterfaceNameSameAsSuperInterfaceRule

astVisitorClass - Property in InvertedConditionRule

astVisitorClass - Property in InvertedIfElseRule

astVisitorClass - Property in JavaIoPackageAccessRule

astVisitorClass - Property in JUnitAssertAlwaysFailsRule

astVisitorClass - Property in JUnitAssertAlwaysSucceedsRule

astVisitorClass - Property in JUnitAssertEqualsConstantActualValueRule

astVisitorClass - Property in JUnitFailWithoutMessageRule

astVisitorClass - Property in JUnitLostTestRule

astVisitorClass - Property in JUnitPublicFieldRule

astVisitorClass - Property in JUnitPublicNonTestMethodRule

astVisitorClass - Property in JUnitPublicPropertyRule

astVisitorClass - Property in JUnitSetUpCallsSuperRule

astVisitorClass - Property in JUnitStyleAssertionsRule

astVisitorClass - Property in JUnitTearDownCallsSuperRule

astVisitorClass - Property in JUnitUnnecessarySetUpRule

astVisitorClass - Property in JUnitUnnecessaryTearDownRule

astVisitorClass - Property in JUnitUnnecessaryThrowsExceptionRule

astVisitorClass - Property in LocaleSetDefaultRule

astVisitorClass - Property in LoggerForDifferentClassRule

astVisitorClass - Property in LoggerWithWrongModifiersRule

astVisitorClass - Property in LoggingSwallowsStacktraceRule

astVisitorClass - Property in LongLiteralWithLowerCaseLRule

astVisitorClass - Property in MethodCountRule

astVisitorClass - Property in MethodNameRule

astVisitorClass - Property in MethodParameterTypeRequired

astVisitorClass - Property in MethodReturnTypeRequiredRule

astVisitorClass - Property in MethodSizeRule

astVisitorClass - Property in MissingBlankLineBeforeAnnotatedFieldRule

astVisitorClass - Property in MissingNewInThrowStatementRule

astVisitorClass - Property in MissingOverrideAnnotationRule

astVisitorClass - Property in MultipleLoggersRule

astVisitorClass - Property in MultipleUnaryOperatorsRule

astVisitorClass - Property in NestedBlockDepthRule

astVisitorClass - Property in NestedForLoopRule

astVisitorClass - Property in NestedSynchronizationRule

astVisitorClass - Property in NoDefRule

astVisitorClass - Property in NoDoubleRule

astVisitorClass - Property in NoFloatRule

astVisitorClass - Property in NoJavaUtilDateRule

astVisitorClass - Property in NonFinalPublicFieldRule

astVisitorClass - Property in NonFinalSubclassOfSensitiveInterfaceRule

astVisitorClass - Property in NonSerializableFieldInSerializableClass

astVisitorClass - Property in NoScriptBindingsRule

astVisitorClass - Property in ObjectFinalizeRule

astVisitorClass - Property in ObjectOverrideMisspelledMethodNameRule

astVisitorClass - Property in ObjectOverrideOnlyNonCpsMethods

astVisitorClass - Property in OptionalCollectionReturnTypeRule

astVisitorClass - Property in OptionalFieldRule

astVisitorClass - Property in OptionalMethodParameterRule

astVisitorClass - Property in PackageNameRule

astVisitorClass - Property in ParameterAssignmentInFilterClosureRule

astVisitorClass - Property in ParameterCountRule

astVisitorClass - Property in ParameterNameRule

astVisitorClass - Property in ParameterOrReturnTypeNotSerializableRule

astVisitorClass - Property in ParameterReassignmentRule

astVisitorClass - Property in PrintlnRule

astVisitorClass - Property in PrintStackTraceRule

astVisitorClass - Property in PrivateFieldCouldBeFinalRule

astVisitorClass - Property in PropertyNameRule

astVisitorClass - Property in PublicFinalizeMethodRule

astVisitorClass - Property in PublicInstanceFieldRule

astVisitorClass - Property in PublicMethodsBeforeNonPublicMethodsRule

astVisitorClass - Property in RandomDoubleCoercedToZeroRule

astVisitorClass - Property in RemoveAllOnSelfRule

astVisitorClass - Property in ReturnFromFinallyBlockRule

astVisitorClass - Property in ReturnNullFromCatchBlockRule

astVisitorClass - Property in ReturnsNullInsteadOfEmptyArrayRule

astVisitorClass - Property in ReturnsNullInsteadOfEmptyCollectionRule

astVisitorClass - Property in SerializableClassMustDefineSerialVersionUIDRule

astVisitorClass - Property in SerialPersistentFieldsRule

astVisitorClass - Property in SerialVersionUIDRule

astVisitorClass - Property in SimpleDateFormatMissingLocaleRule

astVisitorClass - Property in SpaceAfterCatchRule

astVisitorClass - Property in SpaceAfterClosingBraceRule

astVisitorClass - Property in SpaceAfterCommaRule

astVisitorClass - Property in SpaceAfterForRule

astVisitorClass - Property in SpaceAfterIfRule

astVisitorClass - Property in SpaceAfterMethodCallNameRule

astVisitorClass - Property in SpaceAfterMethodDeclarationNameRule

astVisitorClass - Property in SpaceAfterNotOperatorRule

astVisitorClass - Property in SpaceAfterOpeningBraceRule

astVisitorClass - Property in SpaceAfterSemicolonRule

astVisitorClass - Property in SpaceAfterSwitchRule

astVisitorClass - Property in SpaceAfterWhileRule

astVisitorClass - Property in SpaceAroundClosureArrowRule

astVisitorClass - Property in SpaceAroundMapEntryColonRule

astVisitorClass - Property in SpaceAroundOperatorRule

astVisitorClass - Property in SpaceBeforeClosingBraceRule

astVisitorClass - Property in SpaceBeforeOpeningBraceRule

astVisitorClass - Property in SpaceInsideParenthesesRule

astVisitorClass - Property in SpockIgnoreRestUsedRule

astVisitorClass - Property in SpockMissingAssertRule

astVisitorClass - Property in StatelessClassRule

astVisitorClass - Property in StatelessSingletonRule

astVisitorClass - Property in StaticCalendarFieldRule

astVisitorClass - Property in StaticConnectionRule

astVisitorClass - Property in StaticDateFormatFieldRule

astVisitorClass - Property in StaticFieldsBeforeInstanceFieldsRule

astVisitorClass - Property in StaticMatcherFieldRule

astVisitorClass - Property in StaticMethodsBeforeInstanceMethodsRule

astVisitorClass - Property in StaticSimpleDateFormatFieldRule

astVisitorClass - Property in SwallowThreadDeathRule

astVisitorClass - Property in SynchronizedMethodRule

astVisitorClass - Property in SynchronizedOnBoxedPrimitiveRule

astVisitorClass - Property in SynchronizedOnGetClassRule

astVisitorClass - Property in SynchronizedOnReentrantLockRule

astVisitorClass - Property in SynchronizedOnStringRule

astVisitorClass - Property in SynchronizedOnThisRule

astVisitorClass - Property in SynchronizedReadObjectMethodRule

astVisitorClass - Property in SystemErrPrintRule

astVisitorClass - Property in SystemExitRule

astVisitorClass - Property in SystemOutPrintRule

astVisitorClass - Property in SystemRunFinalizersOnExitRule

astVisitorClass - Property in TernaryCouldBeElvisRule

astVisitorClass - Property in ThisReferenceEscapesConstructorRule

astVisitorClass - Property in ThreadGroupRule

astVisitorClass - Property in ThreadLocalNotStaticFinalRule

astVisitorClass - Property in ThreadYieldRule

astVisitorClass - Property in ThrowExceptionFromFinallyBlockRule

astVisitorClass - Property in ToStringReturnsNullRule

astVisitorClass - Property in TrailingCommaRule

astVisitorClass - Property in UnnecessaryBigDecimalInstantiationRule

astVisitorClass - Property in UnnecessaryBigIntegerInstantiationRule

astVisitorClass - Property in UnnecessaryBooleanExpressionRule

astVisitorClass - Property in UnnecessaryBooleanInstantiationRule

astVisitorClass - Property in UnnecessaryCallForLastElementRule

astVisitorClass - Property in UnnecessaryCallToSubstringRule

astVisitorClass - Property in UnnecessaryCastRule

astVisitorClass - Property in UnnecessaryCatchBlockRule

astVisitorClass - Property in UnnecessaryCollectCallRule

astVisitorClass - Property in UnnecessaryCollectionCallRule

astVisitorClass - Property in UnnecessaryConstructorRule

astVisitorClass - Property in UnnecessaryDefInFieldDeclarationRule

astVisitorClass - Property in UnnecessaryDefInMethodDeclarationRule

astVisitorClass - Property in UnnecessaryDefInVariableDeclarationRule

astVisitorClass - Property in UnnecessaryDotClassRule

astVisitorClass - Property in UnnecessaryDoubleInstantiationRule

astVisitorClass - Property in UnnecessaryElseStatementRule

astVisitorClass - Property in UnnecessaryFailRule

astVisitorClass - Property in UnnecessaryFinalOnPrivateMethodRule

astVisitorClass - Property in UnnecessaryFloatInstantiationRule

astVisitorClass - Property in UnnecessaryGetterRule

astVisitorClass - Property in UnnecessaryGStringRule

astVisitorClass - Property in UnnecessaryIfStatementRule

astVisitorClass - Property in UnnecessaryInstanceOfCheckRule

astVisitorClass - Property in UnnecessaryInstantiationToGetClassRule

astVisitorClass - Property in UnnecessaryIntegerInstantiationRule

astVisitorClass - Property in UnnecessaryLongInstantiationRule

astVisitorClass - Property in UnnecessaryModOneRule

astVisitorClass - Property in UnnecessaryNullCheckBeforeInstanceOfRule

astVisitorClass - Property in UnnecessaryNullCheckRule

astVisitorClass - Property in UnnecessaryObjectReferencesRule

astVisitorClass - Property in UnnecessaryOverridingMethodRule

astVisitorClass - Property in UnnecessaryPackageReferenceRule

astVisitorClass - Property in UnnecessaryParenthesesForMethodCallWithClosureRule

astVisitorClass - Property in UnnecessaryPublicModifierRule

astVisitorClass - Property in UnnecessaryReturnKeywordRule

astVisitorClass - Property in UnnecessarySafeNavigationOperatorRule

astVisitorClass - Property in UnnecessarySelfAssignmentRule

astVisitorClass - Property in UnnecessarySemicolonRule

astVisitorClass - Property in UnnecessarySetterRule

astVisitorClass - Property in UnnecessaryStringInstantiationRule

astVisitorClass - Property in UnnecessaryTernaryExpressionRule

astVisitorClass - Property in UnnecessaryToStringRule

astVisitorClass - Property in UnnecessaryTransientModifierRule

astVisitorClass - Property in UnsafeArrayDeclarationRule

astVisitorClass - Property in UnsafeImplementationAsMapRule

astVisitorClass - Property in UnusedArrayRule

astVisitorClass - Property in UnusedMethodParameterRule

astVisitorClass - Property in UnusedObjectRule

astVisitorClass - Property in UnusedPrivateMethodParameterRule

astVisitorClass - Property in UseAssertEqualsInsteadOfAssertTrueRule

astVisitorClass - Property in UseAssertFalseInsteadOfNegationRule

astVisitorClass - Property in UseAssertNullInsteadOfAssertEqualsRule

astVisitorClass - Property in UseAssertSameInsteadOfAssertTrueRule

astVisitorClass - Property in UseAssertTrueInsteadOfAssertEqualsRule

astVisitorClass - Property in UseAssertTrueInsteadOfNegationRule

astVisitorClass - Property in UseCollectManyRule

astVisitorClass - Property in UseCollectNestedRule

astVisitorClass - Property in UseOfNotifyMethodRule

astVisitorClass - Property in VariableNameRule

astVisitorClass - Property in VariableTypeRequiredRule

astVisitorClass - Property in VolatileArrayFieldRule

astVisitorClass - Property in VolatileLongOrDoubleFieldRule

astVisitorClass - Property in WaitOutsideOfWhileLoopRule

astVisitorClass - Property in WhileStatementBracesRule

AUTO_IMPORTED_CLASSES - Field in AstUtil

AUTO_IMPORTED_PACKAGES - Field in AstUtil

B

BASE_MESSAGES_BUNDLE - Field in AbstractReportWriter

baseDir - Field in CodeNarc

baseDirectory - Property in FilesSourceAnalyzer

The base (root) directory.

baseDirectory - Property in FilesystemSourceAnalyzer

The base (root) directory.

BaselineResultsPlugin - Class in org.codenarc.plugin.baseline

CodeNarc Plugin that removes matching violations specified in a Baseline report.

BaselineResultsPlugin(org.codenarc.util.io.Resource) - Constructor in BaselineResultsPlugin

BaselineViolation - Class in org.codenarc.report

Represents a single violation within a baseline report

BaselineViolation() - Constructor in BaselineViolation

baselineViolationsMap - Field in BaselineResultsPlugin

BaselineXmlReportParser - Class in org.codenarc.report

Parser for the BaselineXmlReportWriter report

BaselineXmlReportParser() - Constructor in BaselineXmlReportParser

BaselineXmlReportWriter - Class in org.codenarc.report

ReportWriter that generates a baseline XML report.

BaselineXmlReportWriter() - Constructor in BaselineXmlReportWriter

BigDecimalInstantiationRule - Class in org.codenarc.rule.basic

Rule that checks for calls to the BigDecimal constructor with a double or float literal.

BigDecimalInstantiationRule() - Constructor in BigDecimalInstantiationRule

BitwiseOperatorInConditionalRule - Class in org.codenarc.rule.basic

Checks for bitwise operations in conditionals, if you need to do a bitwise operation then it is best practice to extract a temp variable.

BitwiseOperatorInConditionalRule() - Constructor in BitwiseOperatorInConditionalRule

BlankLineBeforePackageRule - Class in org.codenarc.rule.formatting

Makes sure there are no blank lines before the package declaration of a source code file.

BlankLineBeforePackageRule() - Constructor in BlankLineBeforePackageRule

blankLineRequired - Property in ClassEndsWithBlankLineRule

blankLineRequired - Property in ClassStartsWithBlankLineRule

BlockEndsWithBlankLineRule - Class in org.codenarc.rule.formatting

Checks that code blocks such as method bodies, closures and control structure bodies do not end with an empty line.

BlockEndsWithBlankLineRule() - Constructor in BlockEndsWithBlankLineRule

BlockStartsWithBlankLineRule - Class in org.codenarc.rule.formatting

Checks that code blocks do not start with an empty line.

BlockStartsWithBlankLineRule() - Constructor in BlockStartsWithBlankLineRule

BooleanGetBooleanRule - Class in org.codenarc.rule.basic

This rule catches usages of java.lang.Boolean.getBoolean(String) which reads a boolean from the System properties.

BooleanGetBooleanRule() - Constructor in BooleanGetBooleanRule

BooleanMethodReturnsNullRule - Class in org.codenarc.rule.design

Method with Boolean return type returns explicit null.

BooleanMethodReturnsNullRule() - Constructor in BooleanMethodReturnsNullRule

BracesForClassRule - Class in org.codenarc.rule.formatting

Checks the location of the opening brace ({) for classes.

BracesForClassRule() - Constructor in BracesForClassRule

BracesForForLoopRule - Class in org.codenarc.rule.formatting

Checks the location of the opening brace ({) for for loops.

BracesForForLoopRule() - Constructor in BracesForForLoopRule

BracesForIfElseRule - Class in org.codenarc.rule.formatting

Checks the location of the opening brace ({) for if statements and optionally closing and opening braces for else statements.

BracesForIfElseRule() - Constructor in BracesForIfElseRule

BracesForMethodRule - Class in org.codenarc.rule.formatting

Checks the location of the opening brace ({) for constructors and methods.

BracesForMethodRule() - Constructor in BracesForMethodRule

BracesForTryCatchFinallyRule - Class in org.codenarc.rule.formatting

Checks the location of the opening brace ({) for try statements, the location of the 'catch' keyword and corresponding opening braces, and the location of the 'finally' keyword and the corresponding opening braces.

BracesForTryCatchFinallyRule() - Constructor in BracesForTryCatchFinallyRule

bracesRequiredForElseIf - Property in ElseBlockBracesRule

BrokenNullCheckRule - Class in org.codenarc.rule.basic

Looks for faulty checks for null in boolean conditions, e.g.

BrokenNullCheckRule() - Constructor in BrokenNullCheckRule

BrokenOddnessCheckRule - Class in org.codenarc.rule.basic

The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1).

BrokenOddnessCheckRule() - Constructor in BrokenOddnessCheckRule

buildBodySection(org.codenarc.AnalysisContext, org.codenarc.results.Results) - Method in AbstractHtmlReportWriter

buildBodySection(org.codenarc.AnalysisContext, org.codenarc.results.Results) - Method in HtmlReportWriter

buildBodySection(org.codenarc.AnalysisContext, org.codenarc.results.Results) - Method in SortableHtmlReportWriter

buildCSS() - Method in AbstractHtmlReportWriter

BuilderMethodWithSideEffectsRule - Class in org.codenarc.rule.design

A builder method is defined as one that creates objects.

BuilderMethodWithSideEffectsRule() - Constructor in BuilderMethodWithSideEffectsRule

buildFileElement(org.codenarc.results.FileResults) - Method in BaselineXmlReportWriter

buildFileElement(org.codenarc.results.FileResults) - Method in JsonReportWriter

buildFileElement(org.codenarc.results.FileResults) - Method in XmlReportWriter

buildFileElements(org.codenarc.results.Results) - Method in BaselineXmlReportWriter

buildHeaderSection() - Method in AbstractHtmlReportWriter

buildLogo() - Method in AbstractHtmlReportWriter

buildMessageElement(org.codenarc.rule.Violation) - Method in BaselineXmlReportWriter

buildMessageElement(org.codenarc.rule.Violation) - Method in XmlReportWriter

buildPackageAttributeMap(org.codenarc.results.Results) - Method in JsonReportWriter

buildPackageAttributeMap(org.codenarc.results.Results) - Method in XmlReportWriter

buildPackageElement(org.codenarc.results.Results) - Method in XmlReportWriter

buildPackageElements(org.codenarc.results.Results) - Method in JsonReportWriter

buildPackageElements(org.codenarc.results.Results) - Method in XmlReportWriter

buildProjectElement(org.codenarc.AnalysisContext) - Method in BaselineXmlReportWriter

buildProjectElement(org.codenarc.AnalysisContext) - Method in JsonReportWriter

buildProjectElement(org.codenarc.AnalysisContext) - Method in XmlReportWriter

buildReportElement() - Method in BaselineXmlReportWriter

buildReportElement() - Method in JsonReportWriter

buildReportElement() - Method in XmlReportWriter

buildReportMetadata() - Method in AbstractHtmlReportWriter

buildRuleDescriptions(org.codenarc.AnalysisContext) - Method in AbstractHtmlReportWriter

buildRulesElement(org.codenarc.AnalysisContext) - Method in InlineXmlReportWriter

buildRulesElement(org.codenarc.AnalysisContext) - Method in JsonReportWriter

buildRulesElement(org.codenarc.AnalysisContext) - Method in XmlReportWriter

buildScript() - Method in AbstractHtmlReportWriter

buildScript() - Method in SortableHtmlReportWriter

buildSourceLineElement(org.codenarc.rule.Violation) - Method in XmlReportWriter

buildSummaryElement(org.codenarc.results.Results) - Method in JsonReportWriter

buildTitle() - Method in AbstractHtmlReportWriter

buildViolationElement(org.codenarc.rule.Violation) - Method in BaselineXmlReportWriter

buildViolationElement(org.codenarc.rule.Violation) - Method in InlineXmlReportWriter

buildViolationElement(org.codenarc.rule.Violation) - Method in JsonReportWriter

buildViolationElement(org.codenarc.rule.Violation) - Method in XmlReportWriter

BusyWaitRule - Class in org.codenarc.rule.concurrency

Busy waiting (forcing a Thread.sleep() while waiting on a condition) should be avoided.

BusyWaitRule() - Constructor in BusyWaitRule

C

CatchArrayIndexOutOfBoundsExceptionRule - Class in org.codenarc.rule.exceptions

Rule that checks for catching a ArrayIndexOutOfBoundsException

CatchArrayIndexOutOfBoundsExceptionRule() - Constructor in CatchArrayIndexOutOfBoundsExceptionRule

CatchErrorRule - Class in org.codenarc.rule.exceptions

Rule that checks for catching a Error

CatchErrorRule() - Constructor in CatchErrorRule

CatchExceptionRule - Class in org.codenarc.rule.exceptions

Rule that checks for catching a Exception

CatchExceptionRule() - Constructor in CatchExceptionRule

CatchIllegalMonitorStateExceptionRule - Class in org.codenarc.rule.exceptions

Rule to trap when IllegalMonitorStateException is being caught.

CatchIllegalMonitorStateExceptionRule() - Constructor in CatchIllegalMonitorStateExceptionRule

CatchIndexOutOfBoundsExceptionRule - Class in org.codenarc.rule.exceptions

Rule that checks for catching a IndexOutOfBoundsException

CatchIndexOutOfBoundsExceptionRule() - Constructor in CatchIndexOutOfBoundsExceptionRule

CatchNullPointerExceptionRule - Class in org.codenarc.rule.exceptions

Rule that checks for catching a NullPointerException

CatchNullPointerExceptionRule() - Constructor in CatchNullPointerExceptionRule

catchOnSameLineAsClosingBrace - Property in BracesForTryCatchFinallyRule

catchOnSameLineAsOpeningBrace - Property in BracesForTryCatchFinallyRule

CatchRuntimeExceptionRule - Class in org.codenarc.rule.exceptions

Rule that checks for catching a RuntimeException

CatchRuntimeExceptionRule() - Constructor in CatchRuntimeExceptionRule

CatchThrowableRule - Class in org.codenarc.rule.exceptions

Rule that checks for catching a Throwable

CatchThrowableRule() - Constructor in CatchThrowableRule

cdata(java.lang.String) - Method in XmlReportUtil

ChainedTestRule - Class in org.codenarc.rule.junit

A test method that invokes another test method is a chained test; the methods are dependent on one another.

ChainedTestRule() - Constructor in ChainedTestRule

characterAfterColonRegex - Property in SpaceAroundMapEntryColonRule

characterBeforeColonRegex - Property in SpaceAroundMapEntryColonRule

checkAssertStatements - Property in UseAssertTrueInsteadOfAssertEqualsRule

checkAssignments - Property in UnnecessaryToStringRule

checkClosureMapEntryValue - Property in SpaceAfterClosingBraceRule

deprecated:

Ignored

checkClosureMapEntryValue - Property in SpaceAfterOpeningBraceRule

checkClosureMapEntryValue - Property in SpaceBeforeClosingBraceRule

checkClosureMapEntryValue - Property in SpaceBeforeOpeningBraceRule

checkForSingleSpaceAndOpeningParenthesis(org.codehaus.groovy.ast.ASTNode, java.lang.String) - Method in AbstractSingleSpaceAfterKeywordAstVisitor

checkIsMethods - Property in UnnecessaryGetterRule

checkLastStatementImplicitElse - Property in IfStatementCouldBeTernaryRule

checkLastStatementImplicitElse - Property in UnnecessaryIfStatementRule

checkList - Property in TrailingCommaRule

checkMap - Property in TrailingCommaRule

checkMaxViolations(org.codenarc.results.Results, int, int) - Method in CodeNarc

CLASS_LOADER_SYS_PROP - Field in RuleSetUtil

ClassEndsWithBlankLineRule - Class in org.codenarc.rule.formatting

Check whether the class ends with a blank line.

ClassEndsWithBlankLineRule() - Constructor in ClassEndsWithBlankLineRule

ClassForNameRule - Class in org.codenarc.rule.basic

Using Class.forName(...) is a common way to add dynamic behavior to a system.

ClassForNameRule() - Constructor in ClassForNameRule

ClassJavadocRule - Class in org.codenarc.rule.comments

Makes sure each class and interface definition is preceded by javadoc.

ClassJavadocRule() - Constructor in ClassJavadocRule

ClassNameRule - Class in org.codenarc.rule.naming

Rule that verifies that the name of a class matches a regular expression.

ClassNameRule() - Constructor in ClassNameRule

classNames - Property in IllegalClassReferenceRule

ClassNameSameAsFilenameRule - Class in org.codenarc.rule.naming

Reports files containing only one top level class / enum / interface which is named differently than the file.

ClassNameSameAsFilenameRule() - Constructor in ClassNameSameAsFilenameRule

ClassNameSameAsSuperclassRule - Class in org.codenarc.rule.naming

Checks for any class that has an identical name to its superclass, other than the package.

ClassNameSameAsSuperclassRule() - Constructor in ClassNameSameAsSuperclassRule

classNodeHasProperty(org.codehaus.groovy.ast.ClassNode, java.lang.String) - Method in AstUtil

classNodeImplementsType(org.codehaus.groovy.ast.ClassNode, java.lang.Class) - Method in AstUtil

This method tells you if a ClassNode implements or extends a certain class.

classNodeIndentLevels - Field in IndentationRule

classNodeType(org.codehaus.groovy.ast.ClassNode) - Method in ClassNameSameAsFilenameRule

ClassNotSerializableRule - Class in org.codenarc.rule.jenkins

Classes in Jenkins pipeline libraries and Jenkinsfiles should generally implement the Serializable interface because every expression/variable used in a CPS transformed method can potentially be serialized

ClassNotSerializableRule() - Constructor in ClassNotSerializableRule

classpath - Property in CodeNarcTask

Classpath used when compiling analysed classes.

ClassPathResource - Class in org.codenarc.util.io

A Resource implementation for resources available on the classpath.

ClassPathResource(java.lang.String) - Constructor in ClassPathResource

Construct a new ClassPathResource

path:

- the path to the resource (file).

ClassReferenceAstVisitor - Class in org.codenarc.rule

AstVisitor that check for references for a named class

ClassReferenceAstVisitor(java.lang.String, java.lang.String) - Constructor in ClassReferenceAstVisitor

Constructor

ClassSizeRule - Class in org.codenarc.rule.size

Rule that checks the size of a class.

ClassSizeRule() - Constructor in ClassSizeRule

ClassStartsWithBlankLineRule - Class in org.codenarc.rule.formatting

Check whether the class starts with a blank line.

ClassStartsWithBlankLineRule() - Constructor in ClassStartsWithBlankLineRule

CLEAR_METHOD_NAME - Field in ValueRecorder

clear() - Method in ValueRecorder

CloneableWithoutCloneRule - Class in org.codenarc.rule.design

A class that implements Cloneable should define a clone() method.

CloneableWithoutCloneRule() - Constructor in CloneableWithoutCloneRule

CloneWithoutCloneableRule - Class in org.codenarc.rule.design

The method clone() should only be declared if the class implements the Cloneable interface.

CloneWithoutCloneableRule() - Constructor in CloneWithoutCloneableRule

CloseWithoutCloseableRule - Class in org.codenarc.rule.design

If a class defines a "void close()" then that class should implement java.io.Closeable.

CloseWithoutCloseableRule() - Constructor in CloseWithoutCloseableRule

CLOSURE_TEXT - Field in AbstractAstVisitorRule

ClosureAsLastMethodParameterRule - Class in org.codenarc.rule.groovyism

If a method is called and the last parameter is an inline closure it can be declared outside of the method call brackets.

ClosureAsLastMethodParameterRule() - Constructor in ClosureAsLastMethodParameterRule

ClosureInGStringRule - Class in org.codenarc.rule.jenkins

Closures are CPS transformed in Jenkins and will cause an error at runtime when used in GStrings.

ClosureInGStringRule() - Constructor in ClosureInGStringRule

ClosureStatementOnOpeningLineOfMultipleLineClosureRule - Class in org.codenarc.rule.formatting

Checks for closure logic on first line (after ->) for a multi-line closure

ClosureStatementOnOpeningLineOfMultipleLineClosureRule() - Constructor in ClosureStatementOnOpeningLineOfMultipleLineClosureRule

coberturaXmlFile - Property in CrapMetricRule

CodeNarc - Class in org.codenarc

Command-line runner for CodeNarc.

CodeNarc() - Constructor in CodeNarc

CODENARC_PROPERTIES_FILE_PROP - Field in AbstractTestCase

CODENARC_URL - Field in AbstractReportWriter

CodeNarcPlugin - Interface in org.codenarc.plugin

The interface defining the set of hooks for a CodeNarc Plugin

CodeNarcRunner - Class in org.codenarc

Helper class to run CodeNarc.

CodeNarcRunner() - Constructor in CodeNarcRunner

CodeNarcTask - Class in org.codenarc.ant

Ant Task for running CodeNarc.

CodeNarcTask() - Constructor in CodeNarcTask

CodeNarcVersion - Class in org.codenarc.util

Utility class to return the current version of CodeNarc

CodeNarcVersion() - Constructor in CodeNarcVersion

CollectAllIsDeprecatedRule - Class in org.codenarc.rule.groovyism

collectAll is deprecated since Groovy 1.8.1.

CollectAllIsDeprecatedRule() - Constructor in CollectAllIsDeprecatedRule

collectViolations(org.codenarc.source.SourceCode, org.codenarc.ruleset.RuleSet) - Method in AbstractSourceAnalyzer

comesBefore - Property in MisorderedStaticImportsRule

CommentsUtil - Class in org.codenarc.rule.comments

Utility methods and constants related to comments rules

CommonCatchAstVisitor - Class in org.codenarc.rule.exceptions

AstVisitor implementation that checks for catching an exception type specified in the constructor

This is an internal class and its API is subject to change.

CommonCatchAstVisitor(java.lang.String) - Constructor in CommonCatchAstVisitor

Construct a new instance, specifying the exception class name

CommonThrowAstVisitor - Class in org.codenarc.rule.exceptions

AstVisitor implementation that checks for throwing one of the exception type names specified in the constructor

This is an internal class and its API is subject to change.

CommonThrowAstVisitor(java.util.List) - Constructor in CommonThrowAstVisitor

Construct a new instance, specifying the exception type names

CompactTextReportWriter - Class in org.codenarc.report

ReportWriter that generates an simple ASCII text report, with one line per violation.

CompactTextReportWriter() - Constructor in CompactTextReportWriter

compare(org.codenarc.rule.Violation, org.codenarc.rule.Violation) - Method in AbstractAstVisitorRule

compare(org.codehaus.groovy.ast.FieldNode, org.codehaus.groovy.ast.FieldNode) - Method in AbstractFieldVisitor

compare(org.codenarc.results.FileResults, org.codenarc.results.FileResults) - Method in AntFileSetSourceAnalyzer

CompareToWithoutComparableRule - Class in org.codenarc.rule.design

If you implement a compareTo method then you should also implement the Comparable interface.

CompareToWithoutComparableRule() - Constructor in CompareToWithoutComparableRule

COMPARISON_OPERATORS - Field in AstUtil

ComparisonOfTwoConstantsRule - Class in org.codenarc.rule.basic

CodeNarc Rule.

ComparisonOfTwoConstantsRule() - Constructor in ComparisonOfTwoConstantsRule

ComparisonWithSelfRule - Class in org.codenarc.rule.basic

CodeNarc Rule.

ComparisonWithSelfRule() - Constructor in ComparisonWithSelfRule

compilerPhase - Property in ClassNotSerializableRule

compilerPhase - Property in CloneWithoutCloneableRule

compilerPhase - Property in CpsCallFromNonCpsMethodRule

compilerPhase - Property in ExpressionInCpsMethodNotSerializableRule

compilerPhase - Property in ForbiddenCallInCpsMethodRule

compilerPhase - Property in GrailsDomainGormMethodsRule

compilerPhase - Property in JUnitAssertEqualsConstantActualValueRule

compilerPhase - Property in MissingOverrideAnnotationRule

compilerPhase - Property in NonSerializableFieldInSerializableClass

compilerPhase - Property in ObjectOverrideOnlyNonCpsMethods

compilerPhase - Property in ParameterOrReturnTypeNotSerializableRule

compilerPhase - Property in UnsafeImplementationAsMapRule

CompileStaticRule - Class in org.codenarc.rule.convention

Enforces classes are annotated either with one of the CompileStatic, GrailsCompileStatic or CompileDynamic annotations

CompileStaticRule() - Constructor in CompileStaticRule

CompositeRuleSet - Class in org.codenarc.ruleset

A RuleSet implementation that aggregates a set of RuleSets and Rules.

CompositeRuleSet() - Constructor in CompositeRuleSet

configure(org.codenarc.ruleset.RuleSet, java.lang.String) - Method in PropertiesFileRuleSetConfigurer

Configure the rules within the RuleSet from the properties file (relative to the classpath).

configure(org.codenarc.ruleset.RuleSet, java.lang.String) - Method in RuleSetConfigurer

ConfusingClassNamedExceptionRule - Class in org.codenarc.rule.exceptions

This rule traps classes named exception that do not inherit from exception.

ConfusingClassNamedExceptionRule() - Constructor in ConfusingClassNamedExceptionRule

ConfusingMethodNameRule - Class in org.codenarc.rule.naming

This rule traps the condition where two methods or closures differ only by their capitalization.

ConfusingMethodNameRule() - Constructor in ConfusingMethodNameRule

ConfusingMultipleReturnsRule - Class in org.codenarc.rule.groovyism

Multiple return values can be used to set several variables at once.

ConfusingMultipleReturnsRule() - Constructor in ConfusingMultipleReturnsRule

ConfusingTernaryRule - Class in org.codenarc.rule.convention

In an "if" expression with an "else" clause, avoid negation in the test.

ConfusingTernaryRule() - Constructor in ConfusingTernaryRule

ConsecutiveBlankLinesRule - Class in org.codenarc.rule.formatting

Makes sure there are no consecutive lines that are either blank or whitespace only.

ConsecutiveBlankLinesRule() - Constructor in ConsecutiveBlankLinesRule

ConsecutiveLiteralAppendsRule - Class in org.codenarc.rule.unnecessary

Violations occur when method calls to append(Object) are chained together with literals as parameters.

ConsecutiveLiteralAppendsRule() - Constructor in ConsecutiveLiteralAppendsRule

ConsecutiveStringConcatenationRule - Class in org.codenarc.rule.unnecessary

Catches concatenation of two string literals on the same line.

ConsecutiveStringConcatenationRule() - Constructor in ConsecutiveStringConcatenationRule

ConsecutiveUtils - Class in org.codenarc.util

Utility class for Consecutive* rules.

ConsecutiveUtils() - Constructor in ConsecutiveUtils

ConstantAssertExpressionRule - Class in org.codenarc.rule.basic

Rule that checks for assert statements where the assert condition expressions is a constant value or literal value, such as:

• assert true
• assert false
• assert Boolean.TRUE
• assert Boolean.FALSE
• assert null
• assert 0
• assert 99.7
• assert ""
• assert "abc"
• assert [:]
• assert [a:123, b:456]
• assert [a, b, c]

ConstantAssertExpressionRule() - Constructor in ConstantAssertExpressionRule

ConstantIfExpressionRule - Class in org.codenarc.rule.basic

Rule that checks for if statement with a constant value for the if expression, such as:

• if (true) { .. }
• if (false) { .. }
• if (Boolean.TRUE) { .. }
• if (Boolean.FALSE) { .. }
• if (null) { .. }
• if (0) { .. }
• if (99.7) { .. }
• if ("") { .. }
• if ("abc") { .. }
• if ([a:123, b:456]) { .. }
• if ([a, b]) { .. }

ConstantIfExpressionRule() - Constructor in ConstantIfExpressionRule

constants - Property in DuplicateLiteralAstVisitor

ConstantsOnlyInterfaceRule - Class in org.codenarc.rule.design

An interface should be used only to model a behaviour of a class: using an interface as a container of constants is a poor usage pattern.

ConstantsOnlyInterfaceRule() - Constructor in ConstantsOnlyInterfaceRule

ConstantTernaryExpressionRule - Class in org.codenarc.rule.basic

Rule that checks for ternary expressions with a constant value for the boolean expression, such as:

• true ?

ConstantTernaryExpressionRule() - Constructor in ConstantTernaryExpressionRule

CONSTRUCTOR_METHOD_NAME - Field in AbstractRuleTestCase

ConstructorsSkippingFieldReferenceAstVisitor - Class in org.codenarc.rule

AstVisitor that checks for references to fields outside of constructors

ConstructorsSkippingFieldReferenceAstVisitor() - Constructor in ConstructorsSkippingFieldReferenceAstVisitor

containsOnlyAsciiCharacters(java.lang.String) - Method in SourceCodeUtil

CONTROLLERS_AND_TAGLIB_FILES - Field in GrailsUtil

CONTROLLERS_CLASSES - Field in GrailsUtil

CONTROLLERS_FILES - Field in GrailsUtil

CouldBeElvisRule - Class in org.codenarc.rule.convention

Catch an if block that could be written as an elvis expression.

CouldBeElvisRule() - Constructor in CouldBeElvisRule

CouldBeSwitchStatementRule - Class in org.codenarc.rule.convention

Checks for multiple if statements that could be converted to a switch

CouldBeSwitchStatementRule() - Constructor in CouldBeSwitchStatementRule

CoupledTestCaseRule - Class in org.codenarc.rule.junit

This rule finds test cases that are coupled to other test cases, either by invoking static methods on another test case or by creating instances of another test case.

CoupledTestCaseRule() - Constructor in CoupledTestCaseRule

CpsCallFromNonCpsMethodRule - Class in org.codenarc.rule.jenkins

CPS transformed methods may not be called from non CPS transformed methods in Jenkins

CpsCallFromNonCpsMethodRule() - Constructor in CpsCallFromNonCpsMethodRule

cpsPackages - Property in CpsCallFromNonCpsMethodRule

cpsScriptVariableName - Property in CpsCallFromNonCpsMethodRule

crapMetricClassName - Field in CrapMetricRule

CrapMetricRule - Class in org.codenarc.rule.size

Rule that calculates the CRAP Metric for methods/classes and checks against configured threshold values.

CrapMetricRule() - Constructor in CrapMetricRule

createClasspath() - Method in CodeNarcTask

createCodeNarcRunner - Field in CodeNarc

createCodeNarcRunner - Field in CodeNarcTask

createErrorMessage() - Method in ExplicitArrayListInstantiationRule.1

createErrorMessage() - Method in ExplicitHashMapInstantiationRule.1

createErrorMessage() - Method in ExplicitHashSetInstantiationRule.1

createErrorMessage() - Method in ExplicitLinkedHashMapInstantiationRule.1

createErrorMessage() - Method in ExplicitLinkedListInstantiationRule.1

createErrorMessage() - Method in ExplicitStackInstantiationRule.1

createErrorMessage() - Method in ExplicitTreeSetInstantiationRule.1

createErrorMessage() - Method in ExplicitTypeInstantiationAstVisitor

createInitialRuleSet() - Method in CodeNarcRunner

Create and return the RuleSet that provides the source of Rules to be applied.

createMetric() - Method in AbstractMethodMetricAstVisitor

createPrettyExpression(org.codehaus.groovy.ast.ASTNode) - Method in AstUtil

createRule() - Method in AbstractRuleTestCase

Create and return a new instance of the Rule class to be tested.

createSortedListOfAllRules() - Method in GenerateUtil

createSourceAnalyzer() - Method in CodeNarc

Create and return the SourceAnalyzer

createSourceAnalyzer() - Method in CodeNarcTask

Create and return the SourceAnalyzer

createViolation(org.codenarc.source.SourceCode, org.codehaus.groovy.ast.ASTNode, java.lang.String) - Method in AbstractRule

Create a new Violation for the AST node.

createViolationForImport(org.codenarc.source.SourceCode, java.lang.String, java.lang.String, java.lang.String) - Method in AbstractRule

Create and return a new Violation for this rule and the specified import className and alias

CSS_FILE - Field in AbstractHtmlReportWriter

currentClassNode - Field in AbstractMethodCallExpressionVisitor

CUSTOM_MESSAGES_BUNDLE - Field in AbstractReportWriter

CustomCompilerPhaseSourceDecorator - Class in org.codenarc.source

A SourceCode decorator overriding the decorated source's returned AST so that it meets the user's compilerPhase requirements.

CustomCompilerPhaseSourceDecorator(org.codenarc.source.SourceCode, int) - Constructor in CustomCompilerPhaseSourceDecorator

customMessagesBundleName - Field in AbstractReportWriter

CyclomaticComplexityRule - Class in org.codenarc.rule.size

Rule that calculates the Cyclomatic Complexity for methods/classes and checks against configured threshold values.

CyclomaticComplexityRule() - Constructor in CyclomaticComplexityRule