D

DeadCodeAstVisitor - Class in org.codenarc.rule.basic

DeadCodeRule - Class in org.codenarc.rule.basic

Dead code appears after a return statement or an exception is thrown.

DEFAULT_COMPILER_PHASE - Field in SourceCode

DEFAULT_CONST_NAME - Field in AbstractAstVisitorRule

DEFAULT_FIELD_NAME - Field in AbstractAstVisitorRule

DEFAULT_GORM_STATIC_METHOD_NAMES - Field in GrailsDomainGormMethodsRule

DEFAULT_OUTPUT_FILE - Field in HtmlReportWriter

DEFAULT_OUTPUT_FILE - Field in SortableHtmlReportWriter

DEFAULT_TEST_CLASS_NAMES - Field in AbstractAstVisitorRule

DEFAULT_TEST_CLASS_NAMES - Field in AbstractRuleTestCase

DEFAULT_TEST_FILES - Field in AbstractAstVisitorRule

DEFAULT_TEST_FILES - Field in AbstractRuleTestCase

DEFAULT_VAR_NAME - Field in AbstractAstVisitorRule

defaultPropertiesFilename - Field in PropertiesFileRuleSetConfigurer

DefaultResourceFactory - Class in org.codenarc.util.io

Default implementation of ResourceFactory.

description(String) - Method in TopLevelDelegate

DirectConnectionManagementAstVisitor - Class in org.codenarc.rule.jdbc

DirectConnectionManagementRule - Class in org.codenarc.rule.jdbc

The J2EE standard requires that applications use the container's resource management facilities to obtain connections to resources.

DirectoryResults - Class in org.codenarc.results

Represents the results for a directory

DirectoryResults(String, int) - Constructor in DirectoryResults

Create a new instance with the specified path and number of files in the directory

disabledRuleNamesForLineNumber(Integer) - Method in LookupTable

DisableRulesInCommentsPlugin - Class in org.codenarc.plugin.disablerules

Plugin that enables enablement/disablement of rules (and removing their violations) using comments within the source code

DOMAIN_FILES - Field in GrailsUtil

DoubleCheckedLockingAstVisitor - Class in org.codenarc.rule.concurrency

DoubleCheckedLockingRule - Class in org.codenarc.rule.concurrency

This rule detects double checked locking, where a 'lock hint' is tested for null before initializing an object within a synchronized block.

DoubleNegativeAstVisitor - Class in org.codenarc.rule.basic

DoubleNegativeRule - Class in org.codenarc.rule.basic

There is no point in using a double negative, it is always positive.

DryUtil - Class in org.codenarc.rule.dry

Utility methods for the DRY rule classes

DuplicateCaseStatementAstVisitor - Class in org.codenarc.rule.basic

DuplicateCaseStatementRule - Class in org.codenarc.rule.basic

Rule that checks for duplicate case statements in a switch block, such as two equal integers or strings.

DuplicateImportRule - Class in org.codenarc.rule.imports

Rule that checks for a duplicate import

DuplicateListLiteralAstVisitor - Class in org.codenarc.rule.dry

DuplicateListLiteralRule - Class in org.codenarc.rule.dry

Check for multiple instances of the same List literal, limited to Lists where the values are all constants or literals.

DuplicateLiteralAstVisitor - Class in org.codenarc.rule.dry

Abstract superclass for rule AstVisitor classes that detect duplicate literal constants

DuplicateLiteralAstVisitor(List<Class>, Set, Closure) - Constructor in DuplicateLiteralAstVisitor

DuplicateMapKeyAstVisitor - Class in org.codenarc.rule.basic

DuplicateMapKeyRule - Class in org.codenarc.rule.basic

A map literal is created with duplicated key.

DuplicateMapLiteralAstVisitor - Class in org.codenarc.rule.dry

DuplicateMapLiteralRule - Class in org.codenarc.rule.dry

Check for multiple instances of the same Map literal, limited to Maps where the keys and values are all constants or literals.

DuplicateNumberLiteralRule - Class in org.codenarc.rule.dry

Checks for duplication of constant number literal values.

DuplicateSetValueAstVisitor - Class in org.codenarc.rule.basic

DuplicateSetValueRule - Class in org.codenarc.rule.basic

A Set literal is created with duplicate constant value.

DuplicateStringLiteralRule - Class in org.codenarc.rule.dry

Code containing duplicate String literals can usually be improved by declaring the String as a constant field.

E

eachImportLine(SourceCode, Closure) - Method in AbstractImportRule

ElseBlockBracesAstVisitor - Class in org.codenarc.rule.braces

ElseBlockBracesRule - Class in org.codenarc.rule.braces

Rule that checks that else blocks use braces rather than a single statement.

EmptyCatchBlockAstVisitor - Class in org.codenarc.rule.basic

EmptyCatchBlockRule - Class in org.codenarc.rule.basic

Rule that checks for empty catch blocks

EmptyClassAstVisitor - Class in org.codenarc.rule.basic

EmptyClassRule - Class in org.codenarc.rule.basic

Reports classes without methods, fields or properties.

EmptyElseBlockAstVisitor - Class in org.codenarc.rule.basic

EmptyElseBlockRule - Class in org.codenarc.rule.basic

Rule that checks for empty else blocks

EmptyFinallyBlockAstVisitor - Class in org.codenarc.rule.basic

EmptyFinallyBlockRule - Class in org.codenarc.rule.basic

Rule that checks for empty finally blocks

EmptyForStatementAstVisitor - Class in org.codenarc.rule.basic

EmptyForStatementRule - Class in org.codenarc.rule.basic

Rule that checks for empty for statements

EmptyIfStatementAstVisitor - Class in org.codenarc.rule.basic

EmptyIfStatementRule - Class in org.codenarc.rule.basic

Rule that checks for empty if statements

EmptyInstanceInitializerAstVisitor - Class in org.codenarc.rule.basic

EmptyInstanceInitializerRule - Class in org.codenarc.rule.basic

The class has an empty instance initializer.

EmptyMethodAstVisitor - Class in org.codenarc.rule.basic

EmptyMethodInAbstractClassAstVisitor - Class in org.codenarc.rule.design

EmptyMethodInAbstractClassRule - Class in org.codenarc.rule.design

An empty method in an abstract class should be abstract instead, as developer may rely on this empty implementation rather than code the appropriate one.

EmptyMethodRule - Class in org.codenarc.rule.basic

A method was found without an implementation.

EmptyStaticInitializerAstVisitor - Class in org.codenarc.rule.basic

EmptyStaticInitializerRule - Class in org.codenarc.rule.basic

An empty static initializer was found.

EmptySwitchStatementAstVisitor - Class in org.codenarc.rule.basic

EmptySwitchStatementRule - Class in org.codenarc.rule.basic

Rule that checks for empty switch statements

EmptySynchronizedStatementAstVisitor - Class in org.codenarc.rule.basic

EmptySynchronizedStatementRule - Class in org.codenarc.rule.basic

Rule that checks for empty synchronized statement

EmptyTryBlockAstVisitor - Class in org.codenarc.rule.basic

EmptyTryBlockRule - Class in org.codenarc.rule.basic

Rule that checks for empty try blocks

EmptyWhileStatementAstVisitor - Class in org.codenarc.rule.basic

EmptyWhileStatementRule - Class in org.codenarc.rule.basic

Rule that checks for empty while statements

endsWithSemicolon(String, int) - Method in UnnecessarySemicolonRule

ENHANCED_MODE_SYSTEM_PROPERTY - Field in AbstractEnhanceableAstVisitorRule

Holds the name of the system property which allows to control the enhancedMode property.

EnumCustomSerializationIgnoredAstVisitor - Class in org.codenarc.rule.serialization

EnumCustomSerializationIgnoredRule - Class in org.codenarc.rule.serialization

Checks for enums that define writeObject() or writeReplace() methods, or declare serialPersistentFields or serialVersionUID fields, all of which are ignored for enums.

EqualsAndHashCodeAstVisitor - Class in org.codenarc.rule.basic

EqualsAndHashCodeRule - Class in org.codenarc.rule.basic

Rule that checks that if either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.

EqualsOverloadedAstVisitor - Class in org.codenarc.rule.basic

EqualsOverloadedRule - Class in org.codenarc.rule.basic

The class has an equals method, but the parameter of the method is not of type Object.

ERROR_MESSAGE - Field in ParameterAssignmentInFilterClosureAstVisitor

ExceptionExtendsErrorAstVisitor - Class in org.codenarc.rule.exceptions

ExceptionExtendsErrorRule - Class in org.codenarc.rule.exceptions

Errors are system exceptions.

ExceptionExtendsThrowableAstVisitor - Class in org.codenarc.rule.exceptions

ExceptionExtendsThrowableRule - Class in org.codenarc.rule.exceptions

Checks for classes that extend Throwable.

ExceptionNotThrownAstVisitor - Class in org.codenarc.rule.exceptions

ExceptionNotThrownRule - Class in org.codenarc.rule.exceptions

Checks for an exception constructor call as the last statement within a catch block.

exclude(String) - Method in RuleSetDelegate

excludePattern - Field in NoDefRule

excludes - Field in CodeNarc

execute(String) - Method in CodeNarc

execute() - Method in CodeNarcRunner

The main entry point for this class.

execute() - Method in CodeNarcTask

Execute this Ant Task

exists() - Method in ClassPathResource

@return true only if this resource exists and is accessible

exists() - Method in Resource

@return true only if this resource exists and is accessible

exists() - Method in UrlResource

@return true only if this resource exists and is accessible

ExplicitArrayListInstantiationRule - Class in org.codenarc.rule.groovyism

This rule checks for the explicit instantiation of an ArrayList using the no-arg constructor.

ExplicitCallToAndMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToAndMethodAstVisitor() - Constructor in ExplicitCallToAndMethodAstVisitor

ExplicitCallToAndMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the and(Object) method is called directly in code instead of using the & operator.

ExplicitCallToCompareToMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToCompareToMethodAstVisitor() - Constructor in ExplicitCallToCompareToMethodAstVisitor

ExplicitCallToCompareToMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the compareTo(Object) method is called directly in code instead of using the <=>, >, >=, <, and <= operators.

ExplicitCallToDivMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToDivMethodAstVisitor() - Constructor in ExplicitCallToDivMethodAstVisitor

ExplicitCallToDivMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the div(Object) method is called directly in code instead of using the / operator.

ExplicitCallToEqualsMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToEqualsMethodAstVisitor() - Constructor in ExplicitCallToEqualsMethodAstVisitor

ExplicitCallToEqualsMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the equals(Object) method is called directly in code instead of using the == or !

ExplicitCallToGetAtMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToGetAtMethodAstVisitor() - Constructor in ExplicitCallToGetAtMethodAstVisitor

ExplicitCallToGetAtMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the getAt(Object) method is called directly in code instead of using the [] index operator.

ExplicitCallToLeftShiftMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToLeftShiftMethodAstVisitor() - Constructor in ExplicitCallToLeftShiftMethodAstVisitor

ExplicitCallToLeftShiftMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the leftShift(Object) method is called directly in code instead of using the << operator.

ExplicitCallToMethodAstVisitor - Class in org.codenarc.rule.groovyism

Parent Visitor for "ExplicitCallToX" Rules.

ExplicitCallToMethodAstVisitor(String) - Constructor in ExplicitCallToMethodAstVisitor

@param methodName The method name to watch for.

ExplicitCallToMinusMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToMinusMethodAstVisitor() - Constructor in ExplicitCallToMinusMethodAstVisitor

ExplicitCallToMinusMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the minus(Object) method is called directly in code instead of using the - operator.

ExplicitCallToModMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToModMethodAstVisitor() - Constructor in ExplicitCallToModMethodAstVisitor

ExplicitCallToModMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the mod(Object) method is called directly in code instead of using the % operator.

ExplicitCallToMultiplyMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToMultiplyMethodAstVisitor() - Constructor in ExplicitCallToMultiplyMethodAstVisitor

ExplicitCallToMultiplyMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the multiply(Object) method is called directly in code instead of using the * operator.

ExplicitCallToOrMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToOrMethodAstVisitor() - Constructor in ExplicitCallToOrMethodAstVisitor

ExplicitCallToOrMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the or(Object) method is called directly in code instead of using the | operator.

ExplicitCallToPlusMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToPlusMethodAstVisitor() - Constructor in ExplicitCallToPlusMethodAstVisitor

ExplicitCallToPlusMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the plus(Object) method is called directly in code instead of using the + operator.

ExplicitCallToPowerMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToPowerMethodAstVisitor() - Constructor in ExplicitCallToPowerMethodAstVisitor

ExplicitCallToPowerMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the power(Object) method is called directly in code instead of using the ** operator.

ExplicitCallToPutAtMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToPutAtMethodAstVisitor() - Constructor in ExplicitCallToPutAtMethodAstVisitor

ExplicitCallToPutAtMethodRule - Class in org.codenarc.rule.groovyism

etects when the map.putAt(k, v) method is called directly rather than using map[k] = v.

ExplicitCallToRightShiftMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToRightShiftMethodAstVisitor() - Constructor in ExplicitCallToRightShiftMethodAstVisitor

ExplicitCallToRightShiftMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the rightShift(Object) method is called directly in code instead of using the >> operator.

ExplicitCallToXorMethodAstVisitor - Class in org.codenarc.rule.groovyism

ExplicitCallToXorMethodAstVisitor() - Constructor in ExplicitCallToXorMethodAstVisitor

ExplicitCallToXorMethodRule - Class in org.codenarc.rule.groovyism

This rule detects when the xor(Object) method is called directly in code instead of using the ^ operator.

ExplicitGarbageCollectionAstVisitor - Class in org.codenarc.rule.basic

ExplicitGarbageCollectionRule - Class in org.codenarc.rule.basic

Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised.

ExplicitHashMapInstantiationRule - Class in org.codenarc.rule.groovyism

This rule checks for the explicit instantiation of a HashMap using the no-arg constructor.

ExplicitHashSetInstantiationRule - Class in org.codenarc.rule.groovyism

This rule checks for the explicit instantiation of a HashSet using the no-arg constructor.

ExplicitLinkedHashMapInstantiationRule - Class in org.codenarc.rule.groovyism

This rule checks for the explicit instantiation of a LinkedHashMap using the no-arg constructor.

ExplicitLinkedListInstantiationRule - Class in org.codenarc.rule.groovyism

This rule checks for the explicit instantiation of a LinkedList using the no-arg constructor.

ExplicitStackInstantiationRule - Class in org.codenarc.rule.groovyism

This rule checks for the explicit instantiation of a Stack using the no-arg constructor.

ExplicitTreeSetInstantiationRule - Class in org.codenarc.rule.groovyism

This rule checks for the explicit instantiation of a TreeSet using the no-arg constructor.

ExplicitTypeInstantiationAstVisitor - Class in org.codenarc.rule.groovyism

AstVisitor that checks for no-arg constructor calls for the type specified in the constructor.

ExplicitTypeInstantiationAstVisitor(String) - Constructor in ExplicitTypeInstantiationAstVisitor

expressionIsAssignment(ASTNode, String) - Method in AstUtil

expressionIsNullCheck(ASTNode) - Method in AstUtil

extractFrom(AnnotationNode) - Method in ConstantExpressionExtractor

extractMethodName(def) - Method in AbstractMethodMetricAstVisitor

F

FactoryMethodNameAstVisitor - Class in org.codenarc.rule.naming

FactoryMethodNameRule - Class in org.codenarc.rule.naming

A factory method is a method that creates objects, and they are typically named either buildFoo(), makeFoo(), or createFoo().

FieldNameAstVisitor - Class in org.codenarc.rule.naming

FieldNameRule - Class in org.codenarc.rule.naming

Rule that verifies that the name of each field matches a regular expression.

FieldReferenceAstVisitor - Class in org.codenarc.rule

AST Visitor that searches for references to the fields specified on the constructor

FieldReferenceAstVisitor(Collection<FieldNode>) - Constructor in FieldReferenceAstVisitor

fieldReferenced(String) - Method in ConstructorsSkippingFieldReferenceAstVisitor

fieldReferenced(String) - Method in FieldReferenceAstVisitor

FieldTypeRequiredAstVisitor - Class in org.codenarc.rule.convention

FieldTypeRequiredRule - Class in org.codenarc.rule.convention

Checks that field types are explicitly specified (and not using def)

FileCreateTempFileAstVisitor - Class in org.codenarc.rule.security

FileCreateTempFileRule - Class in org.codenarc.rule.security

The File.createTempFile() method is insecure, and has been deprecated by the ESAPI secure coding library.

FileEndsWithoutNewlineRule - Class in org.codenarc.rule.formatting

Makes sure the source code file ends with a newline character.

FileResults - Class in org.codenarc.results

Represents the results of applying a set of rules against a single sourcefile

FileResults(String, List, SourceCode) - Constructor in FileResults

fileSets - Field in AntFileSetSourceAnalyzer

fileSets - Field in CodeNarcTask

FilesystemSourceAnalyzer - Class in org.codenarc.analyzer

SourceAnalyzer implementation that recursively processes files from the file system.

FileViolations - Class in org.codenarc.plugin

Represents the violations and associated results metadata for a single file

FileViolations(FileResults) - Constructor in FileViolations

FilteredRuleSet - Class in org.codenarc.ruleset

A RuleSet implementation that is a Decorator for another RuleSet, but provides the ability to filter included and excluded rules within that RuleSet.

FilteredRuleSet(RuleSet) - Constructor in FilteredRuleSet

Construct a new instance on the specified RuleSet

filterSuppressedViolations(Iterable<Violation>) - Method in SuppressionAnalyzer

FinalClassWithProtectedMemberAstVisitor - Class in org.codenarc.rule.design

FinalClassWithProtectedMemberRule - Class in org.codenarc.rule.design

This rule finds classes marked final that contain protected methods and fields.

findClassDeclarationLineNumber(ClassNode, SourceCode) - Method in AstUtil

findFirstNonAnnotationLine(ASTNode, SourceCode) - Method in AstUtil

gets the first non annotation line number of a node, taking into account annotations.

findLineNumberOfFirstClassDeclaration(SourceCode) - Method in AbstractImportRule

Optimization: Stop checking lines for imports once a class/interface has been declared

findResultsForPath(String) - Method in DirectoryResults

Return the Results object with the specified path within this directory or its descendents.

findResultsForPath(String) - Method in FileResults

Return the Results object with the specified path.

findResultsForPath(String) - Method in Results

Return the Results object with the specified path within this results object or its descendents.

findResultsForPath(String) - Method in VirtualResults

firstNonWhitespaceColumn(String) - Method in IndentationAstVisitor

ForLoopShouldBeWhileLoopAstVisitor - Class in org.codenarc.rule.basic

ForLoopShouldBeWhileLoopRule - Class in org.codenarc.rule.basic

For loops where init and update statements are empty can be simplified to while loops.

formatSourceLine(String, int) - Method in AbstractHtmlReportWriter

Format and trim the source line.

ForStatementBracesAstVisitor - Class in org.codenarc.rule.braces

ForStatementBracesRule - Class in org.codenarc.rule.braces

Rule that checks that for statements use braces rather than a single statement.

G

GenerateAll - Class in org.codenarc.tool

Java application (main() method) that invokes all of the Generate* scripts.

GenerateCodeNarcRulesProperties - Class in org.codenarc.tool

Java application (main() method) that generates the 'codenarc-base-rules.properties' properties file.

GenerateRuleIndexPages - Class in org.codenarc.tool

Java application (main() method) that generates the "codenarc-rule-index.md.template" file.

GenerateRuleSetAllRules - Class in org.codenarc.tool

Java application (main() method) that generates the "StarterRuleSet-AllRules.groovy.txt.template" file.

GenerateRuleSetAllRulesByCategory - Class in org.codenarc.tool

Java application (main() method) that generates the "StarterRuleSet-AllRulesByCategory.groovy.txt.template" file.

GenerateUtil - Class in org.codenarc.tool

Contains static utility methods related to the Generate* tools.

getAllImports(SourceCode) - Method in ImportUtil

getAnnotation(AnnotatedNode, String) - Method in AstUtil

Return the AnnotationNode for the named annotation, or else null.

getApplyToClassNames() - Method in AbstractAstVisitorRule

getApplyToFileNames() - Method in AbstractRule

getApplyToFilesMatching() - Method in AbstractRule

getArgumentNames(MethodCallExpression) - Method in AstUtil

Gets the argument names of a method call.

getAst() - Method in AbstractSourceCode

Return the Groovy AST (Abstract Syntax Tree) for this source file

getAst() - Method in GMetricsSourceCodeAdapter

getAst() - Method in SourceCode

Return the Groovy AST (Abstract Syntax Tree) for this source file

getAstCompilerPhase() - Method in AbstractSourceCode

@return compiler phase (as in org.codehaus.groovy.control.Phases) up to which the AST will be processed

getAstCompilerPhase() - Method in CustomCompilerPhaseSourceDecorator

getAstCompilerPhase() - Method in SourceCode

@return compiler phase (as in org.codehaus.groovy.control.Phases) up to which the AST will be processed

getAstVisitor() - Method in AbstractAstVisitorRule

getAstVisitor(SourceCode) - Method in AbstractSharedAstVisitorRule

Subclasses can override to provide an AstVisitor with SourceCode or AST-specific initialization.

getAstVisitor() - Method in CatchArrayIndexOutOfBoundsExceptionRule

getAstVisitor() - Method in CatchErrorRule

getAstVisitor() - Method in CatchExceptionRule

getAstVisitor() - Method in CatchIllegalMonitorStateExceptionRule

getAstVisitor() - Method in CatchIndexOutOfBoundsExceptionRule

getAstVisitor() - Method in CatchNullPointerExceptionRule

getAstVisitor() - Method in CatchRuntimeExceptionRule

getAstVisitor() - Method in CatchThrowableRule

getAstVisitor() - Method in CrapMetricRule

getAstVisitor() - Method in DuplicateNumberLiteralRule

getAstVisitor() - Method in DuplicateStringLiteralRule

getAstVisitor() - Method in ExplicitArrayListInstantiationRule

getAstVisitor() - Method in ExplicitHashMapInstantiationRule

getAstVisitor() - Method in ExplicitHashSetInstantiationRule

getAstVisitor() - Method in ExplicitLinkedHashMapInstantiationRule

getAstVisitor() - Method in ExplicitLinkedListInstantiationRule

getAstVisitor() - Method in ExplicitStackInstantiationRule

getAstVisitor() - Method in ExplicitTreeSetInstantiationRule

getAstVisitor() - Method in GrailsDomainReservedSqlKeywordNameRule

getAstVisitor() - Method in HashtableIsObsoleteRule

getAstVisitor() - Method in IllegalClassReferenceRule

getAstVisitor() - Method in JdbcConnectionReferenceRule

getAstVisitor() - Method in JdbcResultSetReferenceRule

getAstVisitor() - Method in JdbcStatementReferenceRule

getAstVisitor() - Method in JUnitTestMethodWithoutAssertRule

getAstVisitor() - Method in ThrowErrorRule

getAstVisitor() - Method in ThrowExceptionRule

getAstVisitor() - Method in ThrowNullPointerExceptionRule

getAstVisitor() - Method in ThrowRuntimeExceptionRule

getAstVisitor() - Method in ThrowThrowableRule

getAstVisitor(SourceCode) - Method in UnusedPrivateFieldRule

getAstVisitor(SourceCode) - Method in UnusedPrivateMethodRule

getAstVisitor() - Method in VectorIsObsoleteRule

getAstVisitorClass() - Method in AbstractAstVisitorRule

Each concrete subclass must either set this property or define its own property with the same name

getChildren() - Method in DirectoryResults

@return the List of child Results objects; may be empty

getChildren() - Method in FileResults

Return an empty List

getChildren() - Method in Results

@return the List of child Results objects; may be empty

getChildren() - Method in VirtualResults

getCodeNarcVersion() - Method in AbstractReportWriter

getColumn() - Method in Value

getCompilerPhase() - Method in AbstractEnhanceableAstVisitorRule

getCompilerPhase() - Method in AbstractRule

@return the required compiler phase (as in org.codehaus.groovy.control.Phases) of the AST of the SourceCode handed to the rule via applyTo(SourceCode sourceCode)

getCompilerPhase() - Method in Rule

@return the required compiler phase (as in org.codehaus.groovy.control.Phases) of the AST of the SourceCode handed to the rule via applyTo(SourceCode sourceCode)

getCssFile() - Method in AbstractHtmlReportWriter

getCurrentClassName() - Method in AbstractAstVisitor

getCurrentClassName() - Method in AbstractMethodVisitor

getCurrentClassNode() - Method in AbstractAstVisitor

getCurrentClassNode() - Method in AbstractMethodVisitor

getDeclaration(ASTNode, SourceCode) - Method in AstUtil

getDescription() - Method in AbstractRule

getDescriptionForRule(Rule) - Method in AbstractReportWriter

getDoNotApplyToClassNames() - Method in AbstractAstVisitorRule

getDoNotApplyToFileNames() - Method in AbstractRule

getDoNotApplyToFilesMatching() - Method in AbstractRule

getEmptyBlock(Statement) - Method in AstUtil

getFieldType(FieldNode) - Method in AstUtil

Supports discovering many common JDK types, but not all.

getFormattedTimestamp() - Method in AbstractReportWriter

getGormStaticMethodsNames() - Method in GrailsDomainGormMethodsRule

getHtmlDescriptionForRule(Rule) - Method in AbstractReportWriter

getInputStream() - Method in ClassPathResource

Open an InputStream on the classpath resource path

getInputStream() - Method in Resource

Return the InputStream for this resource.

getInputStream() - Method in UrlResource

Open a FileInputStream on the file

getInstanceOfTarget(Object) - Method in AstUtil

getLastLineOfNodeText(ASTNode, SourceCode) - Method in AstUtil

getLineNumber(MetricResult) - Method in AbstractMethodMetricAstVisitor

getLineNumberForCharacterIndex(int) - Method in AbstractSourceCode

Return the line index for the line containing the character at the specified index within the source code.

getLineNumberForCharacterIndex(int) - Method in GMetricsSourceCodeAdapter

getLineNumberForCharacterIndex(int) - Method in SourceCode

Return the line index for the line containing the character at the specified index within the source code.

getLines() - Method in AbstractSourceCode

@return the List of lines of the source code (with line terminators removed)

getLines() - Method in GMetricsSourceCodeAdapter

getLines() - Method in SourceCode

@return the List of lines of the source code (with line terminators removed)

getMaxClassAverageMethodMetricValue() - Method in AbcMetricAstVisitor

getMaxClassAverageMethodMetricValue() - Method in AbstractMethodMetricAstVisitor

getMaxClassAverageMethodMetricValue() - Method in CrapMetricAstVisitor

getMaxClassAverageMethodMetricValue() - Method in CyclomaticComplexityAstVisitor

getMaxClassMetricValue() - Method in AbcMetricAstVisitor

getMaxClassMetricValue() - Method in AbstractMethodMetricAstVisitor

getMaxClassMetricValue() - Method in CrapMetricAstVisitor

getMaxClassMetricValue() - Method in CyclomaticComplexityAstVisitor

getMaxMethodMetricValue() - Method in AbcMetricAstVisitor

getMaxMethodMetricValue() - Method in AbstractMethodMetricAstVisitor

getMaxMethodMetricValue() - Method in CrapMetricAstVisitor

getMaxMethodMetricValue() - Method in CyclomaticComplexityAstVisitor

getMethodArguments(ASTNode) - Method in AstUtil

Return the List of Arguments for the specified MethodCallExpression or a ConstructorCallExpression.

getMethodCallExpressions() - Method in AbstractSourceCode

getMethodCallExpressions() - Method in SourceCode

This method gives you all of the MethodCallExpressions defined in the AST without forcing you to walk the entire tree on every request.

getMetricShortDescription() - Method in AbstractMethodMetricAstVisitor

getMovedOrRenamedMessageForRuleName(String) - Method in MovedRules

getName() - Method in AbstractRule

@return the unique name for this rule

getName() - Method in AbstractTestCase

getName() - Method in CustomCompilerPhaseSourceDecorator

getName() - Method in GMetricsSourceCodeAdapter

getName(String) - Method in PathUtil

getName() - Method in Rule

@return the unique id for this rule

getName() - Method in SourceCode

Get the logical name for this source code.

getName() - Method in SourceFile

@return the filename for this source file, excluding path

getNodeText(ASTNode, SourceCode) - Method in AstUtil

getNonStaticImportsSortedByLineNumber(SourceCode) - Method in ImportUtil

getNullComparisonTarget(Object) - Method in AstUtil

getNumberOfFilesWithViolations(int, boolean) - Method in DirectoryResults

Return the number of files with violations

getNumberOfFilesWithViolations(int, boolean) - Method in FileResults

Return 1 if these results include at least one violation

getNumberOfFilesWithViolations(int, boolean) - Method in Results

Return the number of files with violations

getNumberOfFilesWithViolations(int, boolean) - Method in VirtualResults

getNumberOfViolationsWithPriority(int, boolean) - Method in DirectoryResults

Return the number of violations with the specified priority

getNumberOfViolationsWithPriority(int, boolean) - Method in FileResults

@param recursive - ignored

getNumberOfViolationsWithPriority(int, boolean) - Method in Results

Return the number of violations with the specified priority

getNumberOfViolationsWithPriority(int, boolean) - Method in VirtualResults

getParameterNames(MethodNode) - Method in AstUtil

Gets the parameter names of a method node.

getParentPath(String) - Method in PathUtil

getPath() - Method in CustomCompilerPhaseSourceDecorator

getPath() - Method in DirectoryResults

@return the path to the file or directory associated with these results

getPath() - Method in FileResults

@return the path to the file or directory associated with these results

getPath() - Method in GMetricsSourceCodeAdapter

getPath() - Method in Results

@return the path to the file or directory associated with these results

getPath() - Method in SourceCode

Get the logical path for this source code.

getPath() - Method in SourceFile

@return the normalized path for this source file, including filename

getPath() - Method in VirtualResults

getPlugins() - Method in CodeNarcRunner

getPriority() - Method in AbstractRule

@return the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

getPriority() - Method in Rule

@return the priority of this rule; must be 1, 2 or 3

getRawLine(SourceCode, int) - Method in AstUtil

getRawViolations() - Method in FileResults

Not intended for general use

getReportWriter(String, Map) - Method in ReportWriterFactory

getResource(String) - Method in DefaultResourceFactory

Return a Resource instance suitable for the specified path.

getResource(String) - Method in ResourceFactory

Return a Resource instance suitable for the specified path.

getResourceBundleString(String, String, boolean) - Method in AbstractReportWriter

getRule() - Method in AbstractAstVisitor

getRule() - Method in AbstractFieldVisitor

Gets the rule for this visitor.

getRule() - Method in AbstractMethodCallExpressionVisitor

Gets the rule for this visitor.

getRule() - Method in AbstractMethodVisitor

Gets the rule for this visitor.

getRuleClass(String) - Method in PropertiesFileRuleRegistry

Return the Rule Class for the specified name or else null

getRuleClass(String) - Method in RuleRegistry

getRuleExtraInformation() - Method in GenerateUtil

getRules() - Method in CompositeRuleSet

Returns:

a List of Rule objects.

getRules() - Method in FilteredRuleSet

Return the List of Rules that match the include(s) (if specified) AND DO NOT match any exclude(s) specified.

getRules() - Method in GroovyDslRuleSet

@return a List of Rule objects

getRules() - Method in JsonFileRuleSet

@return a List of Rule objects

getRules() - Method in JsonReaderRuleSet

@return a List of Rule objects

getRules() - Method in ListRuleSet

@return a List of Rule objects

getRules() - Method in RuleSet

@return a List of optionally configured Rule objects

getRules() - Method in XmlFileRuleSet

@return a List of Rule objects

getRules() - Method in XmlReaderRuleSet

@return a List of Rule objects

getRuleSet() - Method in RuleSetBuilder

getRuleSet() - Method in TopLevelDelegate

getSortedRules(AnalysisContext) - Method in AbstractReportWriter

getSourceBetweenNodes(ASTNode, ASTNode, SourceCode) - Method in AstUtil

getSourceCode() - Method in AbstractAstVisitor

getSourceCode() - Method in AbstractFieldVisitor

getSourceCode() - Method in AbstractMethodCallExpressionVisitor

getSourceCode() - Method in AbstractMethodVisitor

getSourceDirectories() - Method in AntFileSetSourceAnalyzer

getSourceDirectories() - Method in FilesystemSourceAnalyzer

getSourceDirectories() - Method in SourceAnalyzer

Return the List of source directories to be analyzed.

getSourceDirectories() - Method in StringSourceAnalyzer

getSourceLine(Integer) - Method in AbstractMethodMetricAstVisitor

getSourceLinesForNode(ASTNode, SourceCode) - Method in AstUtil

getSourceUnit() - Method in AbstractAstVisitor

getSourceUnit() - Method in AbstractFieldVisitor

getSourceUnit() - Method in AbstractMethodCallExpressionVisitor

getSourceUnit() - Method in AbstractMethodVisitor

getSourceUnit() - Method in ReferenceCollector

getSuppressionAnalyzer() - Method in CustomCompilerPhaseSourceDecorator

getSuppressionAnalyzer() - Method in SourceCode

Returns information about this classes' suppressed warnings.

getTag() - Method in AbstractJavadocEmptyTagRule

getTag() - Method in AbstractJavadocMissingDescriptionRule

getTag() - Method in JavadocEmptyAuthorTagRule

getTag() - Method in JavadocEmptyExceptionTagRule

getTag() - Method in JavadocEmptyParamTagRule

getTag() - Method in JavadocEmptyReturnTagRule

getTag() - Method in JavadocEmptySeeTagRule

getTag() - Method in JavadocEmptySinceTagRule

getTag() - Method in JavadocEmptyThrowsTagRule

getTag() - Method in JavadocEmptyVersionTagRule

getTag() - Method in JavadocMissingExceptionDescriptionRule

getTag() - Method in JavadocMissingParamDescriptionRule

getTag() - Method in JavadocMissingThrowsDescriptionRule

GetterMethodCouldBePropertyAstVisitor - Class in org.codenarc.rule.groovyism

GetterMethodCouldBePropertyRule - Class in org.codenarc.rule.groovyism

If a class defines a public method that follows the Java getter notation and returns a constant, then it is cleaner to provide a Groovy property for the value rather than a Groovy method.

getText() - Method in CustomCompilerPhaseSourceDecorator

getText() - Method in GMetricsSourceCodeAdapter

getText() - Method in SourceCode

@return the full text of the source code

getText() - Method in SourceFile

@return the full text of the source code

getText() - Method in SourceString

@return the full text of the source code

getTimestamp - Field in AbstractReportWriter

getTotalNumberOfFiles(boolean) - Method in DirectoryResults

Return the total number of (Groovy) files analyzed

getTotalNumberOfFiles(boolean) - Method in FileResults

Return the total number of (Groovy) files analyzed

getTotalNumberOfFiles(boolean) - Method in Results

Return the total number of (Groovy) files analyzed

getTotalNumberOfFiles(boolean) - Method in VirtualResults

getUnreferencedFields() - Method in FieldReferenceAstVisitor

getValue() - Method in Value

getValues() - Method in ValueRecorder

getVariableExpressions(DeclarationExpression) - Method in AstUtil

Return the List of VariableExpression objects referenced by the specified DeclarationExpression.

getViolationLocationString(Violation, String) - Method in IdeTextReportWriter

getViolationLocationString(Violation, String) - Method in TextReportWriter

getViolationMessage(ConstructorCallExpression) - Method in AbstractConstructorCallAstVisitor

getViolationMessage() - Method in AbstractRule

getViolationMessage(ConstructorCallExpression) - Method in BigDecimalInstantiationAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToAndMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToCompareToMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToDivMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToEqualsMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToGetAtMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToLeftShiftMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToMinusMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToModMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToMultiplyMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToOrMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToPlusMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToPowerMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToPutAtMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToRightShiftMethodAstVisitor

getViolationMessage(MethodCallExpression) - Method in ExplicitCallToXorMethodAstVisitor

getViolationMessage(ConstructorCallExpression) - Method in UnnecessaryBooleanInstantiationAstVisitor

getViolationMessage(ConstructorCallExpression) - Method in UnnecessaryStringInstantiationAstVisitor

getViolations() - Method in AbstractAstVisitor

getViolations() - Method in AbstractFieldVisitor

Retrieve the List of Violations resulting from applying this visitor

getViolations() - Method in AbstractMethodCallExpressionVisitor

Retrieve the List of Violations resulting from applying this visitor

getViolations() - Method in AbstractMethodVisitor

Retrieve the List of Violations resulting from applying this visitor

getViolations(AstVisitor, SourceCode) - Method in AbstractSharedAstVisitorRule

getViolations() - Method in AstVisitor

Retrieve the List of Violations resulting from applying this visitor

getViolations() - Method in DirectoryResults

@return the List of all violations; may be empty

getViolations() - Method in FileResults

@return the List of all violations

getViolations() - Method in ImplicitClosureParameterAstVisitor

getViolations(AstVisitor, SourceCode) - Method in PrivateFieldCouldBeFinalRule

getViolations() - Method in Results

@return the List of all violations; may be empty

getViolations(AstVisitor, SourceCode) - Method in UnusedPrivateFieldRule

getViolations(AstVisitor, SourceCode) - Method in UnusedPrivateMethodRule

getViolations() - Method in VirtualResults

getVisited() - Method in AbstractAstVisitor

GMetricsSourceCodeAdapter - Class in org.codenarc.rule.size

Adapter that adapts from a GMetrics SourceCode object to a CodeNarc SourceCode object.

GMetricsSourceCodeAdapter(SourceCode) - Constructor in GMetricsSourceCodeAdapter

GrailsDomainCantReferenceServiceAstVisitor - Class in org.codenarc.rule.grails

GrailsDomainGormMethodsAstVisitor - Class in org.codenarc.rule.grails

GrailsDomainGormMethodsRule - Class in org.codenarc.rule.grails

Database operation should be performed by Data Services instead of calling GORM static and instance methods.

GrailsDomainHasEqualsAstVisitor - Class in org.codenarc.rule.grails

GrailsDomainHasEqualsRule - Class in org.codenarc.rule.grails

Checks that Grails domain classes redefine equals().

GrailsDomainHasToStringAstVisitor - Class in org.codenarc.rule.grails

GrailsDomainHasToStringRule - Class in org.codenarc.rule.grails

Checks that Grails domain classes redefine toString()

GrailsDomainReservedSqlKeywordNameAstVisitor - Class in org.codenarc.rule.grails

GrailsDomainReservedSqlKeywordNameAstVisitor(Set<String>, Set<String>) - Constructor in GrailsDomainReservedSqlKeywordNameAstVisitor

GrailsDomainReservedSqlKeywordNameRule - Class in org.codenarc.rule.grails

Forbids usage of SQL reserved keywords as class or field names in Grails domain classes.

GrailsDomainStringPropertyMaxSizeAstVisitor - Class in org.codenarc.rule.grails

GrailsDomainStringPropertyMaxSizeRule - Class in org.codenarc.rule.grails

String properties in Grails domain classes have to define maximum size otherwise the property is mapped to VARCHAR(255) causing runtime exceptions to occur

GrailsDomainWithServiceReferenceRule - Class in org.codenarc.rule.grails

Checks that Grails Domain classes do not have Service classes injected.

GrailsDuplicateConstraintAstVisitor - Class in org.codenarc.rule.grails

GrailsDuplicateConstraintRule - Class in org.codenarc.rule.grails

Check for duplicate constraints entry

GrailsDuplicateMappingAstVisitor - Class in org.codenarc.rule.grails

GrailsDuplicateMappingRule - Class in org.codenarc.rule.grails

Check for duplicate entry in a domain class mapping

GrailsMassAssignmentAstVisitor - Class in org.codenarc.rule.grails

GrailsMassAssignmentRule - Class in org.codenarc.rule.grails

Untrusted input should not be allowed to set arbitrary object fields without restriction.

GrailsPublicControllerMethodAstVisitor - Class in org.codenarc.rule.grails

GrailsPublicControllerMethodRule - Class in org.codenarc.rule.grails

Rule that checks for public methods on Grails controller classes.

GrailsPublicControllerMethodRule() - Constructor in GrailsPublicControllerMethodRule

GrailsServletContextReferenceAstVisitor - Class in org.codenarc.rule.grails

GrailsServletContextReferenceRule - Class in org.codenarc.rule.grails

Rule that checks for references to the servletContext object from within Grails controller and taglib classes.

GrailsStatelessServiceRule - Class in org.codenarc.rule.grails

Rule that checks for non-final fields on a Grails service class.

GrailsStatelessServiceRule() - Constructor in GrailsStatelessServiceRule

GrailsUtil - Class in org.codenarc.rule.grails

Utility methods and constants for Grails rule classes.

GroovyDslRuleSet - Class in org.codenarc.ruleset

A RuleSet implementation that parses a Groovy DSL of RuleSet definitions.

GroovyDslRuleSet(String) - Constructor in GroovyDslRuleSet

Construct a new instance on the specified Groovy DSL RuleSet file path

GroovyLangImmutableAstVisitor - Class in org.codenarc.rule.groovyism

GroovyLangImmutableRule - Class in org.codenarc.rule.groovyism

The groovy.lang.Immutable annotation has been deprecated and replaced by groovy.transform.Immutable.

GroovyVersion - Class in org.codenarc.util

Utility class to provide Groovy system information

group(String) - Method in CommentsUtil

GStringAsMapKeyAstVisitor - Class in org.codenarc.rule.groovyism

GStringAsMapKeyRule - Class in org.codenarc.rule.groovyism

A rule that disallows GStrings as map keys as they might change their hashcode over time.

GStringExpressionWithinStringAstVisitor - Class in org.codenarc.rule.groovyism

GStringExpressionWithinStringRule - Class in org.codenarc.rule.groovyism

Check for regular (single quote) strings containing a GString-type expression (${..}).

H

handleClosure(ClosureExpression) - Method in BooleanMethodReturnsNullAstVisitor

handleClosure(ClosureExpression) - Method in ReturnsNullInsteadOfEmptyArrayAstVisitor

handleClosure(ClosureExpression) - Method in ReturnsNullInsteadOfEmptyCollectionRuleAstVisitor

handleClosure(ClosureExpression) - Method in ToStringReturnsNullAstVisitor

HardCodedWindowsFileSeparatorAstVisitor - Class in org.codenarc.rule.basic

HardCodedWindowsFileSeparatorRule - Class in org.codenarc.rule.basic

This rule finds usages of a Windows file separator within the constructor call of a File object.

HardcodedWindowsRootDirectoryAstVisitor - Class in org.codenarc.rule.basic

HardCodedWindowsRootDirectoryRule - Class in org.codenarc.rule.basic

This rule find cases where a File object is constructed with a windows-based path.

hasAnnotation(AnnotatedNode, String) - Method in AstUtil

Return true only if the node has the named annotation

hasAnyAnnotation(AnnotatedNode, String) - Method in AstUtil

Return true only if the node has any of the named annotations

HashtableIsObsoleteRule - Class in org.codenarc.rule.convention

Check for direct use of Vector or java.util.Hashtable.

hasTextOnNextLine(SourceCode, int) - Method in CommentsUtil

haveTheSameConstantOrLiteralValue(Expression, Expression) - Method in DryUtil

@return true only if both Expressions have the same constant or literal value

haveTheSameConstantPropertyExpression(Expression, Expression) - Method in DryUtil

@return true only if both Expressions have the same constant property expression (e.g., Object.Property)

haveTheSameConstantValue(Expression, Expression) - Method in DryUtil

@return true only if both Expressions have the same constant or literal values

haveTheSameListLiteralValue(Expression, Expression) - Method in DryUtil

@return true only if both Expressions are ListExpressions and both have the same set of constant or literal values, in the same order.

haveTheSameMapLiteralValue(Expression, Expression) - Method in DryUtil

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

HELP - Field in CodeNarc

HtmlReportWriter - Class in org.codenarc.report

ReportWriter that generates an HTML report.

I

IdeTextReportWriter - Class in org.codenarc.report

ReportWriter that generates an simple ASCII text report, and includes IDE-compatible (Eclipse, Idea) hyperlinks to source code for violations.

IfStatementBracesAstVisitor - Class in org.codenarc.rule.braces

IfStatementBracesRule - Class in org.codenarc.rule.braces

Rule that checks that if statements use braces rather than a single statement.

IfStatementCouldBeTernaryAstVisitor - Class in org.codenarc.rule.convention

IfStatementCouldBeTernaryRule - Class in org.codenarc.rule.convention

Checks for:

IllegalClassMemberAstVisitor - Class in org.codenarc.rule.generic

IllegalClassMemberRule - Class in org.codenarc.rule.generic

Checks for classes containing fields/properties/methods matching configured illegal member modifiers.

IllegalClassReferenceRule - Class in org.codenarc.rule.generic

Checks for reference to any of the named classes.

illegalFieldModifiersList - Field in IllegalClassMemberRule

illegalFieldModifiersString - Field in IllegalClassMemberRule

illegalMethodModifiersList - Field in IllegalClassMemberRule

illegalMethodModifiersString - Field in IllegalClassMemberRule

IllegalPackageReferenceAstVisitor - Class in org.codenarc.rule.generic

IllegalPackageReferenceRule - Class in org.codenarc.rule.generic

Checks for reference to any of the named packages.

illegalPropertyModifiersList - Field in IllegalClassMemberRule

illegalPropertyModifiersString - Field in IllegalClassMemberRule

IllegalRegexRule - Class in org.codenarc.rule.generic

Checks for a specified illegal regular expression within the source code.

IllegalStringRule - Class in org.codenarc.rule.generic

Checks for a specified illegal string within the source code.

IllegalSubclassAstVisitor - Class in org.codenarc.rule.generic

IllegalSubclassRule - Class in org.codenarc.rule.generic

Checks for classes that extend one of the specified set of illegal superclasses.

ImplementationAsTypeAstVisitor - Class in org.codenarc.rule.design

ImplementationAsTypeRule - Class in org.codenarc.rule.design

Checks for use of the following concrete classes when specifying the type of a method parameter, closure parameter, constructor parameter, method return type or field type (the associated interfaces should be used to specify the type instead):

• java.util.ArrayList
• java.util.GregorianCalendar
• java.util.HashMap
• java.util.HashSet
• java.util.Hashtable
• java.util.LinkedHashMap
• java.util.LinkedHashSet
• java.util.LinkedList
• java.util.TreeMap
• java.util.TreeSet
• java.util.Vector
• java.util.concurrent.ArrayBlockingQueue
• java.util.concurrent.ConcurrentHashMap
• java.util.concurrent.ConcurrentLinkedQueue
• java.util.concurrent.CopyOnWriteArrayList
• java.util.concurrent.CopyOnWriteArraySet
• java.util.concurrent.DelayQueue
• java.util.concurrent.LinkedBlockingQueue
• java.util.concurrent.PriorityBlockingQueue
• java.util.concurrent.PriorityQueue
• java.util.concurrent.SynchronousQueue

ImplicitClosureParameterAstVisitor - Class in org.codenarc.rule.convention

ImplicitClosureParameterCodeVisitor - Class in org.codenarc.rule.convention

ImplicitClosureParameterRule - Class in org.codenarc.rule.convention

Checks that the implicit it closure parameter is not used and that parameters are declared explicitly instead

ImplicitReturnStatementAstVisitor - Class in org.codenarc.rule.convention

ImplicitReturnStatementRule - Class in org.codenarc.rule.convention

Checks for methods that are missing an explicit return statement.

ImportFromSamePackageRule - Class in org.codenarc.rule.imports

Checks for an import of a class that is within the same package as the importing class.

ImportFromSunPackagesRule - Class in org.codenarc.rule.imports

Avoid importing anything from the 'sun.*' packages.

ImportUtil - Class in org.codenarc.util

Contains static utility methods and constants related to Import statements.

include(String) - Method in RuleSetDelegate

includes - Field in CodeNarc

InconsistentPropertyLockingAstVisitor - Class in org.codenarc.rule.concurrency

InconsistentPropertyLockingRule - Class in org.codenarc.rule.concurrency

Class contains similarly-named get and set methods where one method of the pair is marked either

WithReadLock:

or

@WithWriteLock and the other is not locked at all.

InconsistentPropertySynchronizationAstVisitor - Class in org.codenarc.rule.concurrency

InconsistentPropertySynchronizationRule - Class in org.codenarc.rule.concurrency

Class contains similarly-named get and set methods where the set method is synchronized and the get method is not, or the get method is synchronized and the set method is not.

IndentationAstVisitor - Class in org.codenarc.rule.formatting

IndentationRule - Class in org.codenarc.rule.formatting

Check indentation for class and method declarations

indexOfClosingBrace(String, int) - Method in AbstractSpaceAroundBraceAstVisitor

initialize() - Method in AbstractCodeNarcPlugin

initialize() - Method in BaselineResultsPlugin

initialize() - Method in CodeNarcPlugin

Perform plugin initialization

initializeDefaultResourceBundle() - Method in AbstractReportWriter

initializeResourceBundle - Field in AbstractReportWriter

initializeRuleRegistry() - Method in RuleRegistryInitializer

initializeWildcardPatterns() - Method in FilesystemSourceAnalyzer

inlineViolation(String) - Method in AbstractRuleTestCase

Prepares an inline violation with a given message, escaping all '#' characters and preventing accidental escaping of next inline violation's start when the message ends with a '\' character.

inlineViolation(String) - Method in InlineViolationsParser

InlineViolationsParser - Class in org.codenarc.rule

Parser for inline violation metadata within Rule test classes

InlineViolationsParser.ParseResult - Class in org.codenarc.rule

InlineXmlReportWriter - Class in org.codenarc.report

ReportWriter that generates an XML report with inline rule descriptions.

inMultilineComment - Field in MultilineCommentChecker

InsecureRandomAstVisitor - Class in org.codenarc.rule.security

InsecureRandomRule - Class in org.codenarc.rule.security

Reports usages of java.util.Random, which can produce very predictable results.

InstanceofAstVisitor - Class in org.codenarc.rule.design

InstanceofRule - Class in org.codenarc.rule.design

Checks for use of the instanceof operator.

IntegerGetIntegerAstVisitor - Class in org.codenarc.rule.basic

IntegerGetIntegerRule - Class in org.codenarc.rule.basic

This rule catches usages of java.lang.Integer.getInteger(String, ...) which reads an Integer from the System properties.

InterfaceNameAstVisitor - Class in org.codenarc.rule.naming

InterfaceNameRule - Class in org.codenarc.rule.naming

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

InterfaceNameSameAsSuperInterfaceAstVisitor - Class in org.codenarc.rule.naming

InterfaceNameSameAsSuperInterfaceRule - Class in org.codenarc.rule.naming

Checks for any interface that has an identical name to its super-interface, other than the package.

InvertedConditionAstVisitor - Class in org.codenarc.rule.convention

InvertedConditionRule - Class in org.codenarc.rule.convention

An inverted condition is one where a constant expression is used on the left hand side of the equals comparision.

InvertedIfElseAstVisitor - Class in org.codenarc.rule.convention

InvertedIfElseRule - Class in org.codenarc.rule.convention

An inverted if-else statement is one in which there is a single if statement with a single else branch and the boolean test of the if is negated.

isAscii(char) - Method in SourceCodeUtil

isAssertCallWithConstantValue(MethodCallExpression, String, Object) - Method in JUnitUtil

Return true if the MethodCallExpression represents a JUnit assert method call with the specified method name and constant argument value.

isAssertCallWithLiteralValue(MethodCallExpression, String, boolean) - Method in JUnitUtil

Return true if the MethodCallExpression represents a JUnit assert method call with the specified method name and constant argument value.

isAssertCallWithNonNullConstantValue(MethodCallExpression, String) - Method in JUnitUtil

isBinaryExpressionType(Expression, List<String>) - Method in AstUtil

Returns true if the expression is a binary expression with the specified token.

isBlock(Statement) - Method in AstUtil

Return true if the Statement is a block

isBoolean(Expression) - Method in AstUtil

Tells you if the expression is either the true or false literal.

isClosureDeclaration(ASTNode) - Method in AstUtil

Returns true if the ASTNode is a declaration of a closure, either as a declaration or a field.

isConstant(Expression, Object) - Method in AstUtil

Tells you if an expression is the expected constant.

isConstantOrConstantLiteral(Expression) - Method in AstUtil

Returns true if an expression is a constant or else a literal that contains only constant values.

isConstantOrLiteral(Expression) - Method in AstUtil

Tells you if an expression is a constant or literal.

isConstructorCall(Expression, String) - Method in AstUtil

Return true if the expression is a constructor call on a class that matches the supplied.

isConstructorCallAViolation(ConstructorCallExpression) - Method in AbstractConstructorCallAstVisitor

Subclasses must implement to return true if the visited constructor call causes a rule violation

isConstructorCallAViolation(ConstructorCallExpression) - Method in BigDecimalInstantiationAstVisitor

isConstructorCallAViolation(ConstructorCallExpression) - Method in UnnecessaryBooleanInstantiationAstVisitor

isConstructorCallAViolation(ConstructorCallExpression) - Method in UnnecessaryStringInstantiationAstVisitor

isDefinedInJpaEntity(FieldNode) - Method in PrivateFieldCouldBeFinalRule

isDirectoryContainingFiles(Results) - Method in AbstractHtmlReportWriter

Return true if the Results represents a directory that contains at least one file

isDirectoryContainingFilesWithViolations(Results) - Method in AbstractHtmlReportWriter

Return true if the Results represents a directory that contains at least one file with one or more violations.

isEmptyBlock(Statement) - Method in AstUtil

Return true if the Statement is a block and it is empty (contains no "meaningful" statements).

isEnabled(Rule) - Method in AbstractReportWriter

isEnabled() - Method in AbstractRule

isEnhancedMode() - Method in AbstractEnhanceableAstVisitorRule

isFalse(Expression) - Method in AstUtil

Tells you if the expression is the false expression, either literal or constant.

isFile() - Method in DirectoryResults

@return false (this object does not represents the results for a single file)

isFile() - Method in FileResults

@return true (this object represents the results for a single file)

isFile() - Method in Results

@return true only if this object represents the results for a single file

isFile() - Method in VirtualResults

isFinalVariable(DeclarationExpression, SourceCode) - Method in AstUtil

Return true if the DeclarationExpression represents a 'final' variable declaration.

isFirstVisit(Object) - Method in AbstractAstVisitor

Return true if the AST expression has not already been visited.

isFromGeneratedSourceCode(ASTNode) - Method in AstUtil

@return true if the ASTNode was generated (synthetic) rather than from the "real" input source code.

isGeneratedCode(ASTNode) - Method in AbstractAstVisitor

isGroovyVersion2() - Method in GroovyVersion

isIgnoredMethodName(String) - Method in AbstractMethodMetricAstVisitor

isInstanceOfCheck(Object) - Method in AstUtil

isJoinableType(Expression) - Method in ConsecutiveUtils

isLastStatementInBlock(Statement) - Method in AbstractLastStatementInBlockAstVisitor

isListLiteralWithOnlyConstantValues(Expression) - Method in AstUtil

Returns true if a List literal that contains only entries that are constants.

isMapLiteralWithOnlyConstantValues(Expression) - Method in AstUtil

Returns true if a Map literal that contains only entries where both key and value are constants.

isMatchingLoggerDefinition(Expression) - Method in LogUtil

isMethodCall(Expression, String, Range) - Method in AstUtil

Tells you if the expression is a method call for a certain method name with a certain number of arguments.

isMethodCallOnObject(Expression, String) - Method in AstUtil

Tells you if the expression is a method call on a particular object (which is represented as a String).

isMethodNamed(MethodCallExpression, String) - Method in AstUtil

isMethodNode(ASTNode, String) - Method in AstUtil

isNotCharacter(String, char, int) - Method in AbstractSpaceAroundBraceAstVisitor

isNotGeneratedCode(ASTNode) - Method in AbstractAstVisitor

isNotGroovyVersion2() - Method in GroovyVersion

isNotInsideGString() - Method in AbstractSpaceAroundBraceAstVisitor

isNotNullCheck(Object) - Method in AstUtil

isNotWhitespace(String, int) - Method in AbstractSpaceAroundBraceAstVisitor

Return true if the specified (1-based) index is valid and the character at that index is not a whitespace character

isNull(ASTNode) - Method in AstUtil

Tells you if the expression is the null literal.

isNullCheck(Object) - Method in AstUtil

isOneLiner(Object) - Method in AstUtil

isPropertyNamed(Expression, Object) - Method in AstUtil

isPublic(ASTNode) - Method in AstUtil

Tells you if the ASTNode has a public modifier on it.

isReady() - Method in AbstractClassNameRule

isReady() - Method in AbstractRule

Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied.

isReady() - Method in CrapMetricRule

isReady() - Method in IllegalClassMemberRule

isReady() - Method in IllegalClassReferenceRule

isReady() - Method in IllegalPackageReferenceRule

isReady() - Method in IllegalRegexRule

isReady() - Method in IllegalStringRule

isReady() - Method in IllegalSubclassRule

isReady() - Method in InterfaceNameRule

isReady() - Method in PackageNameMatchesFilePathRule

isReady() - Method in RequiredRegexRule

isReady() - Method in RequiredStringRule

isReady() - Method in StatelessClassRule

isRoot(Results) - Method in JsonReportWriter

isRoot(Results) - Method in XmlReportWriter

isRuleSuppressed(Rule) - Method in SuppressionAnalyzer

isSafe(Expression) - Method in AstUtil

Tells you if the expression is a null safe dereference.

isSetUpMethod(MethodNode) - Method in JUnitUtil

isSpreadSafe(Expression) - Method in AstUtil

Tells you if the expression is a spread operator call

isStatementWithinFinally(Statement) - Method in AbstractFinallyAstVisitor

@return true if the specified statement is within a finally block

isSuperReference(Expression) - Method in AstUtil

isTearDownMethod(MethodNode) - Method in JUnitUtil

isTestMethod(ASTNode) - Method in JUnitUtil

Tells you if an ASTNode is a test MethodNode.

isThisReference(Expression) - Method in AstUtil

isTrue(Expression) - Method in AstUtil

Tells you if the expression is true, which can be true or Boolean.TRUE.

isTypeSuffixNecessary(def) - Method in UnnecessaryBigDecimalInstantiationAstVisitor

isTypeSuffixNecessary(def) - Method in UnnecessaryInstantiationAstVisitor

isTypeSuffixNecessary(def) - Method in UnnecessaryIntegerInstantiationAstVisitor

isValid() - Method in AbstractSourceCode

Return true if and only if the source code can be successfully compiled

isValid() - Method in GMetricsSourceCodeAdapter

isValid() - Method in SourceCode

Return true if and only if the source code can be successfully compiled

isValidColumn(int) - Method in IndentationAstVisitor

isVariable(ASTNode, String) - Method in AstUtil

Tells you if the given ASTNode is a VariableExpression with the given name.

isViolationSuppressed(Violation) - Method in SuppressionAnalyzer

isWriteAsSingleLine() - Method in JsonReportWriter

isWriteToStandardOut() - Method in AbstractReportWriter

J

JAVADOC_ANY_LINES - Field in CommentsUtil

JAVADOC_EMPTY_LINE - Field in CommentsUtil

JAVADOC_END - Field in CommentsUtil

JAVADOC_LINE_PREFIX - Field in CommentsUtil

JAVADOC_LINE_WITH_TEXT - Field in CommentsUtil

JAVADOC_START - Field in CommentsUtil

JavadocConsecutiveEmptyLinesRule - Class in org.codenarc.rule.comments

Checks for javadoc comments with more than one consecutive empty line

JavadocEmptyAuthorTagRule - Class in org.codenarc.rule.comments

Checks for empty @author tags in javadoc.

JavadocEmptyExceptionTagRule - Class in org.codenarc.rule.comments

Checks for empty @exception tag within javadoc.

JavadocEmptyFirstLineRule - Class in org.codenarc.rule.comments

Check for javadoc comments with an empty top line

JavadocEmptyLastLineRule - Class in org.codenarc.rule.comments

Check for javadoc comments with an empty line at the bottom

JavadocEmptyParamTagRule - Class in org.codenarc.rule.comments

Checks for empty @param tags within javadoc

JavadocEmptyReturnTagRule - Class in org.codenarc.rule.comments

Checks for empty @return tags within javadoc.

JavadocEmptySeeTagRule - Class in org.codenarc.rule.comments

Checks for empty @see tags within javadoc.

JavadocEmptySinceTagRule - Class in org.codenarc.rule.comments

Checks for empty @since tags within javadoc.

JavadocEmptyThrowsTagRule - Class in org.codenarc.rule.comments

Checks for empty @throws tag within javadoc

JavadocEmptyVersionTagRule - Class in org.codenarc.rule.comments

Checks for empty @version tags within javadoc.

JavadocMissingExceptionDescriptionRule - Class in org.codenarc.rule.comments

Checks for missing description within @exception javadoc tag

JavadocMissingParamDescriptionRule - Class in org.codenarc.rule.comments

Checks for missing description within @param javadoc tags

JavadocMissingThrowsDescriptionRule - Class in org.codenarc.rule.comments

Checks for missing description within @throws javadoc tag

JavaIoPackageAccessAstVisitor - Class in org.codenarc.rule.security

JavaIoPackageAccessRule - Class in org.codenarc.rule.security

This rule reports violations of the Enterprise JavaBeans specification by using the java.io package to access files or the file system.

JdbcConnectionReferenceRule - Class in org.codenarc.rule.jdbc

Check for direct use of java.sql.Connection.

JdbcResultSetReferenceRule - Class in org.codenarc.rule.jdbc

Check for direct use of java.sql.ResultSet, which is not necessary if using the Groovy Sql facility or an ORM framework such as Hibernate.

JdbcStatementReferenceRule - Class in org.codenarc.rule.jdbc

Check for direct use of java.sql.Statement, PreparedStatement, or CallableStatement, which is not necessary if using the Groovy Sql facility or an ORM framework such as Hibernate.

JsonFileRuleSet - Class in org.codenarc.ruleset

A RuleSet implementation that parses Rule definitions from JSON read from a file.

JsonFileRuleSet(String) - Constructor in JsonFileRuleSet

Construct a new instance on the specified RuleSet file path

JsonReaderRuleSet - Class in org.codenarc.ruleset

A RuleSet implementation that parses Rule definitions from Json read from a Reader.

JsonReaderRuleSet(Reader) - Constructor in JsonReaderRuleSet

Construct a new instance on the specified Reader

JsonReportWriter - Class in org.codenarc.report

ReportWriter that generates an JSON report.

JUnitAssertAlwaysFailsAstVisitor - Class in org.codenarc.rule.junit

JUnitAssertAlwaysFailsRule - Class in org.codenarc.rule.junit

Rule that checks for JUnit assert() method calls with constant arguments such that the assertion always fails.

JUnitAssertAlwaysSucceedsAstVisitor - Class in org.codenarc.rule.junit

JUnitAssertAlwaysSucceedsRule - Class in org.codenarc.rule.junit

Rule that checks for JUnit assert() method calls with constant arguments such that the assertion always succeeds.

JUnitAssertEqualsConstantActualValueAstVisitor - Class in org.codenarc.rule.junit

JUnitAssertEqualsConstantActualValueRule - Class in org.codenarc.rule.junit

Reports usages of org.junit.Assert.assertEquals([message,] expected, actual) where the 'actual' parameter is a constant or a literal.

JUnitFailWithoutMessageRule - Class in org.codenarc.rule.junit

This rule detects JUnit calling the fail() method without an argument.

JUnitFailWithoutMessageRuleAstVisitor - Class in org.codenarc.rule.junit

JUnitLostTestAstVisitor - Class in org.codenarc.rule.junit

JUnitLostTestRule - Class in org.codenarc.rule.junit

Rule that checks if a JUnit 4 test class contains public, instance, void, no-arg methods named test*() that are NOT abstract and NOT annotated with

Test.:

JUnitPublicFieldAstVisitor - Class in org.codenarc.rule.junit

JUnitPublicFieldRule - Class in org.codenarc.rule.junit

Checks for public field on a JUnit test class.

JUnitPublicNonTestMethodAstVisitor - Class in org.codenarc.rule.junit

JUnitPublicNonTestMethodRule - Class in org.codenarc.rule.junit

Rule that checks if a JUnit test class contains public methods other than:

• Zero-argument methods with names starting with "test"
• The setUp() and tearDown() methods
• Methods annotated with @Test
• Methods annotated with

  Before:

  and

  @After
• Methods annotated with

  BeforeClass:

  and

  @AfterClass

Public, non-test methods on a test class violate conventional usage of test classes, and can be confusing.

JUnitPublicPropertyAstVisitor - Class in org.codenarc.rule.junit

JUnitPublicPropertyRule - Class in org.codenarc.rule.junit

Checks for public properties defined on JUnit test classes.

JUnitSetUpCallsSuperAstVisitor - Class in org.codenarc.rule.junit

JUnitSetUpCallsSuperRule - Class in org.codenarc.rule.junit

Rule that checks that if the JUnit setUp() method is defined, that it includes a call to super.setUp().

JUnitStyleAssertionsAstVisitor - Class in org.codenarc.rule.junit

JUnitStyleAssertionsRule - Class in org.codenarc.rule.junit

This rule detects calling JUnit style assertions like assertEquals, assertTrue, assertFalse, assertNull, assertNotNull.

JUnitTearDownCallsSuperAstVisitor - Class in org.codenarc.rule.junit

JUnitTearDownCallsSuperRule - Class in org.codenarc.rule.junit

Rule that checks that if the JUnit tearDown() method is defined, that it includes a call to super.tearDown().

JUnitTestMethodWithoutAssertAstVisitor - Class in org.codenarc.rule.junit

JUnitTestMethodWithoutAssertRule - Class in org.codenarc.rule.junit

This rule searches for test methods that do not contain assert statements.

JUnitUnnecessarySetUpAstVisitor - Class in org.codenarc.rule.junit

JUnitUnnecessarySetUpRule - Class in org.codenarc.rule.junit

Rule that checks for a JUnit setUp() method that only contains a call to super.setUp().

JUnitUnnecessaryTearDownAstVisitor - Class in org.codenarc.rule.junit

JUnitUnnecessaryTearDownRule - Class in org.codenarc.rule.junit

Rule that checks for a JUnit tearDown() method that only contains a call to super.tearDown().

JUnitUnnecessaryThrowsExceptionAstVisitor - Class in org.codenarc.rule.junit

JUnitUnnecessaryThrowsExceptionRule - Class in org.codenarc.rule.junit

Check for throws clauses on JUnit test methods.

JUnitUtil - Class in org.codenarc.rule.junit

Utility methods for JUnit rule classes.

K

L

lastSourceLine(ASTNode) - Method in AbstractAstVisitor

Return the last raw source line corresponding to the specified AST node

lastSourceLineOrEmpty(ASTNode) - Method in AbstractSpaceAroundBraceAstVisitor

lastSourceLineTrimmed(ASTNode) - Method in AbstractAstVisitor

Return the trimmed last source line corresponding to the specified AST node

line(int) - Method in AbstractSourceCode

Get the trimmed line at the specified index

line(int) - Method in GMetricsSourceCodeAdapter

line(int) - Method in SourceCode

Get the trimmed line at the specified index

LineLengthRule - Class in org.codenarc.rule.formatting

Checks the maximum length for each line of source code.

ListRuleSet - Class in org.codenarc.ruleset

A RuleSet implementation that returns a static List of Rules passed into its constructor.

ListRuleSet(List) - Constructor in ListRuleSet

Construct a new instance from the specified List of rules.

loadRuleScriptFile(String) - Method in RuleSetUtil

loadRuleSetFile(String) - Method in RuleSetUtil

loadRuleSetFromString(String) - Method in RuleSetUtil

LocaleSetDefaultAstVisitor - Class in org.codenarc.rule.design

LocaleSetDefaultRule - Class in org.codenarc.rule.design

Checks for calls to Locale.setDefault(), which sets the Locale across the entire JVM.

LOG - Field in AbstractTestCase

LoggerForDifferentClassAstVisitor - Class in org.codenarc.rule.logging

LoggerForDifferentClassRule - Class in org.codenarc.rule.logging

Rule that checks for instantiating a logger for a class other than the current class.

LoggerWithWrongModifiersAstVisitor - Class in org.codenarc.rule.logging

LoggerWithWrongModifiersRule - Class in org.codenarc.rule.logging

Logger objects should be declared private, static and final.

LoggingSwallowsStacktraceAstVisitor - Class in org.codenarc.rule.logging

LoggingSwallowsStacktraceRule - Class in org.codenarc.rule.logging

If you are logging an exception then the proper API is to call error(Object, Throwable), which will log the message and the exception stack trace.

LOGO_FILE - Field in AbstractHtmlReportWriter

LogUtil - Class in org.codenarc.rule.logging

Utility methods for Logging rules

LongLiteralWithLowerCaseLAstVisitor - Class in org.codenarc.rule.convention

LongLiteralWithLowerCaseLRule - Class in org.codenarc.rule.convention

In Java and Groovy, you can specify long literals with the L or l character, for instance 55L or 24l.

LookupTable - Class in org.codenarc.plugin.disablerules

Manages a lookup table for disabled rules within a single source file

LookupTable(String) - Constructor in LookupTable

M

main(String) - Method in CodeNarc

Main command-line entry-point.

main(String) - Method in GenerateAll

Invoke all generation scripts

main(String) - Method in GenerateCodeNarcRulesProperties

Write out all current rules to the 'codenarc-base-rules.properties' properties file

main(String) - Method in GenerateRuleIndexPages

Write out rule index by rule category to the 'codenarc-rule-index.apt' APT file, and the rule index by name to the 'codenarc-rule-index-by-name.apt' APT file.

main(String) - Method in GenerateRuleSetAllRules

Write out all current rules to the 'codenarc-base-rules.properties' properties file

main(String) - Method in GenerateRuleSetAllRulesByCategory

Write out all current rules to the 'codenarc-base-rules.properties' properties file

manuallyApplyRule(String) - Method in AbstractRuleTestCase

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

matches(SourceCode) - Method in FilesystemSourceAnalyzer

matches(SourceCode) - Method in SourceCodeCriteria

Return true if all of the criteria specified in this object apply to thw SourceCode.

matches(String) - Method in WildcardPattern

Return true if the specified String matches the pattern or if the original patternString (specified in the constructor) was null or empty and the value for defaultMatches (also specified in the constructor) was true.

matchesAnyModifiers(Integer, List<Integer>) - Method in ModifiersUtil

matchesModifiers(Integer, Integer) - Method in ModifiersUtil

Return true only if the actualModifiers int value contains all of the bits (enabled) from the expectedModifiers

MathRandomTracker - Class in org.codenarc.rule.basic

MAX_SOURCE_LINE_LENGTH - Field in AbstractHtmlReportWriter

maxPriority1Violations - Field in CodeNarc

maxPriority2Violations - Field in CodeNarc

maxPriority3Violations - Field in CodeNarc

measureRuleProcessingTime(Rule, Closure) - Method in AbstractSourceAnalyzer

MESSAGE - Field in CollectAllIsDeprecatedRule

MESSAGE_DEF_FIELD - Field in NoDefRule

MESSAGE_DEF_PARAMETER - Field in NoDefRule

MESSAGE_DEF_RETURN - Field in NoDefRule

MESSAGE - Field in NoDefRule

MESSAGE - Field in UnnecessarySemicolonRule

MESSAGE - Field in UseCollectManyRule

MESSAGE - Field in UseCollectNestedRule

MethodCountAstVisitor - Class in org.codenarc.rule.size

MethodCountRule - Class in org.codenarc.rule.size

A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine-grained objects.

methodMissing(String, def) - Method in RuleSetDelegate

methodMissing(String, def) - Method in TopLevelDelegate

MethodNameAstVisitor - Class in org.codenarc.rule.naming

MethodNameRule - Class in org.codenarc.rule.naming

Rule that verifies that the name of each method matches a regular expression.

MethodParameterTypeRequired - Class in org.codenarc.rule.convention

Checks that method parameters are not dynamically typed, that is they are explicitly stated and different than def.

MethodParameterTypeRequiredAstVisitor - Class in org.codenarc.rule.convention

MethodReturnTypeRequiredAstVisitor - Class in org.codenarc.rule.convention

MethodReturnTypeRequiredRule - Class in org.codenarc.rule.convention

Checks that method return types are not dynamic, that they are explicitly stated and different than def.

MethodSizeAstVisitor - Class in org.codenarc.rule.size

MethodSizeRule - Class in org.codenarc.rule.size

Rule that checks the size of a method.

metric - Field in AbstractMethodMetricAstVisitor

MisorderedStaticImportsRule - Class in org.codenarc.rule.imports

Static imports should be before nonstatic imports

MissingBlankLineAfterImportsRule - Class in org.codenarc.rule.formatting

Makes sure there is a blank line after the imports of a source code file.

MissingBlankLineAfterPackageRule - Class in org.codenarc.rule.formatting

Makes sure there is a blank line after the package statement of a source code file.

MissingBlankLineBeforeAnnotatedFieldRule - Class in org.codenarc.rule.formatting

Checks that there is a blank line before a field declaration that uses annotations.

MissingBlankLineBeforeAnnotatedFieldRuleAstVisitor - Class in org.codenarc.rule.formatting

MissingNewInThrowStatementAstVisitor - Class in org.codenarc.rule.exceptions

MissingNewInThrowStatementRule - Class in org.codenarc.rule.exceptions

A common Groovy mistake when throwing exceptions is to forget the new keyword.

MissingOverrideAnnotationAstVisitor - Class in org.codenarc.rule.enhanced

MissingOverrideAnnotationRule - Class in org.codenarc.rule.enhanced

Checks for methods that override a method in a super class or implement a method in an interface but are not annotated with @Override.

ModifiersUtil - Class in org.codenarc.util

Provide static utility methods for parsing AST member modifiers, e.g. public/protected/private, static, final, etc.

MovedRules - Class in org.codenarc.ruleset

Helper class to manage information for moved or renamed rules, and provide helpful error message.

MultilineCommentChecker - Class in org.codenarc.util

A class that is used to hold the state of a the presence of multiline comments.

MultilineCommentChecker() - Constructor in MultilineCommentChecker

MultipleLoggersAstVisitor - Class in org.codenarc.rule.logging

MultipleLoggersRule - Class in org.codenarc.rule.logging

This rule catches classes that have more than one logger object defined.

MultipleUnaryOperatorsAstVisitor - Class in org.codenarc.rule.basic

MultipleUnaryOperatorsRule - Class in org.codenarc.rule.basic

Checks for multiple consecutive unary operators.

N

NestedBlockDepthAstVisitor - Class in org.codenarc.rule.size

NestedBlockDepthRule - Class in org.codenarc.rule.size

Rule that checks for blocks or closures nested more than a configured maximum number.

NestedForLoopAstVisitor - Class in org.codenarc.rule.design

NestedForLoopRule - Class in org.codenarc.rule.design

Reports classes with nested for loops.

NestedSynchronizationAstVisitor - Class in org.codenarc.rule.concurrency

NestedSynchronizationRule - Class in org.codenarc.rule.concurrency

Rule to detect nested synchronization blocks.

NEW_LINE - Field in CommentsUtil

NoDefAstVisitor - Class in org.codenarc.rule.convention

NoDefRule - Class in org.codenarc.rule.convention

Def keyword is overused and should be replaced with specific type.

nodeSourceLines(SourceCode, ASTNode) - Method in SourceCodeUtil

NoDoubleAstVisitor - Class in org.codenarc.rule.convention

NoDoubleRule - Class in org.codenarc.rule.convention

Checks for use of the double or Double types, in fields, variables, method parameters and method return types.

NoFloatAstVisitor - Class in org.codenarc.rule.convention

NoFloatRule - Class in org.codenarc.rule.convention

Checks for use of the float or Float types, in fields, variables, method parameters and method return types.

NoJavaUtilDateAstVisitor - Class in org.codenarc.rule.convention

NoJavaUtilDateRule - Class in org.codenarc.rule.convention

Do not use java.util.Date.

NON_STATIC_IMPORT_PATTERN - Field in AbstractImportRule

NON_WHITESPACE_CHARS - Field in CommentsUtil

NonFinalPublicFieldAstVisitor - Class in org.codenarc.rule.security

NonFinalPublicFieldRule - Class in org.codenarc.rule.security

Finds code that violates secure coding principles for mobile code by declaring a member variable public but not final.

NonFinalSubclassOfSensitiveInterfaceAstVisitor - Class in org.codenarc.rule.security

NonFinalSubclassOfSensitiveInterfaceRule - Class in org.codenarc.rule.security

The permissions classes such as java.security.Permission and java.security.BasicPermission are designed to be extended.

normalizePath(String) - Method in AbstractSourceCode

Return the normalized value of the specified path.

normalizePath(String) - Method in PathUtil

NoTabCharacterRule - Class in org.codenarc.rule.convention

Checks that all source files do not contain the tab character

NoWildcardImportsRule - Class in org.codenarc.rule.imports

Checks for wildcard (star) imports.

NullReturnTracker - Class in org.codenarc.rule

Helper AST visitor that adds rule violation if a return statement is encountered that returns a null constant.

numViolationsRemoved - Field in BaselineResultsPlugin

O

ObjectFinalizeAstVisitor - Class in org.codenarc.rule.security

ObjectFinalizeRule - Class in org.codenarc.rule.security

The finalize() method should only be called by the JVM after the object has been garbage collected.

ObjectOverrideMisspelledMethodNameAstVisitor - Class in org.codenarc.rule.naming

ObjectOverrideMisspelledMethodNameRule - Class in org.codenarc.rule.naming

Rule that checks that the names of the most commonly overridden methods: equals, hashCode and toString, are correct.

OPTIONAL_WHITESPACE - Field in CommentsUtil

OptionalCollectionReturnTypeAstVisitor - Class in org.codenarc.rule.design

OptionalCollectionReturnTypeRule - Class in org.codenarc.rule.design

Do not declare a method return type of Optional (or Collection, ArrayList, Set, Map, HashMap, etc.).

OptionalFieldAstVisitor - Class in org.codenarc.rule.design

OptionalFieldRule - Class in org.codenarc.rule.design

Do not use an Optional as a field type.

OptionalMethodParameterAstVisitor - Class in org.codenarc.rule.design

OptionalMethodParameterRule - Class in org.codenarc.rule.design

Do not use an Optional as a parameter type for method or constructor.

P

PackageNameAstVisitor - Class in org.codenarc.rule.naming

packageNameForImport(ImportNode) - Method in ImportUtil

Return the package name for the specified import statement or else an empty String

PackageNameMatchesFilePathRule - Class in org.codenarc.rule.naming

A package source file's path should match the package declaration.

PackageNameRule - Class in org.codenarc.rule.naming

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

ParameterAssignmentInFilterClosureAstVisitor - Class in org.codenarc.rule.basic

ParameterAssignmentInFilterClosureRule - Class in org.codenarc.rule.basic

An assignment operator was used on a parameter in a filtering closure.

ParameterCountAstVisitor - Class in org.codenarc.rule.size

ParameterCountRule - Class in org.codenarc.rule.size

Checks if the number of parameters in method/constructor exceeds the number of parameters specified by the maxParameters property.

ParameterNameAstVisitor - Class in org.codenarc.rule.naming

ParameterNameRule - Class in org.codenarc.rule.naming

Rule that verifies that the name of each parameter matches a regular expression.

ParameterReassignmentAstVisitor - Class in org.codenarc.rule.convention

ParameterReassignmentRule - Class in org.codenarc.rule.convention

Checks for a method or closure parameter being reassigned to a new value within the body of the method/closure, which is a confusing, questionable practice.

parse(String) - Method in InlineViolationsParser

parseArgs(String) - Method in CodeNarc

parseBaselineXmlReport(String) - Method in BaselineXmlReportParser

parseModifiers(String) - Method in ModifiersUtil

Parse a group of whitespace-delimited modifier names

parseModifiersList(String) - Method in ModifiersUtil

Parse comma-separated list of modifier groups

parseRuleNames(String, String) - Method in LookupTable

PathUtil - Class in org.codenarc.util

Path-related utility methods.

plugins - Field in CodeNarc

plugins - Field in CodeNarcRunner

PLUGINS_PROPERTY - Field in CodeNarcRunner

PrintlnAstVisitor - Class in org.codenarc.rule.logging

PrintlnRule - Class in org.codenarc.rule.logging

Rule that checks for calls to this.print(), this.println() or this.printf().

printRuleProcessingTimes() - Method in AbstractSourceAnalyzer

PrintStackTraceAstVisitor - Class in org.codenarc.rule.logging

PrintStackTraceRule - Class in org.codenarc.rule.logging

Rule that checks for calls to printStackTrace().

PrivateFieldCouldBeFinalAstVisitor - Class in org.codenarc.rule.design

PrivateFieldCouldBeFinalRule - Class in org.codenarc.rule.design

Rule that checks for private fields that are only set within a constructor or field initializer.

processLine(String) - Method in MultilineCommentChecker

Processes a line of code sets the inMultilineComment state based on the status of the current line.

processReports(List<ReportWriter>) - Method in AbstractCodeNarcPlugin

processReports(List<ReportWriter>) - Method in BaselineResultsPlugin

processReports(List<ReportWriter>) - Method in CodeNarcPlugin

Process the list of ReportWriter.

processRules(List<Rule>) - Method in AbstractCodeNarcPlugin

processRules(List<Rule>) - Method in CodeNarcPlugin

Process the list of Rules.

processViolationsForFile(FileViolations) - Method in AbstractCodeNarcPlugin

processViolationsForFile(FileViolations) - Method in BaselineResultsPlugin

processViolationsForFile(FileViolations) - Method in CodeNarcPlugin

Process the violations for a single file.

processViolationsForFile(FileViolations) - Method in DisableRulesInCommentsPlugin

Remove any violations for rules disabled by comments within the source code.

PROPERTIES_FILE - Field in GenerateCodeNarcRulesProperties

PROPERTIES_FILE - Field in PropertiesFileRuleRegistry

propertiesFile - Field in GenerateCodeNarcRulesProperties

propertiesFilename - Field in CodeNarc

PropertiesFileRuleRegistry - Class in org.codenarc.ruleregistry

Implementation of RuleRegistry that loads the rules from the 'codenarc-base-rules.properties' properties file.

PropertiesFileRuleRegistry() - Constructor in PropertiesFileRuleRegistry

PropertiesFileRuleSetConfigurer - Class in org.codenarc.ruleset

Reads the properties file named "codenarc.properties", if found on the classpath, and applies the property values to matching Rules within a specified RuleSet.

propertyMissing(String) - Method in TopLevelDelegate

PropertyNameAstVisitor - Class in org.codenarc.rule.naming

PropertyNameRule - Class in org.codenarc.rule.naming

Rule that verifies that the name of each property matches a regular expression.

PropertyUtil - Class in org.codenarc.util

Contains property-related static utility methods

PublicFinalizeMethodAstVisitor - Class in org.codenarc.rule.security

PublicFinalizeMethodRule - Class in org.codenarc.rule.security

Creates a violation when the program violates secure coding principles by declaring a finalize() method public.

PublicInstanceFieldAstVisitor - Class in org.codenarc.rule.design

PublicInstanceFieldRule - Class in org.codenarc.rule.design

Using public fields is considered to be a bad design.

PublicMethodsBeforeNonPublicMethodsAstVisitor - Class in org.codenarc.rule.convention

PublicMethodsBeforeNonPublicMethodsRule - Class in org.codenarc.rule.convention

Enforce that all public methods are above protected and private methods.

Q

R

RandomDoubleCoercedToZeroAstVisitor - Class in org.codenarc.rule.basic

RandomDoubleCoercedToZeroRule - Class in org.codenarc.rule.basic

The Math.random() method returns a double result greater than or equal to 0.0 and less than 1.0.

RECORD_METHOD_NAME - Field in ValueRecorder

record(Object, int) - Method in ValueRecorder

ReferenceCollector - Class in org.codenarc.rule.unused

Class visitor that collects the names of all method call and variable references

registerPlugin(CodeNarcPlugin) - Method in CodeNarcRunner

registerPluginsForClassNames(String) - Method in CodeNarcRunner

RELUCTANT - Field in CommentsUtil

RemoveAllOnSelfAstVisitor - Class in org.codenarc.rule.basic

RemoveAllOnSelfRule - Class in org.codenarc.rule.basic

This rule catches calling the method removeAll with yourself as a parameter.

removeIllegalCharacters(String) - Method in XmlReportUtil

removeInlineViolations(String) - Method in AbstractRuleTestCase

Removes all inline violations from a source.

removePathPrefix(String, String) - Method in PathUtil

removeViolation(Violation) - Method in DirectoryResults

removeViolation(Violation) - Method in FileResults

removeViolation(Violation) - Method in Results

Remove the specified violation

removeViolation(Violation) - Method in VirtualResults

Report - Class in org.codenarc.ant

JavaBean class holding the properties for a element with the CodeNarc Ant Task.

ReportOption - Class in org.codenarc.ant

JavaBean class holding the properties for a element nested within a element for the CodeNarc Ant Task.

reports - Field in CodeNarc

ReportWriter - Interface in org.codenarc.report

Represents the interface of an object that can write out a report

ReportWriterFactory - Class in org.codenarc.report

Factory for ReportWriter objects based on the report type (name).

reportWriters - Field in CodeNarcTask

RequiredRegexRule - Class in org.codenarc.rule.generic

Checks for a specified regular expression that must exist within the source code.

RequiredStringRule - Class in org.codenarc.rule.generic

Checks for a specified String that must exist within the source code.

Resource - Interface in org.codenarc.util.io

Defines the interface for objects that represent a resource (e.g. a file) and provide access to its InputStream.

resourceBundle - Field in AbstractReportWriter

ResourceFactory - Interface in org.codenarc.util.io

Defines the interface for factory objects that create/return Resource instances.

respondsTo(Object, String) - Method in AstUtil

Return true only if the specified object responds to the named method

Results - Interface in org.codenarc.results

Represents the results of applying rules to one or more source files/directories

ReturnFromFinallyBlockAstVisitor - Class in org.codenarc.rule.basic

ReturnFromFinallyBlockRule - Class in org.codenarc.rule.basic

Rule that checks for a return from within a finally block

ReturnNullFromCatchBlockAstVisitor - Class in org.codenarc.rule.exceptions

ReturnNullFromCatchBlockRule - Class in org.codenarc.rule.exceptions

Returning null from a catch block often masks errors and requires the client to handle error codes.

ReturnsNullInsteadOfEmptyArrayAstVisitor - Class in org.codenarc.rule.design

ReturnsNullInsteadOfEmptyArrayRule - Class in org.codenarc.rule.design

This rule detects when null is returned from a method that might return an array.

ReturnsNullInsteadOfEmptyCollectionRule - Class in org.codenarc.rule.design

This rule detects when null is returned from a method or Closure that might return a collection.

ReturnsNullInsteadOfEmptyCollectionRuleAstVisitor - Class in org.codenarc.rule.design

Rule - Interface in org.codenarc.rule

Represents a source code analysis rule .

rule - Field in AbstractRuleTestCase

RULE_INDEX_BY_CATEGORY_FILE - Field in GenerateRuleIndexPages

RULE_INDEX_BY_NAME_FILE - Field in GenerateRuleIndexPages

rule(String, Closure) - Method in TopLevelDelegate

ruleIndexByCategoryFile - Field in GenerateRuleIndexPages

ruleIndexByNameFile - Field in GenerateRuleIndexPages

ruleProcessingTimes - Field in AbstractSourceAnalyzer

RuleRegistry - Interface in org.codenarc.ruleregistry

Represents a registry of rule classes, accessible by rule name

RuleRegistryHolder - Class in org.codenarc.ruleregistry

Holds a reference to the RuleRegistry static singleton

RuleRegistryInitializer - Class in org.codenarc.ruleregistry

Performs initialization (loading) of the RuleRegistry singleton held by RuleRegistryHolder

RuleSet - Interface in org.codenarc.ruleset

Represents a set of (configured) Rule objects that can be applied for static analysis.

ruleset - Field in CodeNarc

ruleSet - Field in CodeNarcTask

RULESET_FILE - Field in GenerateRuleSetAllRules

RULESET_FILE - Field in GenerateRuleSetAllRulesByCategory

ruleset(Closure) - Method in RuleSetBuilder

ruleset(String, Closure) - Method in TopLevelDelegate

RuleSetBuilder - Class in org.codenarc.ruleset

A Builder for RuleSets.

RuleSetConfigurer - Interface in org.codenarc.ruleset

Represents a configurer for a ruleset

ruleSetConfigurer - Field in CodeNarcRunner

RuleSetDelegate - Class in org.codenarc.ruleset

RuleSetDelegate(RuleSet) - Constructor in RuleSetDelegate

ruleSetFile - Field in GenerateRuleSetAllRules

ruleSetFile - Field in GenerateRuleSetAllRulesByCategory

ruleSetFiles - Field in CodeNarc

RuleSets - Class in org.codenarc.ruleset

Holds list of all RuleSet files.

RuleSetUtil - Class in org.codenarc.ruleset

A private utility class for the RuleSet classes.