D

DeadCodeAstVisitor - Class in groovy.org.codenarc.rule.basic

DeadCodeRule - Class in groovy.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_OUTPUT_FILE - Field in HtmlReportWriter

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 groovy.org.codenarc.util.io

Default implementation of ResourceFactory.

description(String) - Method in TopLevelDelegate

DirectConnectionManagementAstVisitor - Class in groovy.org.codenarc.rule.jdbc

DirectConnectionManagementRule - Class in groovy.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 groovy.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

DirectorySourceAnalyzer - Class in groovy.org.codenarc.analyzer

SourceAnalyzer implementation that recursively processes files in the configured source directories.

DOMAIN_FILES - Field in GrailsUtil

DoubleCheckedLockingAstVisitor - Class in groovy.org.codenarc.rule.concurrency

DoubleCheckedLockingRule - Class in groovy.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 groovy.org.codenarc.rule.basic

DoubleNegativeRule - Class in groovy.org.codenarc.rule.basic

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

DryUtil - Class in groovy.org.codenarc.rule.dry

Utility methods for the DRY rule classes

DuplicateCaseStatementAstVisitor - Class in groovy.org.codenarc.rule.basic

DuplicateCaseStatementRule - Class in groovy.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 groovy.org.codenarc.rule.imports

Rule that checks for a duplicate import

DuplicateListLiteralAstVisitor - Class in groovy.org.codenarc.rule.dry

DuplicateListLiteralRule - Class in groovy.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 groovy.org.codenarc.rule.dry

Abstract superclass for rule AstVisitor classes that detect duplicate literal constants

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

DuplicateMapKeyAstVisitor - Class in groovy.org.codenarc.rule.basic

DuplicateMapKeyRule - Class in groovy.org.codenarc.rule.basic

A map literal is created with duplicated key.

DuplicateMapLiteralAstVisitor - Class in groovy.org.codenarc.rule.dry

DuplicateMapLiteralRule - Class in groovy.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 groovy.org.codenarc.rule.dry

Checks for duplication of constant number literal values.

DuplicateSetValueAstVisitor - Class in groovy.org.codenarc.rule.basic

DuplicateSetValueRule - Class in groovy.org.codenarc.rule.basic

A Set literal is created with duplicate constant value.

DuplicateStringLiteralRule - Class in groovy.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 groovy.org.codenarc.rule.braces

ElseBlockBracesRule - Class in groovy.org.codenarc.rule.braces

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

EmptyCatchBlockAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyCatchBlockRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty catch blocks

EmptyClassRule - Class in groovy.org.codenarc.rule.basic

Reports classes without methods, fields or properties.

EmptyElseBlockAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyElseBlockRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty else blocks

EmptyFinallyBlockAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyFinallyBlockRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty finally blocks

EmptyForStatementAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyForStatementRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty for statements

EmptyIfStatementAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyIfStatementRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty if statements

EmptyInstanceInitializerAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyInstanceInitializerRule - Class in groovy.org.codenarc.rule.basic

The class has an empty instance initializer.

EmptyMethodAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyMethodInAbstractClassAstVisitor - Class in groovy.org.codenarc.rule.design

EmptyMethodInAbstractClassRule - Class in groovy.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 groovy.org.codenarc.rule.basic

A method was found without an implementation.

EmptyStaticInitializerAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyStaticInitializerRule - Class in groovy.org.codenarc.rule.basic

An empty static initializer was found.

EmptySwitchStatementAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptySwitchStatementRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty switch statements

EmptySynchronizedStatementAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptySynchronizedStatementRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty synchronized statement

EmptyTryBlockAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyTryBlockRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty try blocks

EmptyWhileStatementAstVisitor - Class in groovy.org.codenarc.rule.basic

EmptyWhileStatementRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for empty while statements

EnumCustomSerializationIgnoredAstVisitor - Class in groovy.org.codenarc.rule.serialization

EnumCustomSerializationIgnoredRule - Class in groovy.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 groovy.org.codenarc.rule.basic

EqualsAndHashCodeRule - Class in groovy.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 groovy.org.codenarc.rule.basic

EqualsOverloadedRule - Class in groovy.org.codenarc.rule.basic

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

ExceptionExtendsErrorAstVisitor - Class in groovy.org.codenarc.rule.exceptions

ExceptionExtendsErrorRule - Class in groovy.org.codenarc.rule.exceptions

Errors are system exceptions.

ExceptionExtendsThrowableAstVisitor - Class in groovy.org.codenarc.rule.exceptions

ExceptionExtendsThrowableRule - Class in groovy.org.codenarc.rule.exceptions

Checks for classes that extend Throwable.

ExceptionNotThrownAstVisitor - Class in groovy.org.codenarc.rule.exceptions

ExceptionNotThrownRule - Class in groovy.org.codenarc.rule.exceptions

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

exclude(String) - Method in RuleSetDelegate

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 groovy.org.codenarc.rule.groovyism

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

ExplicitCallToAndMethodAstVisitor - Class in groovy.org.codenarc.rule.groovyism

ExplicitCallToAndMethodAstVisitor() - Constructor in ExplicitCallToAndMethodAstVisitor

ExplicitCallToAndMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToCompareToMethodAstVisitor() - Constructor in ExplicitCallToCompareToMethodAstVisitor

ExplicitCallToCompareToMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToDivMethodAstVisitor() - Constructor in ExplicitCallToDivMethodAstVisitor

ExplicitCallToDivMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToEqualsMethodAstVisitor() - Constructor in ExplicitCallToEqualsMethodAstVisitor

ExplicitCallToEqualsMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToGetAtMethodAstVisitor() - Constructor in ExplicitCallToGetAtMethodAstVisitor

ExplicitCallToGetAtMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToLeftShiftMethodAstVisitor() - Constructor in ExplicitCallToLeftShiftMethodAstVisitor

ExplicitCallToLeftShiftMethodRule - Class in groovy.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 groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToMinusMethodAstVisitor() - Constructor in ExplicitCallToMinusMethodAstVisitor

ExplicitCallToMinusMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToModMethodAstVisitor() - Constructor in ExplicitCallToModMethodAstVisitor

ExplicitCallToModMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToMultiplyMethodAstVisitor() - Constructor in ExplicitCallToMultiplyMethodAstVisitor

ExplicitCallToMultiplyMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToOrMethodAstVisitor() - Constructor in ExplicitCallToOrMethodAstVisitor

ExplicitCallToOrMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToPlusMethodAstVisitor() - Constructor in ExplicitCallToPlusMethodAstVisitor

ExplicitCallToPlusMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToPowerMethodAstVisitor() - Constructor in ExplicitCallToPowerMethodAstVisitor

ExplicitCallToPowerMethodRule - Class in groovy.org.codenarc.rule.groovyism

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

ExplicitCallToRightShiftMethodAstVisitor - Class in groovy.org.codenarc.rule.groovyism

ExplicitCallToRightShiftMethodAstVisitor() - Constructor in ExplicitCallToRightShiftMethodAstVisitor

ExplicitCallToRightShiftMethodRule - Class in groovy.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 groovy.org.codenarc.rule.groovyism

ExplicitCallToXorMethodAstVisitor() - Constructor in ExplicitCallToXorMethodAstVisitor

ExplicitCallToXorMethodRule - Class in groovy.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 groovy.org.codenarc.rule.basic

ExplicitGarbageCollectionRule - Class in groovy.org.codenarc.rule.basic

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

ExplicitHashMapInstantiationRule - Class in groovy.org.codenarc.rule.groovyism

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

ExplicitHashSetInstantiationRule - Class in groovy.org.codenarc.rule.groovyism

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

ExplicitLinkedHashMapInstantiationRule - Class in groovy.org.codenarc.rule.groovyism

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

ExplicitLinkedListInstantiationRule - Class in groovy.org.codenarc.rule.groovyism

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

ExplicitStackInstantiationRule - Class in groovy.org.codenarc.rule.groovyism

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

ExplicitTreeSetInstantiationRule - Class in groovy.org.codenarc.rule.groovyism

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

ExplicitTypeInstantiationAstVisitor - Class in groovy.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 groovy.org.codenarc.rule.naming

FactoryMethodNameRule - Class in groovy.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 groovy.org.codenarc.rule.naming

FieldNameRule - Class in groovy.org.codenarc.rule.naming

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

FieldReferenceAstVisitor - Class in groovy.org.codenarc.rule

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

FieldReferenceAstVisitor(Collection<FieldNode>) - Constructor in FieldReferenceAstVisitor

FileCreateTempFileAstVisitor - Class in groovy.org.codenarc.rule.security

FileCreateTempFileRule - Class in groovy.org.codenarc.rule.security

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

FileEndsWithoutNewlineRule - Class in groovy.org.codenarc.rule.formatting

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

FileResults - Class in groovy.org.codenarc.results

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

FileResults(String, List) - Constructor in FileResults

fileSets - Field in AntFileSetSourceAnalyzer

fileSets - Field in CodeNarcTask

FilesystemSourceAnalyzer - Class in groovy.org.codenarc.analyzer

SourceAnalyzer implementation that recursively processes files from the file system.

FilteredRuleSet - Class in groovy.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 groovy.org.codenarc.rule.design

FinalClassWithProtectedMemberRule - Class in groovy.org.codenarc.rule.design

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

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

ForLoopShouldBeWhileLoopAstVisitor - Class in groovy.org.codenarc.rule.basic

ForLoopShouldBeWhileLoopRule - Class in groovy.org.codenarc.rule.basic

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

formatSourceLine(String, int) - Method in HtmlReportWriter

Format and trim the source line.

ForStatementBracesAstVisitor - Class in groovy.org.codenarc.rule.braces

ForStatementBracesRule - Class in groovy.org.codenarc.rule.braces

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

G

GenerateAll - Class in groovy.org.codenarc.tool

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

GenerateCodeNarcRulesProperties - Class in groovy.org.codenarc.tool

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

GenerateRuleIndexPage - Class in groovy.org.codenarc.tool

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

GenerateRuleSetAllRules - Class in groovy.org.codenarc.tool

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

GenerateRuleSetAllRulesByCategory - Class in groovy.org.codenarc.tool

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

GenerateUtil - Class in groovy.org.codenarc.tool

Contains static utility methods related to the Generate* tools.

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 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)

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

getHtmlDescriptionForRule(Rule) - Method in AbstractReportWriter

getImportsSortedByLineNumber(def) - Method in ImportUtil

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

getLineNumber(def) - 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)

getLoggingEvents() - Method in InMemoryAppender

Return the List of LoggingEvents logged to this Appender

getMaxClassAverageMethodMetricValue() - Method in AbcComplexityAstVisitor

getMaxClassAverageMethodMetricValue() - Method in AbcMetricAstVisitor

getMaxClassAverageMethodMetricValue() - Method in AbstractMethodMetricAstVisitor

getMaxClassAverageMethodMetricValue() - Method in CrapMetricAstVisitor

getMaxClassAverageMethodMetricValue() - Method in CyclomaticComplexityAstVisitor

getMaxClassMetricValue() - Method in AbcComplexityAstVisitor

getMaxClassMetricValue() - Method in AbcMetricAstVisitor

getMaxClassMetricValue() - Method in AbstractMethodMetricAstVisitor

getMaxClassMetricValue() - Method in CrapMetricAstVisitor

getMaxClassMetricValue() - Method in CyclomaticComplexityAstVisitor

getMaxMethodMetricValue() - Method in AbcComplexityAstVisitor

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(def) - 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

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

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 exlcude(s) specified.

getRules() - Method in GroovyDslRuleSet

@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

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(def) - Method in AbstractMethodMetricAstVisitor

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.

GetterMethodCouldBePropertyAstVisitor - Class in groovy.org.codenarc.rule.groovyism

GetterMethodCouldBePropertyRule - Class in groovy.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.

getVersion() - Method in GroovyVersion

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 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(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 groovy.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 groovy.org.codenarc.rule.grails

GrailsDomainHasEqualsAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsDomainHasEqualsRule - Class in groovy.org.codenarc.rule.grails

Checks that Grails domain classes redefine equals().

GrailsDomainHasToStringAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsDomainHasToStringRule - Class in groovy.org.codenarc.rule.grails

Checks that Grails domain classes redefine toString()

GrailsDomainReservedSqlKeywordNameAstVisitor - Class in groovy.org.codenarc.rule.grails

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

GrailsDomainReservedSqlKeywordNameRule - Class in groovy.org.codenarc.rule.grails

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

GrailsDomainWithServiceReferenceRule - Class in groovy.org.codenarc.rule.grails

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

GrailsDuplicateConstraintAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsDuplicateConstraintRule - Class in groovy.org.codenarc.rule.grails

Check for duplicate constraints entry

GrailsDuplicateMappingAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsDuplicateMappingRule - Class in groovy.org.codenarc.rule.grails

Check for duplicate entry in a domain class mapping

GrailsMassAssignmentAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsMassAssignmentRule - Class in groovy.org.codenarc.rule.grails

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

GrailsPublicControllerMethodAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsPublicControllerMethodRule - Class in groovy.org.codenarc.rule.grails

Rule that checks for public methods on Grails controller classes.

GrailsPublicControllerMethodRule() - Constructor in GrailsPublicControllerMethodRule

GrailsServletContextReferenceAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsServletContextReferenceRule - Class in groovy.org.codenarc.rule.grails

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

GrailsSessionReferenceAstVisitor - Class in groovy.org.codenarc.rule.grails

GrailsSessionReferenceRule - Class in groovy.org.codenarc.rule.grails

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

GrailsSessionReferenceRule() - Constructor in GrailsSessionReferenceRule

GrailsStatelessServiceRule - Class in groovy.org.codenarc.rule.grails

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

GrailsStatelessServiceRule() - Constructor in GrailsStatelessServiceRule

GrailsUtil - Class in groovy.org.codenarc.rule.grails

Utility methods and constants for Grails rule classes.

GroovyDslRuleSet - Class in groovy.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 groovy.org.codenarc.rule.groovyism

GroovyLangImmutableRule - Class in groovy.org.codenarc.rule.groovyism

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

GroovyVersion - Class in groovy.org.codenarc.util

Utility methods to determine the version of Groovy currently executing.

GStringAsMapKeyAstVisitor - Class in groovy.org.codenarc.rule.groovyism

GStringAsMapKeyRule - Class in groovy.org.codenarc.rule.groovyism

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

GStringExpressionWithinStringAstVisitor - Class in groovy.org.codenarc.rule.groovyism

GStringExpressionWithinStringRule - Class in groovy.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 groovy.org.codenarc.rule.basic

HardCodedWindowsFileSeparatorRule - Class in groovy.org.codenarc.rule.basic

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

HardcodedWindowsRootDirectoryAstVisitor - Class in groovy.org.codenarc.rule.basic

HardCodedWindowsRootDirectoryRule - Class in groovy.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 groovy.org.codenarc.rule.convention

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

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 groovy.org.codenarc.report

ReportWriter that generates an HTML report.

I

IdeTextReportWriter - Class in groovy.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 groovy.org.codenarc.rule.braces

IfStatementBracesRule - Class in groovy.org.codenarc.rule.braces

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

IfStatementCouldBeTernaryAstVisitor - Class in groovy.org.codenarc.rule.convention

IfStatementCouldBeTernaryRule - Class in groovy.org.codenarc.rule.convention

Checks for:

IllegalClassMemberAstVisitor - Class in groovy.org.codenarc.rule.generic

IllegalClassMemberRule - Class in groovy.org.codenarc.rule.generic

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

IllegalClassReferenceRule - Class in groovy.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 groovy.org.codenarc.rule.generic

IllegalPackageReferenceRule - Class in groovy.org.codenarc.rule.generic

Checks for reference to any of the named packages.

illegalPropertyModifiersList - Field in IllegalClassMemberRule

illegalPropertyModifiersString - Field in IllegalClassMemberRule

IllegalRegexRule - Class in groovy.org.codenarc.rule.generic

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

IllegalStringRule - Class in groovy.org.codenarc.rule.generic

Checks for a specified illegal string within the source code.

IllegalSubclassAstVisitor - Class in groovy.org.codenarc.rule.generic

IllegalSubclassRule - Class in groovy.org.codenarc.rule.generic

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

ImplementationAsTypeAstVisitor - Class in groovy.org.codenarc.rule.design

ImplementationAsTypeRule - Class in groovy.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

ImportFromSamePackageRule - Class in groovy.org.codenarc.rule.imports

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

ImportFromSunPackagesRule - Class in groovy.org.codenarc.rule.imports

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

ImportUtil - Class in groovy.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 groovy.org.codenarc.rule.concurrency

InconsistentPropertyLockingRule - Class in groovy.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 groovy.org.codenarc.rule.concurrency

InconsistentPropertySynchronizationRule - Class in groovy.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.

indexOfClosingBrace(String, int) - Method in AbstractSpaceAroundBraceAstVisitor

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 groovy.org.codenarc.rule

Parser for inline violation metadata within Rule test classes

InlineViolationsParser.ParseResult - Class in groovy.org.codenarc.rule

InlineXmlReportWriter - Class in groovy.org.codenarc.report

ReportWriter that generates an XML report with inline rule descriptions.

InMemoryAppender - Class in groovy.org.codenarc.test

Log4J Appender that saves all logged loggingEvents in a List.

InsecureRandomAstVisitor - Class in groovy.org.codenarc.rule.security

InsecureRandomRule - Class in groovy.org.codenarc.rule.security

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

InstanceofAstVisitor - Class in groovy.org.codenarc.rule.design

InstanceofRule - Class in groovy.org.codenarc.rule.design

Checks for use of the instanceof operator.

IntegerGetIntegerAstVisitor - Class in groovy.org.codenarc.rule.basic

IntegerGetIntegerRule - Class in groovy.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 groovy.org.codenarc.rule.naming

InterfaceNameRule - Class in groovy.org.codenarc.rule.naming

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

InvertedIfElseAstVisitor - Class in groovy.org.codenarc.rule.convention

InvertedIfElseRule - Class in groovy.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.

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 HtmlReportWriter

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

isDirectoryContainingFilesWithViolations(Results) - Method in HtmlReportWriter

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

isFalse(Expression) - Method in AstUtil

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

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.

isGroovy1_6() - Method in GroovyVersion

isGroovy1_7() - Method in GroovyVersion

isGroovy1_8() - Method in GroovyVersion

isGroovy1_8_OrGreater() - Method in GroovyVersion

isGroovy2_x() - 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(def) - 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

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(def) - 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

isVariable(ASTNode, String) - Method in AstUtil

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

isViolationSuppressed(Violation) - Method in SuppressionAnalyzer

J

JavaIoPackageAccessAstVisitor - Class in groovy.org.codenarc.rule.security

JavaIoPackageAccessRule - Class in groovy.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 groovy.org.codenarc.rule.jdbc

Check for direct use of java.sql.Connection.

JdbcResultSetReferenceRule - Class in groovy.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 groovy.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.

JUnitAssertAlwaysFailsAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitAssertAlwaysFailsRule - Class in groovy.org.codenarc.rule.junit

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

JUnitAssertAlwaysSucceedsAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitAssertAlwaysSucceedsRule - Class in groovy.org.codenarc.rule.junit

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

JUnitAssertEqualsConstantActualValueAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitAssertEqualsConstantActualValueRule - Class in groovy.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 groovy.org.codenarc.rule.junit

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

JUnitFailWithoutMessageRuleAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitLostTestAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitLostTestRule - Class in groovy.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 annotated with

Test.:

JUnitPublicFieldAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitPublicFieldRule - Class in groovy.org.codenarc.rule.junit

Checks for public field on a JUnit test class.

JUnitPublicNonTestMethodAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitPublicNonTestMethodRule - Class in groovy.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 groovy.org.codenarc.rule.junit

JUnitPublicPropertyRule - Class in groovy.org.codenarc.rule.junit

Checks for public properties defined on JUnit test classes.

JUnitSetUpCallsSuperAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitSetUpCallsSuperRule - Class in groovy.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 groovy.org.codenarc.rule.junit

JUnitStyleAssertionsRule - Class in groovy.org.codenarc.rule.junit

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

JUnitTearDownCallsSuperAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitTearDownCallsSuperRule - Class in groovy.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 groovy.org.codenarc.rule.junit

JUnitTestMethodWithoutAssertRule - Class in groovy.org.codenarc.rule.junit

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

JUnitUnnecessarySetUpAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitUnnecessarySetUpRule - Class in groovy.org.codenarc.rule.junit

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

JUnitUnnecessaryTearDownAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitUnnecessaryTearDownRule - Class in groovy.org.codenarc.rule.junit

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

JUnitUnnecessaryThrowsExceptionAstVisitor - Class in groovy.org.codenarc.rule.junit

JUnitUnnecessaryThrowsExceptionRule - Class in groovy.org.codenarc.rule.junit

Check for throws clauses on JUnit test methods.

JUnitUtil - Class in groovy.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(def) - 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 groovy.org.codenarc.rule.formatting

Checks the maximum length for each line of source code.

ListRuleSet - Class in groovy.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

LocaleSetDefaultAstVisitor - Class in groovy.org.codenarc.rule.design

LocaleSetDefaultRule - Class in groovy.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 groovy.org.codenarc.rule.logging

LoggerForDifferentClassRule - Class in groovy.org.codenarc.rule.logging

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

LoggerWithWrongModifiersAstVisitor - Class in groovy.org.codenarc.rule.logging

LoggerWithWrongModifiersRule - Class in groovy.org.codenarc.rule.logging

Logger objects should be declared private, static and final.

LoggingSwallowsStacktraceAstVisitor - Class in groovy.org.codenarc.rule.logging

LoggingSwallowsStacktraceRule - Class in groovy.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.

LogUtil - Class in groovy.org.codenarc.rule.logging

Utility methods for Logging rules

LongLiteralWithLowerCaseLAstVisitor - Class in groovy.org.codenarc.rule.convention

LongLiteralWithLowerCaseLRule - Class in groovy.org.codenarc.rule.convention

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

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 GenerateRuleIndexPage

Write out all current rule index to the 'codenarc-rule-index.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 groovy.org.codenarc.rule.basic

MESSAGE - Field in CollectAllIsDeprecatedRule

MESSAGE - Field in NoDefRule

MESSAGE - Field in UseCollectManyRule

MESSAGE - Field in UseCollectNestedRule

MethodCountAstVisitor - Class in groovy.org.codenarc.rule.size

MethodCountRule - Class in groovy.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 groovy.org.codenarc.rule.naming

MethodNameRule - Class in groovy.org.codenarc.rule.naming

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

MethodSizeAstVisitor - Class in groovy.org.codenarc.rule.size

MethodSizeRule - Class in groovy.org.codenarc.rule.size

Rule that checks the size of a method.

metric - Field in AbstractMethodMetricAstVisitor

MisorderedStaticImportsRule - Class in groovy.org.codenarc.rule.imports

Static imports should be before nonstatic imports

MissingBlankLineAfterImportsRule - Class in groovy.org.codenarc.rule.formatting

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

MissingBlankLineAfterPackageRule - Class in groovy.org.codenarc.rule.formatting

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

MissingNewInThrowStatementAstVisitor - Class in groovy.org.codenarc.rule.exceptions

MissingNewInThrowStatementRule - Class in groovy.org.codenarc.rule.exceptions

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

ModifiersUtil - Class in groovy.org.codenarc.util

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

MovedRules - Class in groovy.org.codenarc.ruleset

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

MultipleLoggersAstVisitor - Class in groovy.org.codenarc.rule.logging

MultipleLoggersRule - Class in groovy.org.codenarc.rule.logging

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

MultipleUnaryOperatorsAstVisitor - Class in groovy.org.codenarc.rule.basic

MultipleUnaryOperatorsRule - Class in groovy.org.codenarc.rule.basic

Checks for multiple consecutive unary operators.

N

NestedBlockDepthAstVisitor - Class in groovy.org.codenarc.rule.size

NestedBlockDepthRule - Class in groovy.org.codenarc.rule.size

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

NestedForLoopAstVisitor - Class in groovy.org.codenarc.rule.design

NestedForLoopRule - Class in groovy.org.codenarc.rule.design

Reports classes with nested for loops.

NestedSynchronizationAstVisitor - Class in groovy.org.codenarc.rule.concurrency

NestedSynchronizationRule - Class in groovy.org.codenarc.rule.concurrency

Rule to detect nested synchronization blocks.

NoDefRule - Class in groovy.org.codenarc.rule.convention

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

nodeSourceLines(SourceCode, ASTNode) - Method in SourceCodeUtil

NON_STATIC_IMPORT_PATTERN - Field in AbstractImportRule

NonFinalPublicFieldAstVisitor - Class in groovy.org.codenarc.rule.security

NonFinalPublicFieldRule - Class in groovy.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 groovy.org.codenarc.rule.security

NonFinalSubclassOfSensitiveInterfaceRule - Class in groovy.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

NoWildcardImportsRule - Class in groovy.org.codenarc.rule.imports

Wildcard imports, static or otherwise, are not used.

NullReturnTracker - Class in groovy.org.codenarc.rule

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

O

ObjectFinalizeAstVisitor - Class in groovy.org.codenarc.rule.security

ObjectFinalizeRule - Class in groovy.org.codenarc.rule.security

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

ObjectOverrideMisspelledMethodNameAstVisitor - Class in groovy.org.codenarc.rule.naming

ObjectOverrideMisspelledMethodNameRule - Class in groovy.org.codenarc.rule.naming

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

P

PackageNameAstVisitor - Class in groovy.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 groovy.org.codenarc.rule.naming

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

PackageNameRule - Class in groovy.org.codenarc.rule.naming

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

ParameterCountAstVisitor - Class in groovy.org.codenarc.rule.size

ParameterCountRule - Class in groovy.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 groovy.org.codenarc.rule.naming

ParameterNameRule - Class in groovy.org.codenarc.rule.naming

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

ParameterReassignmentAstVisitor - Class in groovy.org.codenarc.rule.convention

ParameterReassignmentRule - Class in groovy.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

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

PathUtil - Class in groovy.org.codenarc.util

Path-related utility methods.

PrintlnAstVisitor - Class in groovy.org.codenarc.rule.logging

PrintlnRule - Class in groovy.org.codenarc.rule.logging

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

PrintStackTraceAstVisitor - Class in groovy.org.codenarc.rule.logging

PrintStackTraceRule - Class in groovy.org.codenarc.rule.logging

Rule that checks for calls to printStackTrace().

PrivateFieldCouldBeFinalAstVisitor - Class in groovy.org.codenarc.rule.design

PrivateFieldCouldBeFinalRule - Class in groovy.org.codenarc.rule.design

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

PROPERTIES_FILE - Field in GenerateCodeNarcRulesProperties

PROPERTIES_FILE - Field in PropertiesFileRuleRegistry

propertiesFile - Field in GenerateCodeNarcRulesProperties

PropertiesFileRuleRegistry - Class in groovy.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 groovy.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 groovy.org.codenarc.rule.naming

PropertyNameRule - Class in groovy.org.codenarc.rule.naming

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

PropertyUtil - Class in groovy.org.codenarc.util

Contains property-related static utility methods

PublicFinalizeMethodAstVisitor - Class in groovy.org.codenarc.rule.security

PublicFinalizeMethodRule - Class in groovy.org.codenarc.rule.security

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

PublicInstanceFieldAstVisitor - Class in groovy.org.codenarc.rule.design

PublicInstanceFieldRule - Class in groovy.org.codenarc.rule.design

Using public fields is considered to be a bad design.

Q

R

RandomDoubleCoercedToZeroAstVisitor - Class in groovy.org.codenarc.rule.basic

RandomDoubleCoercedToZeroRule - Class in groovy.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 groovy.org.codenarc.rule.unused

@author Hamlet D'Arcy

RemoveAllOnSelfAstVisitor - Class in groovy.org.codenarc.rule.basic

RemoveAllOnSelfRule - Class in groovy.org.codenarc.rule.basic

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

removeIllegalCharacters(String) - Method in XmlReportWriter

removeInlineViolations(String) - Method in AbstractRuleTestCase

Removes all inline violations from a source.

removePathPrefix(String, String) - Method in PathUtil

Report - Class in groovy.org.codenarc.ant

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

ReportOption - Class in groovy.org.codenarc.ant

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

reports - Field in CodeNarc

ReportWriter - Interface in groovy.org.codenarc.report

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

ReportWriterFactory - Class in groovy.org.codenarc.report

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

reportWriters - Field in CodeNarcTask

RequiredRegexRule - Class in groovy.org.codenarc.rule.generic

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

RequiredStringRule - Class in groovy.org.codenarc.rule.generic

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

requiresLayout() - Method in InMemoryAppender

Resource - Interface in groovy.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 groovy.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 groovy.org.codenarc.results

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

ReturnFromFinallyBlockAstVisitor - Class in groovy.org.codenarc.rule.basic

ReturnFromFinallyBlockRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for a return from within a finally block

ReturnNullFromCatchBlockAstVisitor - Class in groovy.org.codenarc.rule.exceptions

ReturnNullFromCatchBlockRule - Class in groovy.org.codenarc.rule.exceptions

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

ReturnsNullInsteadOfEmptyArrayAstVisitor - Class in groovy.org.codenarc.rule.design

ReturnsNullInsteadOfEmptyArrayRule - Class in groovy.org.codenarc.rule.design

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

ReturnsNullInsteadOfEmptyCollectionRule - Class in groovy.org.codenarc.rule.design

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

ReturnsNullInsteadOfEmptyCollectionRuleAstVisitor - Class in groovy.org.codenarc.rule.design

Rule - Interface in java.org.codenarc.rule

Represents a source code analysis rule .

rule - Field in AbstractRuleTestCase

RULE_INDEX_FILE - Field in GenerateRuleIndexPage

rule(String, Closure) - Method in TopLevelDelegate

ruleIndexFile - Field in GenerateRuleIndexPage

RuleRegistry - Interface in groovy.org.codenarc.ruleregistry

Represents a registry of rule classes, accessible by rule name

RuleRegistryHolder - Class in groovy.org.codenarc.ruleregistry

Holds a reference to the RuleRegistry static singleton

RuleRegistryInitializer - Class in groovy.org.codenarc.ruleregistry

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

RuleSet - Interface in groovy.org.codenarc.ruleset

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

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 groovy.org.codenarc.ruleset

A Builder for RuleSets.

RuleSetDelegate - Class in groovy.org.codenarc.ruleset

RuleSetDelegate(RuleSet) - Constructor in RuleSetDelegate

ruleSetFile - Field in GenerateRuleSetAllRules

ruleSetFile - Field in GenerateRuleSetAllRulesByCategory

ruleSetFiles - Field in CodeNarc

RuleSets - Class in groovy.org.codenarc.ruleset

Holds list of all RuleSet files.

RuleSetUtil - Class in groovy.org.codenarc.ruleset

A private utility class for the RuleSet classes.

S

ScopedConfusingMethodNameAstVisitor - Class in groovy.org.codenarc.rule.naming

ScopedConfusingMethodNameAstVisitor(AbstractAstVisitor) - Constructor in ScopedConfusingMethodNameAstVisitor

SerializableClassMustDefineSerialVersionUIDAstVisitor - Class in groovy.org.codenarc.rule.serialization

SerializableClassMustDefineSerialVersionUIDRule - Class in groovy.org.codenarc.rule.serialization

Classes that implement Serializable should define a serialVersionUID.

SerialPersistentFieldsAstVisitor - Class in groovy.org.codenarc.rule.serialization

SerialPersistentFieldsRule - Class in groovy.org.codenarc.rule.serialization

To use a Serializable object's serialPersistentFields correctly, it must be declared private, static, and final.

SerialVersionUIDAstVisitor - Class in groovy.org.codenarc.rule.serialization

SerialVersionUIDRule - Class in groovy.org.codenarc.rule.serialization

Rule that checks that serialVersionUID field is static final and type long, and is not a property.

SERVICE_CLASSES - Field in GrailsUtil

SERVICE_FILES - Field in GrailsUtil

setAddToIgnoreFieldNames(String) - Method in StatelessClassRule

Add more field names to the existing ignoreFieldNames property value.

setAllowedFieldModifiers(String) - Method in IllegalClassMemberRule

setAllowedMethodModifiers(String) - Method in IllegalClassMemberRule

setAllowedPropertyModifiers(String) - Method in IllegalClassMemberRule

setApplyToClassNames(String) - Method in AbstractAstVisitorRule

setApplyToFileNames(String) - Method in AbstractRule

setApplyToFilesMatching(String) - Method in AbstractRule

setDefaultsIfNecessary() - Method in CodeNarc

setDescription(String) - Method in AbstractRule

setDoNotApplyToClassNames(String) - Method in AbstractAstVisitorRule

setDoNotApplyToFileNames(String) - Method in AbstractRule

setDoNotApplyToFilesMatching(String) - Method in AbstractRule

setEnabled(boolean) - Method in AbstractRule

setIllegalFieldModifiers(String) - Method in IllegalClassMemberRule

setIllegalMethodModifiers(String) - Method in IllegalClassMemberRule

setIllegalPropertyModifiers(String) - Method in IllegalClassMemberRule

setMaxParameters(int) - Method in ParameterCountRule

setName(String) - Method in AbstractRule

Set the unique name for this rule

setPath(String) - Method in SourceString

setPriority(int) - Method in AbstractRule

Set the priority for this rule

setPropertyFromString(Object, String, String) - Method in PropertyUtil

Set the value of the named property on the specified Object from a String value.

setRule(Rule) - Method in AbstractAstVisitor

setRule(Rule) - Method in AbstractFieldVisitor

Set the Rule associated with this visitor

setRule(Rule) - Method in AbstractMethodCallExpressionVisitor

Set the Rule associated with this visitor

setRule(Rule) - Method in AbstractMethodVisitor

Set the Rule associated with this visitor

setRule(Rule) - Method in AstVisitor

Set the Rule associated with this visitor

setSourceCode(SourceCode) - Method in AbstractAstVisitor

setSourceCode(SourceCode) - Method in AbstractFieldVisitor

Set the SourceCode associated with this visitor

setSourceCode(SourceCode) - Method in AbstractMethodCallExpressionVisitor

Set the SourceCode associated with this visitor

setSourceCode(SourceCode) - Method in AbstractMethodVisitor

Set the SourceCode associated with this visitor

setSourceCode(SourceCode) - Method in AstVisitor

Set the SourceCode associated with this visitor

setSuppressionAnalyzer(SuppressionAnalyzer) - Method in AbstractSourceCode

Setter exists to avoid circular dependency.

setUpAbstractRuleTestCase() - Method in AbstractRuleTestCase

setUpAbstractTestCase() - Method in AbstractTestCase

setViolationMessage(String) - Method in AbstractRule

setVisited(Set<Object>) - Method in AbstractAstVisitor

shouldApplyThisRuleTo(ClassNode) - Method in AbstractAstVisitorRule

Return true if this rule should be applied for the specified ClassNode, based on the configuration of this rule.

shouldFail(Closure) - Method in TestUtil

Assert that the specified code throws an exception (of any type).

shouldFailWithMessageContaining(def, Closure) - Method in TestUtil

Assert that the specified closure should throw an exception whose message contains text

shouldIgnoreField(FieldNode) - Method in GrailsStatelessServiceRule

shouldIgnoreField(FieldNode) - Method in StatelessClassRule

Subclasses can optionally override to provide more specific filtering of fields

shouldSkipViolation(Object) - Method in UnnecessaryBigDecimalInstantiationAstVisitor

shouldSkipViolation(Object) - Method in UnnecessaryInstantiationAstVisitor

shouldVisit(ClassNode) - Method in AbstractClassNameAstVisitor

shouldVisit(ClassNode) - Method in AbstractTypeNameAstVisitor

@return true only if this visitor should be applied to (visit) the specified ClassNode.

shouldVisit(ClassNode) - Method in ClassNameAstVisitor

shouldVisit(ClassNode) - Method in InterfaceNameAstVisitor

shouldVisitMethod(MethodNode) - Method in AbstractAstVisitor

shouldVisitMethod(MethodNode) - Method in ReturnNullFromCatchBlockAstVisitor

SimpleDateFormatMissingLocaleAstVisitor - Class in groovy.org.codenarc.rule.design

SimpleDateFormatMissingLocaleRule - Class in groovy.org.codenarc.rule.design

Be sure to specify a Locale when creating a new instance of SimpleDateFormat; the class is locale-sensitive.

sortRules(List) - Method in GenerateUtil

SourceAnalyzer - Interface in groovy.org.codenarc.analyzer

The interface for objects that can analyze the source files within one or more directory trees using a specified RuleSet and produce report results.

SourceCode - Interface in groovy.org.codenarc.source

Represents a unit of source code to be analyzed

SourceCodeCriteria - Class in groovy.org.codenarc.source

Represents the set of criteria used to filter source code (files).

sourceCodeName - Field in AbstractRuleTestCase

sourceCodeNameWithoutExtension(SourceCode) - Method in ClassJavadocRule

sourceCodePath - Field in AbstractRuleTestCase

SourceCodeUtil - Class in groovy.org.codenarc.util

Contains source related static utility methods

SourceFile - Class in groovy.org.codenarc.source

The SourceCode implementation for a single file.

SourceFile(File) - Constructor in SourceFile

Construct a new instance for the file at the specified path

sourceLine(ASTNode) - Method in AbstractAstVisitor

Return the raw source line corresponding to the specified AST node

sourceLineAndNumberForImport(SourceCode, ImportNode) - Method in ImportUtil

Return the source line and line number for the specified import

sourceLineAndNumberForNonStarImport(SourceCode, ImportNode) - Method in ImportUtil

sourceLineAndNumberForStarImport(SourceCode, ImportNode) - Method in ImportUtil

Return the source line and line number for the specified import class name and alias

sourceLineOrEmpty(def) - Method in AbstractSpaceAroundBraceAstVisitor

sourceLinesBetween(SourceCode, int, int, int, int) - Method in SourceCodeUtil

Retrieves source lines between the start line and column and end line and column.

sourceLinesBetweenNodes(SourceCode, ASTNode, ASTNode) - Method in SourceCodeUtil

sourceLineTrimmed(ASTNode) - Method in AbstractAstVisitor

Return the trimmed source line corresponding to the specified AST node

SourceString - Class in groovy.org.codenarc.source

SourceCode implementation that uses source from a pre-defined String.

SourceString(String, String, String) - Constructor in SourceString

Construct a new instance for the file at the specified path

SpaceAfterCatchRule - Class in groovy.org.codenarc.rule.formatting

Check that there is exactly one space (blank) after the catch keyword and before the opening parenthesis.

SpaceAfterClosingBraceAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterClosingBraceRule - Class in groovy.org.codenarc.rule.formatting

Check that there is at least one space (blank) or whitespace after each closing brace ("}").

SpaceAfterCommaAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterCommaRule - Class in groovy.org.codenarc.rule.formatting

Check that there is at least one space (blank) or whitespace following each comma.

SpaceAfterElseAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterForAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterForRule - Class in groovy.org.codenarc.rule.formatting

Check that there is exactly one space (blank) after the for keyword and before the opening parenthesis.

SpaceAfterIfAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterIfRule - Class in groovy.org.codenarc.rule.formatting

Check that there is exactly one space (blank) after the if keyword and before the opening parenthesis.

SpaceAfterOpeningBraceAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterOpeningBraceRule - Class in groovy.org.codenarc.rule.formatting

Check that there is at least one space (blank) or whitespace after each opening brace ("{").

SpaceAfterSemicolonAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterSemicolonRule - Class in groovy.org.codenarc.rule.formatting

Check that there is at least one space (blank) or whitespace following a semicolon that separates: - multiple statements on a single line - the clauses within a classic for loop, e.g. for (i=0;i<10;i++)

SpaceAfterSwitchAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterSwitchRule - Class in groovy.org.codenarc.rule.formatting

Check that there is exactly one space (blank) after the switch keyword and before the opening parenthesis.

SpaceAfterWhileAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAfterWhileRule - Class in groovy.org.codenarc.rule.formatting

Check that there is exactly one space (blank) after the while keyword and before the opening parenthesis.

SpaceAroundClosureArrowAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAroundClosureArrowRule - Class in groovy.org.codenarc.rule.formatting

Checks that there is whitespace around the closure arrow (->) symbol

SpaceAroundMapEntryColonAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAroundMapEntryColonRule - Class in groovy.org.codenarc.rule.formatting

Check for configured formatting of whitespace around colons for literal Map entries

SpaceAroundOperatorAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceAroundOperatorRule - Class in groovy.org.codenarc.rule.formatting

Check that there is at least one space (blank) or whitespace around each binary operator, including: +, -, *, /, >>, <<, &&, ||, &, |, ?

SpaceBeforeClosingBraceAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceBeforeClosingBraceRule - Class in groovy.org.codenarc.rule.formatting

Check that there is at least one space (blank) or whitespace before each closing brace ("}").

SpaceBeforeOpeningBraceAstVisitor - Class in groovy.org.codenarc.rule.formatting

SpaceBeforeOpeningBraceRule - Class in groovy.org.codenarc.rule.formatting

Check that there is at least one space (blank) or whitespace before each opening brace ("{").

SpockIgnoreRestUsedAstVisitor - Class in groovy.org.codenarc.rule.junit

SpockIgnoreRestUsedRule - Class in groovy.org.codenarc.rule.junit

If Spock's

IgnoreRest:

on any method, all non-annotated test methods are not executed.

StatelessClassAstVisitor - Class in groovy.org.codenarc.rule.generic

StatelessClassRule - Class in groovy.org.codenarc.rule.generic

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

StatelessSingletonAstVisitor - Class in groovy.org.codenarc.rule.design

StatelessSingletonRule - Class in groovy.org.codenarc.rule.design

There is no benefit in creating a stateless Singleton.

STATIC_IMPORT_PATTERN - Field in AbstractImportRule

StaticCalendarFieldAstVisitor - Class in groovy.org.codenarc.rule.concurrency

StaticCalendarFieldRule - Class in groovy.org.codenarc.rule.concurrency

Calendar objects should not be used as static fields.

StaticConnectionAstVisitor - Class in groovy.org.codenarc.rule.concurrency

StaticConnectionRule - Class in groovy.org.codenarc.rule.concurrency

Creates violations when a java.sql.Connection object is used as a static field.

StaticDateFormatFieldAstVisitor - Class in groovy.org.codenarc.rule.concurrency

StaticDateFormatFieldRule - Class in groovy.org.codenarc.rule.concurrency

DateFormat objects should not be used as static fields.

StaticMatcherFieldAstVisitor - Class in groovy.org.codenarc.rule.concurrency

StaticMatcherFieldRule - Class in groovy.org.codenarc.rule.concurrency

Matcher objects should not be used as static fields.

StaticSimpleDateFormatFieldAstVisitor - Class in groovy.org.codenarc.rule.concurrency

StaticSimpleDateFormatFieldRule - Class in groovy.org.codenarc.rule.concurrency

SimpleDateFormat objects should not be used as static fields.

StringSourceAnalyzer - Class in groovy.org.codenarc.analyzer

Analyzes Strings.

StringSourceAnalyzer(String) - Constructor in StringSourceAnalyzer

StubRule - Class in groovy.org.codenarc.rule

Stub implementation of the Rule interface for testing

StubRule(int) - Constructor in StubRule

SuppressionAnalyzer - Class in groovy.org.codenarc.analyzer

This class encapsulates all of the logic for determining if an rule is suppressed or not.

SuppressionAnalyzer(SourceCode) - Constructor in SuppressionAnalyzer

SwallowThreadDeathAstVisitor - Class in groovy.org.codenarc.rule.exceptions

SwallowThreadDeathRule - Class in groovy.org.codenarc.rule.exceptions

Detects code that catches java.lang.ThreadDeath without re-throwing it.

SynchronizedMethodAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SynchronizedMethodRule - Class in groovy.org.codenarc.rule.concurrency

Synchronized Method Rule - This rule reports uses of the synchronized keyword on methods.

SynchronizedOnBoxedPrimitiveAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SynchronizedOnBoxedPrimitiveRule - Class in groovy.org.codenarc.rule.concurrency

The code synchronizes on a boxed primitive constant, such as an Integer.

SynchronizedOnGetClassAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SynchronizedOnGetClassRule - Class in groovy.org.codenarc.rule.concurrency

Synchronized on getClass rather than class literal.

SynchronizedOnReentrantLockAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SynchronizedOnReentrantLockRule - Class in groovy.org.codenarc.rule.concurrency

Synchronizing on a ReentrantLock field is almost never the intended usage.

SynchronizedOnStringAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SynchronizedOnStringRule - Class in groovy.org.codenarc.rule.concurrency

Synchronization on a String field can lead to deadlock because Strings are interned by the JVM and can be shared.

SynchronizedOnThisAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SynchronizedOnThisRule - Class in groovy.org.codenarc.rule.concurrency

Synchronized On This Rule - This rule reports uses of the synchronized blocks where the synchronization reference is 'this'.

SynchronizedReadObjectMethodAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SynchronizedReadObjectMethodRule - Class in groovy.org.codenarc.rule.concurrency

Catches Serializable classes that define a synchronized readObject method.

SystemErrPrintAstVisitor - Class in groovy.org.codenarc.rule.logging

SystemErrPrintRule - Class in groovy.org.codenarc.rule.logging

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

systemExit - Field in CodeNarc

SystemExitAstVisitor - Class in groovy.org.codenarc.rule.security

SystemExitRule - Class in groovy.org.codenarc.rule.security

Web applications should never call System.exit().

SystemOutPrintAstVisitor - Class in groovy.org.codenarc.rule.logging

SystemOutPrintRule - Class in groovy.org.codenarc.rule.logging

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

SystemRunFinalizersOnExitAstVisitor - Class in groovy.org.codenarc.rule.concurrency

SystemRunFinalizersOnExitRule - Class in groovy.org.codenarc.rule.concurrency

Method calls to System.runFinalizersOnExit() should not be allowed.

T

TernaryCouldBeElvisAstVisitor - Class in groovy.org.codenarc.rule.convention

TernaryCouldBeElvisRule - Class in groovy.org.codenarc.rule.convention

Rule that checks for ternary expressions where the boolean and true expressions are the same.

testName - Field in AbstractTestCase

testThatApplyToFilesMatchingValuesAreValidRegex() - Method in AbstractRuleTestCase

testThatInvalidCodeHasNoViolations() - Method in AbstractRuleTestCase

testThatUnrelatedCodeHasNoViolations() - Method in AbstractRuleTestCase

Make sure that code unrelated to the rule under test causes no violations.

TestUtil - Class in groovy.org.codenarc.test

Contains common static utility methods for tests

TextReportWriter - Class in groovy.org.codenarc.report

ReportWriter that generates an simple ASCII text report.

ThisReferenceEscapesConstructorAstVisitor - Class in groovy.org.codenarc.rule.concurrency

ThisReferenceEscapesConstructorRule - Class in groovy.org.codenarc.rule.concurrency

Reports constructors passing the 'this' reference to other methods.

ThreadGroupAstVisitor - Class in groovy.org.codenarc.rule.concurrency

ThreadGroupRule - Class in groovy.org.codenarc.rule.concurrency

Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.

ThreadLocalNotStaticFinalAstVisitor - Class in groovy.org.codenarc.rule.concurrency

ThreadLocalNotStaticFinalRule - Class in groovy.org.codenarc.rule.concurrency

ThreadLocal fields should be static and final.

ThreadYieldAstVisitor - Class in groovy.org.codenarc.rule.concurrency

ThreadYieldRule - Class in groovy.org.codenarc.rule.concurrency

Method calls to Thread.yield() should not be allowed.

ThrowErrorRule - Class in groovy.org.codenarc.rule.exceptions

Rule that checks for throwing an instance of java.lang.Error

ThrowExceptionFromFinallyBlockAstVisitor - Class in groovy.org.codenarc.rule.basic

ThrowExceptionFromFinallyBlockRule - Class in groovy.org.codenarc.rule.basic

Rule that checks for throwing an exception from within a finally block

ThrowExceptionRule - Class in groovy.org.codenarc.rule.exceptions

Rule that checks for throwing an instance of java.lang.Exception

ThrowNullPointerExceptionRule - Class in groovy.org.codenarc.rule.exceptions

Rule that checks for throwing an instance of java.lang.NullPointerException

ThrowRuntimeExceptionRule - Class in groovy.org.codenarc.rule.exceptions

Rule that checks for throwing an instance of java.lang.RuntimeException

ThrowThrowableRule - Class in groovy.org.codenarc.rule.exceptions

Rule that checks for throwing an instance of java.lang.Throwable

title - Field in CodeNarc

TopLevelDelegate - Class in groovy.org.codenarc.ruleset

toString() - Method in AbstractRule

toString() - Method in CustomCompilerPhaseSourceDecorator

toString() - Method in DirectoryResults

toString() - Method in FileResults

toString() - Method in HtmlReportWriter

toString() - Method in SourceFile

toString() - Method in SourceString

toString() - Method in Violation

ToStringReturnsNullAstVisitor - Class in groovy.org.codenarc.rule.design

ToStringReturnsNullRule - Class in groovy.org.codenarc.rule.design

Checks for toString() methods that return null.

TrailingWhitespaceRule - Class in groovy.org.codenarc.rule.formatting

Checks that no lines of source code end with whitespace characters.