Groovy Documentation
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

AbcComplexityAstVisitor - Class in org.codenarc.rule.size
AbcComplexityAstVisitor() - Constructor in AbcComplexityAstVisitor
AbcComplexityRule - Class in org.codenarc.rule.size
Rule that calculates the ABC Complexity for methods/classes and checks against configured threshold values.
AbcComplexityRule() - Constructor in AbcComplexityRule
AbstractAstVisitor - Class in org.codenarc.rule
Abstract superclass for Groovy AST Visitors used with Rules
AbstractAstVisitor() - Constructor in AbstractAstVisitor
AbstractAstVisitorRule - Class in org.codenarc.rule
Abstract superclass for Rules that use a Groovy AST Visitor.
AbstractAstVisitorRule() - Constructor in AbstractAstVisitorRule
AbstractClassNameAstVisitor - Class in org.codenarc.rule.naming
AbstractClassNameAstVisitor() - Constructor in AbstractClassNameAstVisitor
AbstractClassNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of an abstract class matches a regular expression specified in the regex property.
AbstractClassNameRule() - Constructor in AbstractClassNameRule
AbstractConstructorCallAstVisitor - Class in org.codenarc.rule.basic
Abstract superclass for AST Visitor classes that deal with constructor calls
AbstractConstructorCallAstVisitor() - Constructor in AbstractConstructorCallAstVisitor
AbstractFinallyAstVisitor - Class in org.codenarc.rule.basic
Abstract superclass for AST Visitor classes that check for conditions within a finally block
AbstractFinallyAstVisitor() - Constructor in AbstractFinallyAstVisitor
AbstractMethodMetricAstVisitor - Class in org.codenarc.rule.size
Abstract superclass for AstVisitor classes that use method-level GMetrics Metrics.
AbstractMethodMetricAstVisitor() - Constructor in AbstractMethodMetricAstVisitor
AbstractReportWriter - Class in org.codenarc.report
Abstract superclass for ReportWriter implementation classes.
AbstractReportWriter() - Constructor in AbstractReportWriter
AbstractRule - Class in org.codenarc.rule
Abstract superclass for Rules.
AbstractRule() - Constructor in AbstractRule
AbstractSourceCode - Class in org.codenarc.source
Abstract superclass for SourceCode implementations
AbstractSourceCode() - Constructor in AbstractSourceCode
AbstractTypeNameAstVisitor - Class in org.codenarc.rule.naming
Abstract superclass for AstVisitor classes dealing with class/type names, e.g. classes, interfaces and abstract classes.
AbstractTypeNameAstVisitor() - Constructor in AbstractTypeNameAstVisitor
addChild(Results) - Method in DirectoryResults
addConfiguredOption(ReportOption) - Method in Report
addConfiguredReport(Report) - Method in CodeNarcTask
Ant-defined method (by convention), called with each instance of a nested element within this task.
addExclude(String) - Method in FilteredRuleSet
Add an exclude criteria.
addFileset(FileSet) - Method in CodeNarcTask
addInclude(String) - Method in FilteredRuleSet
Add an include criteria.
addRule(Rule) - Method in CompositeRuleSet
Add a single Rule to this RuleSet
addRuleSet(RuleSet) - Method in CompositeRuleSet
Add all of the Rules within the specified RuleSet to this RuleSet
addViolation(Violation) - Method in AbstractAstVisitor
Add a new Violation to the list of violations found by this visitor.
AnalysisContext - Class in org.codenarc
Holds information related to the configuration and context for the source code analysis.
AnalysisContext() - Constructor in AnalysisContext
analyze(RuleSet) - Method in AntFileSetSourceAnalyzer
Analyze all source code using the specified RuleSet and return the report results.
analyze(RuleSet) - Method in DirectorySourceAnalyzer
Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.
analyze(RuleSet) - Method in FilesystemSourceAnalyzer
Analyze the source with the configured directory tree(s) using the specified RuleSet and return the report results.
analyze(RuleSet) - Method in SourceAnalyzer
Analyze all source code using the specified RuleSet and return the report results.
AntFileSetSourceAnalyzer - Class in org.codenarc.ant
SourceAnalyzer implementation that gets source files from one or more Ant FileSets.
AntFileSetSourceAnalyzer(Project, List) - Constructor in AntFileSetSourceAnalyzer
Construct a new instance on the specified List of Ant FileSets.
applyTo(SourceCode, List) - Method in AbstractAstVisitorRule
applyTo(SourceCode) - Method in AbstractRule
Apply this rule to the specified source and return a list of violations (or an empty List).
applyTo(SourceCode, List) - Method in DuplicateImportRule
applyTo(SourceCode, List) - Method in IllegalRegexRule
applyTo(SourceCode, List) - Method in ImportFromSamePackageRule
applyTo(SourceCode, List) - Method in RequiredRegexRule
applyTo(SourceCode) - Method in Rule
Apply this rule to the specified source and return a list of violations (or an empty List)
applyTo(SourceCode, List) - Method in UnnecessaryGroovyImportRule
applyTo(SourceCode, List) - Method in UnusedImportRule
applyToClassNames - Property in AbstractAstVisitorRule
This rule is only applied to classes with names matching this value.
applyToClassNames - Property in GrailsPublicControllerMethodRule
applyToClassNames - Property in GrailsStatelessServiceRule
applyToClassNames - Property in JUnitAssertAlwaysFailsRule
applyToClassNames - Property in JUnitAssertAlwaysSucceedsRule
applyToClassNames - Property in JUnitPublicNonTestMethodRule
applyToClassNames - Property in JUnitSetUpCallsSuperRule
applyToClassNames - Property in JUnitTearDownCallsSuperRule
applyToFileNames - Property in AbstractRule
This rule is only applied to source code (file) names matching this value.
applyToFileNames - Property in DirectorySourceAnalyzer
Only analyze filenames matching this value.
applyToFileNames - Property in SourceCodeCriteria
Only apply to source code (file) names matching this value.
applyToFilesMatching - Property in AbstractRule
This rule is only applied to source code (file) pathnames matching this regular expression.
applyToFilesMatching - Property in DirectorySourceAnalyzer
Only analyze pathnames matching this regular expression.
applyToFilesMatching - Property in GrailsPublicControllerMethodRule
applyToFilesMatching - Property in GrailsServletContextReferenceRule
applyToFilesMatching - Property in GrailsSessionReferenceRule
applyToFilesMatching - Property in GrailsStatelessServiceRule
applyToFilesMatching - Property in SourceCodeCriteria
Apply only to source code (file) pathnames matching this regular expression.
assertClassImplementsRuleInterface(Class) - Method in RuleSetUtil
AstUtil - Class in org.codenarc.util
Contains static utility methods related to Groovy AST.
AstVisitor - Interface in org.codenarc.rule
Interface for Groovy AST Visitors used with Rules
astVisitorClass - Property in AbcComplexityRule
astVisitorClass - Property in AbstractAstVisitorRule
Each concrete subclass must either set this property or define its own property with the same name
astVisitorClass - Property in AbstractClassNameRule
astVisitorClass - Property in BooleanInstantiationRule
astVisitorClass - Property in ClassNameRule
astVisitorClass - Property in ClassSizeRule
astVisitorClass - Property in CloneableWithoutCloneRule
astVisitorClass - Property in ConstantIfExpressionRule
astVisitorClass - Property in ConstantTernaryExpressionRule
astVisitorClass - Property in CyclomaticComplexityRule
astVisitorClass - Property in ElseBlockBracesRule
astVisitorClass - Property in EmptyCatchBlockRule
astVisitorClass - Property in EmptyElseBlockRule
astVisitorClass - Property in EmptyFinallyBlockRule
astVisitorClass - Property in EmptyForStatementRule
astVisitorClass - Property in EmptyIfStatementRule
astVisitorClass - Property in EmptySwitchStatementRule
astVisitorClass - Property in EmptySynchronizedStatementRule
astVisitorClass - Property in EmptyTryBlockRule
astVisitorClass - Property in EmptyWhileStatementRule
astVisitorClass - Property in EqualsAndHashCodeRule
astVisitorClass - Property in FieldNameRule
astVisitorClass - Property in ForStatementBracesRule
astVisitorClass - Property in GrailsPublicControllerMethodRule
astVisitorClass - Property in GrailsServletContextReferenceRule
astVisitorClass - Property in GrailsSessionReferenceRule
astVisitorClass - Property in IfStatementBracesRule
astVisitorClass - Property in InterfaceNameRule
astVisitorClass - Property in JUnitAssertAlwaysFailsRule
astVisitorClass - Property in JUnitAssertAlwaysSucceedsRule
astVisitorClass - Property in JUnitPublicNonTestMethodRule
astVisitorClass - Property in JUnitSetUpCallsSuperRule
astVisitorClass - Property in JUnitTearDownCallsSuperRule
astVisitorClass - Property in MethodNameRule
astVisitorClass - Property in MethodSizeRule
astVisitorClass - Property in NestedBlockDepthRule
astVisitorClass - Property in NestedSynchronizationRule
astVisitorClass - Property in PackageNameRule
astVisitorClass - Property in ParameterNameRule
astVisitorClass - Property in PrintlnRule
astVisitorClass - Property in PrintStackTraceRule
astVisitorClass - Property in PropertyNameRule
astVisitorClass - Property in ReturnFromFinallyBlockRule
astVisitorClass - Property in StatelessClassRule
astVisitorClass - Property in StringInstantiationRule
astVisitorClass - Property in SynchronizedMethodRule
astVisitorClass - Property in SynchronizedOnThisRule
astVisitorClass - Property in SystemErrPrintRule
astVisitorClass - Property in SystemOutPrintRule
astVisitorClass - Property in SystemRunFinalizersOnExitRule
astVisitorClass - Property in ThreadLocalNotStaticFinalRule
astVisitorClass - Property in ThreadYieldRule
astVisitorClass - Property in ThrowExceptionFromFinallyBlockRule
astVisitorClass - Property in UnnecessaryTernaryExpressionRule
astVisitorClass - Property in UnusedPrivateFieldRule
astVisitorClass - Property in UnusedPrivateMethodRule
astVisitorClass - Property in UnusedVariableRule
astVisitorClass - Property in VariableNameRule
astVisitorClass - Property in VolatileLongOrDoubleFieldRule
astVisitorClass - Property in WhileStatementBracesRule

B

BASE_MESSAGES_BUNDLE - Property in AbstractReportWriter
baseDir - Property in CodeNarc
baseDirectory - Property in DirectorySourceAnalyzer
The base directory; the sourceDirectories are relative to this, if not null.
baseDirectory - Property in FilesystemSourceAnalyzer
The base (root) directory.
BOOLEAN_CLASS - Property in AbstractAstVisitor
BooleanInstantiationAstVisitor - Class in org.codenarc.rule.basic
BooleanInstantiationAstVisitor() - Constructor in BooleanInstantiationAstVisitor
BooleanInstantiationRule - Class in org.codenarc.rule.basic
Rule that checks for direct call to Boolean constructor - use Boolean.valueOf() instead.
BooleanInstantiationRule() - Constructor in BooleanInstantiationRule
bracesRequiredForElseIf - Property in ElseBlockBracesRule

C

CatchErrorRule - Class in org.codenarc.rule.exceptions
Rule that checks for catching a Error
CatchErrorRule() - Constructor in CatchErrorRule
CatchExceptionRule - Class in org.codenarc.rule.exceptions
Rule that checks for catching a Exception
CatchExceptionRule() - Constructor in CatchExceptionRule
CatchNullPointerExceptionRule - Class in org.codenarc.rule.exceptions
Rule that checks for catching a NullPointerException
CatchNullPointerExceptionRule() - Constructor in CatchNullPointerExceptionRule
CatchRuntimeExceptionRule - Class in org.codenarc.rule.exceptions
Rule that checks for catching a RuntimeException
CatchRuntimeExceptionRule() - Constructor in CatchRuntimeExceptionRule
CatchThrowableRule - Class in org.codenarc.rule.exceptions
Rule that checks for catching a Throwable
CatchThrowableRule() - Constructor in CatchThrowableRule
ClassNameAstVisitor - Class in org.codenarc.rule.naming
ClassNameAstVisitor() - Constructor in ClassNameAstVisitor
ClassNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of a class matches a regular expression.
ClassNameRule() - Constructor in ClassNameRule
ClassPathResource - Class in org.codenarc.util.io
A Resource implementation for resources available on the classpath.
ClassPathResource(String) - Constructor in ClassPathResource
Construct a new ClassPathResource
ClassSizeAstVisitor - Class in org.codenarc.rule.size
ClassSizeAstVisitor() - Constructor in ClassSizeAstVisitor
ClassSizeRule - Class in org.codenarc.rule.size
Rule that checks the size of a class.
ClassSizeRule() - Constructor in ClassSizeRule
CloneableWithoutCloneAstVisitor - Class in org.codenarc.rule.basic
CloneableWithoutCloneAstVisitor() - Constructor in CloneableWithoutCloneAstVisitor
CloneableWithoutCloneRule - Class in org.codenarc.rule.basic
A class that implements Cloneable should define a clone() method.
CloneableWithoutCloneRule() - Constructor in CloneableWithoutCloneRule
CodeNarc - Class in org.codenarc
Command-line runner for CodeNarc.
CodeNarc() - Constructor in CodeNarc
CODENARC_URL - Property in AbstractReportWriter
CodeNarcRunner - Class in org.codenarc
Helper class to run CodeNarc.
CodeNarcRunner() - Constructor in CodeNarcRunner
CodeNarcTask - Class in org.codenarc.ant
Ant Task for running CodeNarc.
CodeNarcTask() - Constructor in CodeNarcTask
CommonCatchAstVisitor - Class in org.codenarc.rule.exceptions
AstVisitor implementation that checks for catching an exception type specified in the constructor

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

CommonCatchAstVisitor(String) - Constructor in CommonCatchAstVisitor
Construct a new instance, specifying the exception class name
CommonThrowAstVisitor - Class in org.codenarc.rule.exceptions
AstVisitor implementation that checks for throwing one of the exception type names specified in the constructor

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

CommonThrowAstVisitor(List) - Constructor in CommonThrowAstVisitor
Construct a new instance, specifying the exception type names with and without package
CompositeRuleSet - Class in org.codenarc.ruleset
A RuleSet implementation that aggregates a set of RuleSets and Rules.
CompositeRuleSet() - Constructor in CompositeRuleSet
configure(RuleSet) - Method in PropertiesFileRuleSetConfigurer
Configure the rules within the RuleSet from the properties file (relative to the classpath).
CONSTANT_EXPRESSION_VALUES - Property in AbstractAstVisitor
ConstantIfExpressionAstVisitor - Class in org.codenarc.rule.basic
ConstantIfExpressionAstVisitor() - Constructor in ConstantIfExpressionAstVisitor
ConstantIfExpressionRule - Class in org.codenarc.rule.basic
Rule that checks for if statement with a constant value for the if expression, such as:
ConstantIfExpressionRule() - Constructor in ConstantIfExpressionRule
ConstantTernaryExpressionAstVisitor - Class in org.codenarc.rule.basic
ConstantTernaryExpressionAstVisitor() - Constructor in ConstantTernaryExpressionAstVisitor
ConstantTernaryExpressionRule - Class in org.codenarc.rule.basic
Rule that checks for ternary expressions with a constant value for the boolean expression, such as:
ConstantTernaryExpressionRule() - Constructor in ConstantTernaryExpressionRule
CONTROLLERS_AND_TAGLIB_FILES - Property in GrailsUtil
CONTROLLERS_CLASSES - Property in GrailsUtil
CONTROLLERS_FILES - Property in GrailsUtil
createCodeNarcRunner - Property in CodeNarc
createCodeNarcRunner - Property in CodeNarcTask
createMetric() - Method in AbcComplexityAstVisitor
createMetric() - Method in AbstractMethodMetricAstVisitor
createMetric() - Method in CyclomaticComplexityAstVisitor
createRuleSet() - Method in CodeNarcRunner
Create and return the RuleSet that provides the source of Rules to be applied.
createSourceAnalyzer() - Method in CodeNarc
Create and return the SourceAnalyzer
createSourceAnalyzer() - Method in CodeNarcTask
Create and return the SourceAnalyzer
createViolation(SourceCode, ASTNode, def) - Method in AbstractRule
Create a new Violation for the AST node.
createViolationForImport(SourceCode, String, String) - Method in AbstractRule
Create and return a new Violation for this rule and the specified import className and alias
CUSTOM_MESSAGES_BUNDLE - Property in AbstractReportWriter
customMessagesBundleName - Property in AbstractReportWriter
CyclomaticComplexityAstVisitor - Class in org.codenarc.rule.size
CyclomaticComplexityAstVisitor() - Constructor in CyclomaticComplexityAstVisitor
CyclomaticComplexityRule - Class in org.codenarc.rule.size
Rule that calculates the Cyclomatic Complexity for methods/classes and checks against configured threshold values.
CyclomaticComplexityRule() - Constructor in CyclomaticComplexityRule

D

DEFAULT_CONST_NAME - Property in AbstractAstVisitorRule
DEFAULT_FIELD_NAME - Property in AbstractAstVisitorRule
DEFAULT_INCLUDES - Property in FilesystemSourceAnalyzer
DEFAULT_OUTPUT_FILE - Property in HtmlReportWriter
DEFAULT_TEST_CLASS_NAMES - Property in AbstractAstVisitorRule
DEFAULT_TEST_FILES - Property in AbstractAstVisitorRule
DEFAULT_VAR_NAME - Property in AbstractAstVisitorRule
defaultOutputFile - Property in HtmlReportWriter
defaultOutputFile - Property in TextReportWriter
defaultOutputFile - Property in XmlReportWriter
defaultPropertiesFilename - Property in PropertiesFileRuleSetConfigurer
DefaultResourceFactory - Class in org.codenarc.util.io
Default implementation of ResourceFactory.
DefaultResourceFactory() - Constructor in DefaultResourceFactory
description - Property in AbstractRule
If not null, this is used as the description text for this rule, overriding any description text found in the i18n resource bundles.
description(String) - Method in TopLevelDelegate
DirectoryResults - Class in org.codenarc.results
Represents the results for a directory
DirectoryResults(String) - Constructor in DirectoryResults
Create a new instance with the specified path
DirectorySourceAnalyzer - Class in org.codenarc.analyzer
SourceAnalyzer implementation that recursively processes files in the configured source directories.
DirectorySourceAnalyzer() - Constructor in DirectorySourceAnalyzer
doNotApplyToClassNames - Property in AbstractAstVisitorRule
This rule is NOT applied to classes with names matching this value.
doNotApplyToFileNames - Property in AbstractRule
This rule is NOT applied to source code (file) names matching this value.
doNotApplyToFileNames - Property in DirectorySourceAnalyzer
Do NOT analyze filenames matching this value.
doNotApplyToFileNames - Property in SourceCodeCriteria
Do NOT apply to source code (file) names matching this value.
doNotApplyToFilesMatching - Property in AbstractRule
This rule is NOT applied to source code (file) pathnames matching this regular expression.
doNotApplyToFilesMatching - Property in DirectorySourceAnalyzer
Do NOT analyze pathnames matching this regular expression.
doNotApplyToFilesMatching - Property in SourceCodeCriteria
Do NOT apply to source code (file) pathnames matching this regular expression.
DuplicateImportRule - Class in org.codenarc.rule.imports
Rule that checks for a duplicate import NOTE: Does not work under Groovy 1.7 (i.e., will not produce violations for duplicate import statements).
DuplicateImportRule() - Constructor in DuplicateImportRule

E

ElseBlockBracesAstVisitor - Class in org.codenarc.rule.braces
ElseBlockBracesAstVisitor() - Constructor in ElseBlockBracesAstVisitor
ElseBlockBracesRule - Class in org.codenarc.rule.braces
Rule that checks that else blocks use braces rather than a single statement.
ElseBlockBracesRule() - Constructor in ElseBlockBracesRule
EmptyCatchBlockAstVisitor - Class in org.codenarc.rule.basic
EmptyCatchBlockAstVisitor() - Constructor in EmptyCatchBlockAstVisitor
EmptyCatchBlockRule - Class in org.codenarc.rule.basic
Rule that checks for empty catch blocks
EmptyCatchBlockRule() - Constructor in EmptyCatchBlockRule
EmptyElseBlockAstVisitor - Class in org.codenarc.rule.basic
EmptyElseBlockAstVisitor() - Constructor in EmptyElseBlockAstVisitor
EmptyElseBlockRule - Class in org.codenarc.rule.basic
Rule that checks for empty else blocks
EmptyElseBlockRule() - Constructor in EmptyElseBlockRule
EmptyFinallyBlockAstVisitor - Class in org.codenarc.rule.basic
EmptyFinallyBlockAstVisitor() - Constructor in EmptyFinallyBlockAstVisitor
EmptyFinallyBlockRule - Class in org.codenarc.rule.basic
Rule that checks for empty finally blocks
EmptyFinallyBlockRule() - Constructor in EmptyFinallyBlockRule
EmptyForStatementAstVisitor - Class in org.codenarc.rule.basic
EmptyForStatementAstVisitor() - Constructor in EmptyForStatementAstVisitor
EmptyForStatementRule - Class in org.codenarc.rule.basic
Rule that checks for empty for statements
EmptyForStatementRule() - Constructor in EmptyForStatementRule
EmptyIfStatementAstVisitor - Class in org.codenarc.rule.basic
EmptyIfStatementAstVisitor() - Constructor in EmptyIfStatementAstVisitor
EmptyIfStatementRule - Class in org.codenarc.rule.basic
Rule that checks for empty if statements
EmptyIfStatementRule() - Constructor in EmptyIfStatementRule
EmptySwitchStatementAstVisitor - Class in org.codenarc.rule.basic
EmptySwitchStatementAstVisitor() - Constructor in EmptySwitchStatementAstVisitor
EmptySwitchStatementRule - Class in org.codenarc.rule.basic
Rule that checks for empty switch statements
EmptySwitchStatementRule() - Constructor in EmptySwitchStatementRule
EmptySynchronizedStatementAstVisitor - Class in org.codenarc.rule.basic
EmptySynchronizedStatementAstVisitor() - Constructor in EmptySynchronizedStatementAstVisitor
EmptySynchronizedStatementRule - Class in org.codenarc.rule.basic
Rule that checks for empty synchronized statement
EmptySynchronizedStatementRule() - Constructor in EmptySynchronizedStatementRule
EmptyTryBlockAstVisitor - Class in org.codenarc.rule.basic
EmptyTryBlockAstVisitor() - Constructor in EmptyTryBlockAstVisitor
EmptyTryBlockRule - Class in org.codenarc.rule.basic
Rule that checks for empty try blocks
EmptyTryBlockRule() - Constructor in EmptyTryBlockRule
EmptyWhileStatementAstVisitor - Class in org.codenarc.rule.basic
EmptyWhileStatementAstVisitor() - Constructor in EmptyWhileStatementAstVisitor
EmptyWhileStatementRule - Class in org.codenarc.rule.basic
Rule that checks for empty while statements
EmptyWhileStatementRule() - Constructor in EmptyWhileStatementRule
enabled - Property in AbstractRule
Flag indicating whether this rule should be enabled (applied).
EqualsAndHashCodeAstVisitor - Class in org.codenarc.rule.basic
EqualsAndHashCodeAstVisitor() - Constructor in EqualsAndHashCodeAstVisitor
EqualsAndHashCodeRule - Class in org.codenarc.rule.basic
Rule that checks that if either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.
EqualsAndHashCodeRule() - Constructor in EqualsAndHashCodeRule
exclude(String) - Method in RuleSetDelegate
excludes - Property in CodeNarc
excludes - Property in FilesystemSourceAnalyzer
The ant-style pattern of files to exclude from the analysis.
execute(String[]) - Method in CodeNarc
execute() - Method in CodeNarcRunner
The main entry point for this class.
execute() - Method in CodeNarcTask
Execute this Ant Task

F

FieldNameAstVisitor - Class in org.codenarc.rule.naming
FieldNameAstVisitor() - Constructor in FieldNameAstVisitor
FieldNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of each field matches a regular expression.
FieldNameRule() - Constructor in FieldNameRule
FILE_SEPARATOR - Property in AbstractSourceCode
FileResults - Class in org.codenarc.results
Represents the results of applying a set of rules against a single sourcefile
FileResults(String, List) - Constructor in FileResults
fileSets - Property in AntFileSetSourceAnalyzer
fileSets - Property in CodeNarcTask
FilesystemSourceAnalyzer - Class in org.codenarc.analyzer
SourceAnalyzer implementation that recursively processes files from the file system.
FilesystemSourceAnalyzer() - Constructor in FilesystemSourceAnalyzer
FilteredRuleSet - Class in org.codenarc.ruleset
A RuleSet implementation that is a Decorator for another RuleSet, but provides the ability to filter included and excluded rules within that RuleSet.
FilteredRuleSet(RuleSet) - Constructor in FilteredRuleSet
Construct a new instance on the specified RuleSet
finalRegex - Property in FieldNameRule
finalRegex - Property in PropertyNameRule
finalRegex - Property in VariableNameRule
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.
formatSourceLine(String, int) - Method in HtmlReportWriter
Format and trim the source line.
ForStatementBracesAstVisitor - Class in org.codenarc.rule.braces
ForStatementBracesAstVisitor() - Constructor in ForStatementBracesAstVisitor
ForStatementBracesRule - Class in org.codenarc.rule.braces
Rule that checks that for statements use braces rather than a single statement.
ForStatementBracesRule() - Constructor in ForStatementBracesRule

G

getAnnotation(AnnotatedNode, String) - Method in AstUtil
Return the AnnotationNode for the named annotation, or else null.
getApplyToFilenames() - Method in AbstractRule
Throws UnsupportedOperationException
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
getAstVisitor() - Method in AbstractAstVisitorRule
getAstVisitor() - Method in CatchErrorRule
getAstVisitor() - Method in CatchExceptionRule
getAstVisitor() - Method in CatchNullPointerExceptionRule
getAstVisitor() - Method in CatchRuntimeExceptionRule
getAstVisitor() - Method in CatchThrowableRule
getAstVisitor() - Method in ThrowErrorRule
getAstVisitor() - Method in ThrowExceptionRule
getAstVisitor() - Method in ThrowNullPointerExceptionRule
getAstVisitor() - Method in ThrowRuntimeExceptionRule
getAstVisitor() - Method in ThrowThrowableRule
getChildren() - Method in DirectoryResults
getChildren() - Method in FileResults
Return an empty List
getChildren() - Method in Results
getCodeNarcVersion() - Method in AbstractReportWriter
getDescriptionForRule(Rule) - Method in AbstractReportWriter
getDoNotApplyToFilenames() - Method in AbstractRule
Throws UnsupportedOperationException
getFormattedTimestamp() - Method in AbstractReportWriter
getHtmlDescriptionForRule(Rule) - Method in AbstractReportWriter
getImportsSortedByLineNumber(def) - Method in AbstractRule
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
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
getLines() - Method in GMetricsSourceCodeAdapter
getLines() - Method in SourceCode
getMaxClassMetricValue() - Method in AbcComplexityAstVisitor
getMaxClassMetricValue() - Method in AbstractMethodMetricAstVisitor
getMaxClassMetricValue() - Method in CyclomaticComplexityAstVisitor
getMaxMethodMetricValue() - Method in AbcComplexityAstVisitor
getMaxMethodMetricValue() - Method in AbstractMethodMetricAstVisitor
getMaxMethodMetricValue() - Method in CyclomaticComplexityAstVisitor
getMethodArguments(MethodCallExpression) - Method in AstUtil
Return the List of Arguments for the specified MethodCallExpression.
getMetricShortDescription() - Method in AbcComplexityAstVisitor
getMetricShortDescription() - Method in AbstractMethodMetricAstVisitor
getMetricShortDescription() - Method in CyclomaticComplexityAstVisitor
getName() - Method in AbstractRule
getName() - Method in GMetricsSourceCodeAdapter
getName(String) - Method in PathUtil
getName() - Method in Rule
getName() - Method in SourceCode
Get the logical name for this source code.
getName() - Method in SourceFile
getNumberOfFilesWithViolations(boolean) - Method in DirectoryResults
Return the number of files with violations
getNumberOfFilesWithViolations(boolean) - Method in FileResults
Return 1 if these results include at least one violation
getNumberOfFilesWithViolations(boolean) - Method in Results
Return the number of files with violations
getNumberOfViolationsWithPriority(int, boolean) - Method in DirectoryResults
Return the number of violations with the specified priority
getNumberOfViolationsWithPriority(int, boolean) - Method in FileResults
getNumberOfViolationsWithPriority(int, boolean) - Method in Results
Return the number of violations with the specified priority
getPath() - Method in DirectoryResults
getPath() - Method in FileResults
getPath() - Method in GMetricsSourceCodeAdapter
getPath() - Method in Results
getPath() - Method in SourceCode
Get the logical path for this source code.
getPath() - Method in SourceFile
getPriority() - Method in AbstractRule
getPriority() - Method in Rule
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
getRules() - Method in CompositeRuleSet
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
getRules() - Method in ListRuleSet
getRules() - Method in RuleSet
getRules() - Method in XmlFileRuleSet
getRules() - Method in XmlReaderRuleSet
getRuleSet() - Method in RuleSetBuilder
getRuleSet() - Method in TopLevelDelegate
getSortedRules(AnalysisContext) - Method in AbstractReportWriter
getSourceDirectories() - Method in AntFileSetSourceAnalyzer
getSourceDirectories() - Method in FilesystemSourceAnalyzer
getSourceDirectories() - Method in SourceAnalyzer
Return the List of source directories to be analyzed.
getSourceUnit() - Method in AbstractAstVisitor
getText() - Method in GMetricsSourceCodeAdapter
getText() - Method in SourceCode
getText() - Method in SourceFile
getText() - Method in SourceString
getTimestamp - Property 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
getVariableExpressions(DeclarationExpression) - Method in AstUtil
Return the List of VariableExpression objects referenced by the specified DeclarationExpression.
getVersion() - Method in GroovyVersion
getViolations() - Method in AstVisitor
Retrieve the List of Violations resulting from applying this visitor
getViolationsWithPriority(int) - Method in DirectoryResults
getViolationsWithPriority(int) - Method in FileResults
getViolationsWithPriority(int) - Method in Results
Return the List of violations with the specified priority
GMetricsSourceCodeAdapter - Class in org.codenarc.rule.size
Adapter that adapts from a GMetrics SourceCode object to a CodeNarc SourceCode object.
GMetricsSourceCodeAdapter(def) - Constructor in GMetricsSourceCodeAdapter
GrailsPublicControllerMethodAstVisitor - Class in org.codenarc.rule.grails
GrailsPublicControllerMethodAstVisitor() - Constructor in GrailsPublicControllerMethodAstVisitor
GrailsPublicControllerMethodRule - Class in org.codenarc.rule.grails
Rule that checks for public methods on Grails controller classes.
GrailsPublicControllerMethodRule() - Constructor in GrailsPublicControllerMethodRule
GrailsServletContextReferenceAstVisitor - Class in org.codenarc.rule.grails
GrailsServletContextReferenceAstVisitor() - Constructor in GrailsServletContextReferenceAstVisitor
GrailsServletContextReferenceRule - Class in org.codenarc.rule.grails
Rule that checks for references to the servletContext object from within Grails controller and taglib classes.
GrailsServletContextReferenceRule() - Constructor in GrailsServletContextReferenceRule
GrailsSessionReferenceAstVisitor - Class in org.codenarc.rule.grails
GrailsSessionReferenceAstVisitor() - Constructor in GrailsSessionReferenceAstVisitor
GrailsSessionReferenceRule - Class in 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 org.codenarc.rule.grails
Rule that checks for non-final fields on a Grails service class.
GrailsStatelessServiceRule() - Constructor in GrailsStatelessServiceRule
GrailsUtil - Class in org.codenarc.rule.grails
Utility methods and constants for Grails rule classes.
GroovyDslRuleSet - Class in org.codenarc.ruleset
A RuleSet implementation that parses a Groovy DSL of RuleSet definitions.
GroovyDslRuleSet(String) - Constructor in GroovyDslRuleSet
Construct a new instance on the specified Groovy DSL RuleSet file path
GroovyVersion - Class in org.codenarc.util
Utility methods to determine the version of Groovy currently executing.

H

HELP - Property in CodeNarc
HtmlReportWriter - Class in org.codenarc.report
ReportWriter that generates an HTML report.
HtmlReportWriter() - Constructor in HtmlReportWriter

I

IfStatementBracesAstVisitor - Class in org.codenarc.rule.braces
IfStatementBracesAstVisitor() - Constructor in IfStatementBracesAstVisitor
IfStatementBracesRule - Class in org.codenarc.rule.braces
Rule that checks that if statements use braces rather than a single statement.
IfStatementBracesRule() - Constructor in IfStatementBracesRule
ignoreFieldNames - Property in FieldNameRule
ignoreFieldNames - Property in StatelessClassRule
ignoreFieldTypes - Property in StatelessClassRule
ignoreMethodNames - Property in AbcComplexityRule
ignoreMethodNames - Property in CyclomaticComplexityRule
ignoreMethodNames - Property in MethodNameRule
ignoreMethodNames - Property in MethodSizeRule
ignoreParameterNames - Property in ParameterNameRule
ignorePropertyNames - Property in PropertyNameRule
ignoreVariableNames - Property in VariableNameRule
IllegalRegexRule - Class in org.codenarc.rule.generic
Checks for a specified illegal regular expression within the source code.
IllegalRegexRule() - Constructor in IllegalRegexRule
ImportFromSamePackageRule - Class in org.codenarc.rule.imports
Checks for an import of a class that is within the same package as the importing class.
ImportFromSamePackageRule() - Constructor in ImportFromSamePackageRule
include(String) - Method in RuleSetDelegate
includes - Property in CodeNarc
includes - Property in FilesystemSourceAnalyzer
The ant-style pattern of files to include in the analysis.
initializeDefaultResourceBundle() - Method in AbstractReportWriter
initializeResourceBundle - Property in AbstractReportWriter
initializeWildcardPatterns() - Method in FilesystemSourceAnalyzer
InterfaceNameAstVisitor - Class in org.codenarc.rule.naming
InterfaceNameAstVisitor() - Constructor in InterfaceNameAstVisitor
InterfaceNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of an interface matches a regular expression specified in the regex property.
InterfaceNameRule() - Constructor in InterfaceNameRule
isAssertConstantValueCall(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.
isBlock(Statement) - Method in AstUtil
Return true if the Statement is a block
isConstantBooleanExpression(def) - Method in AbstractAstVisitor
isConstructorCallAViolation(ConstructorCallExpression) - Method in AbstractConstructorCallAstVisitor
Subclasses must implement to return true if the visited constructor call causes a rule violation
isConstructorCallAViolation(ConstructorCallExpression) - Method in BooleanInstantiationAstVisitor
isConstructorCallAViolation(ConstructorCallExpression) - Method in StringInstantiationAstVisitor
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
isFile() - Method in DirectoryResults
isFile() - Method in FileResults
isFile() - Method in Results
isFinalVariable(DeclarationExpression, SourceCode) - Method in AstUtil
Return true if the DeclarationExpression represents a 'final' variable declaration.
isFirstVisit(def) - Method in AbstractAstVisitor
Return true if the AST expression has not already been visited.
isFromGeneratedSourceCode(ASTNode) - Method in AstUtil
isGroovy1_5() - Method in GroovyVersion
isGroovy1_6() - Method in GroovyVersion
isGroovy1_7() - Method in GroovyVersion
isIgnoredMethodName(String) - Method in AbstractMethodMetricAstVisitor
isMethodCall(MethodCallExpression, String, String) - Method in AstUtil
Return true only if the MethodCallExpression represents a method call for the specified method object (receiver) and method name.
isMethodNamed(MethodCallExpression, String) - Method in AstUtil
Return true only if the MethodCallExpression represents a method call for the specified method name
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 IllegalRegexRule
isReady() - Method in InterfaceNameRule
isReady() - Method in RequiredRegexRule
isStatementWithinFinally(Statement) - Method in AbstractFinallyAstVisitor

J

JUnitAssertAlwaysFailsAstVisitor - Class in org.codenarc.rule.junit
JUnitAssertAlwaysFailsAstVisitor() - Constructor in JUnitAssertAlwaysFailsAstVisitor
JUnitAssertAlwaysFailsRule - Class in org.codenarc.rule.junit
Rule that checks for JUnit assert() method calls with constant arguments such that the assertion always fails.
JUnitAssertAlwaysFailsRule() - Constructor in JUnitAssertAlwaysFailsRule
JUnitAssertAlwaysSucceedsAstVisitor - Class in org.codenarc.rule.junit
JUnitAssertAlwaysSucceedsAstVisitor() - Constructor in JUnitAssertAlwaysSucceedsAstVisitor
JUnitAssertAlwaysSucceedsRule - Class in org.codenarc.rule.junit
Rule that checks for JUnit assert() method calls with constant arguments such that the assertion always succeeds.
JUnitAssertAlwaysSucceedsRule() - Constructor in JUnitAssertAlwaysSucceedsRule
JUnitPublicNonTestMethodAstVisitor - Class in org.codenarc.rule.junit
JUnitPublicNonTestMethodAstVisitor() - Constructor in JUnitPublicNonTestMethodAstVisitor
JUnitPublicNonTestMethodRule - Class in org.codenarc.rule.junit
Rule that checks if a JUnit test class contains public methods other than:
  • Zero-argument methods with names starting with "test"
  • The setUp() and tearDown() methods
  • Methods annotated with @Test
  • Methods annotated with @Before and @After
  • Methods annotated with @BeforeClass and @AfterClass
Public, non-test methods on a test class violate conventional usage of test classes, and can be confusing.
JUnitPublicNonTestMethodRule() - Constructor in JUnitPublicNonTestMethodRule
JUnitSetUpCallsSuperAstVisitor - Class in org.codenarc.rule.junit
JUnitSetUpCallsSuperAstVisitor() - Constructor in JUnitSetUpCallsSuperAstVisitor
JUnitSetUpCallsSuperRule - Class in org.codenarc.rule.junit
Rule that checks that if the JUnit setUp() method is defined, that it includes a call to super.setUp().
JUnitSetUpCallsSuperRule() - Constructor in JUnitSetUpCallsSuperRule
JUnitTearDownCallsSuperAstVisitor - Class in org.codenarc.rule.junit
JUnitTearDownCallsSuperAstVisitor() - Constructor in JUnitTearDownCallsSuperAstVisitor
JUnitTearDownCallsSuperRule - Class in org.codenarc.rule.junit
Rule that checks that if the JUnit tearDown() method is defined, that it includes a call to super.tearDown().
JUnitTearDownCallsSuperRule() - Constructor in JUnitTearDownCallsSuperRule
JUnitUtil - Class in org.codenarc.rule.junit
Utility methods for JUnit rule classes.

K


L

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
lineNumber - Property in Violation
ListRuleSet - Class in org.codenarc.ruleset
A RuleSet implementation that returns a static List of Rules passed into its constructor.
ListRuleSet(List) - Constructor in ListRuleSet
Construct a new instance from the specified List of rules.
loadRuleScriptFile(String) - Method in RuleSetUtil
loadRuleSetFile(String) - Method in RuleSetUtil
LOG - Property in AbstractReportWriter
LOG - Property in AbstractRule
LOG - Property in AbstractSourceCode
LOG - Property in CodeNarc

M

main(String[]) - Method in CodeNarc
Main command-line entry-point.
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.
MAX_SOURCE_LINE_LENGTH - Property in AbstractAstVisitor
maxClassAverageMethodComplexity - Property in AbcComplexityRule
maxClassAverageMethodComplexity - Property in CyclomaticComplexityRule
maxLines - Property in ClassSizeRule
maxLines - Property in MethodSizeRule
maxMethodComplexity - Property in AbcComplexityRule
maxMethodComplexity - Property in CyclomaticComplexityRule
maxNestedBlockDepth - Property in NestedBlockDepthRule
maxPriority1Violations - Property in CodeNarcTask
maxPriority2Violations - Property in CodeNarcTask
maxPriority3Violations - Property in CodeNarcTask
message - Property in Violation
methodMissing(String, def) - Method in RuleSetDelegate
MethodNameAstVisitor - Class in org.codenarc.rule.naming
MethodNameAstVisitor() - Constructor in MethodNameAstVisitor
MethodNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of each method matches a regular expression.
MethodNameRule() - Constructor in MethodNameRule
MethodSizeAstVisitor - Class in org.codenarc.rule.size
MethodSizeAstVisitor() - Constructor in MethodSizeAstVisitor
MethodSizeRule - Class in org.codenarc.rule.size
Rule that checks the size of a method.
MethodSizeRule() - Constructor in MethodSizeRule
metric - Property in AbstractMethodMetricAstVisitor

N

name - Property in AbcComplexityRule
name - Property in AbstractClassNameRule
name - Property in BooleanInstantiationRule
name - Property in CatchErrorRule
name - Property in CatchExceptionRule
name - Property in CatchNullPointerExceptionRule
name - Property in CatchRuntimeExceptionRule
name - Property in CatchThrowableRule
name - Property in ClassNameRule
name - Property in ClassSizeRule
name - Property in CloneableWithoutCloneRule
name - Property in ConstantIfExpressionRule
name - Property in ConstantTernaryExpressionRule
name - Property in CyclomaticComplexityRule
name - Property in DuplicateImportRule
name - Property in ElseBlockBracesRule
name - Property in EmptyCatchBlockRule
name - Property in EmptyElseBlockRule
name - Property in EmptyFinallyBlockRule
name - Property in EmptyForStatementRule
name - Property in EmptyIfStatementRule
name - Property in EmptySwitchStatementRule
name - Property in EmptySynchronizedStatementRule
name - Property in EmptyTryBlockRule
name - Property in EmptyWhileStatementRule
name - Property in EqualsAndHashCodeRule
name - Property in FieldNameRule
name - Property in ForStatementBracesRule
name - Property in GrailsPublicControllerMethodRule
name - Property in GrailsServletContextReferenceRule
name - Property in GrailsSessionReferenceRule
name - Property in GrailsStatelessServiceRule
name - Property in IfStatementBracesRule
name - Property in IllegalRegexRule
name - Property in ImportFromSamePackageRule
name - Property in InterfaceNameRule
name - Property in JUnitAssertAlwaysFailsRule
name - Property in JUnitAssertAlwaysSucceedsRule
name - Property in JUnitPublicNonTestMethodRule
name - Property in JUnitSetUpCallsSuperRule
name - Property in JUnitTearDownCallsSuperRule
name - Property in MethodNameRule
name - Property in MethodSizeRule
name - Property in NestedBlockDepthRule
name - Property in NestedSynchronizationRule
name - Property in PackageNameRule
name - Property in ParameterNameRule
name - Property in PrintlnRule
name - Property in PrintStackTraceRule
name - Property in PropertyNameRule
name - Property in ReportOption
name - Property in RequiredRegexRule
name - Property in ReturnFromFinallyBlockRule
name - Property in SourceString
name - Property in StatelessClassRule
name - Property in StringInstantiationRule
name - Property in SynchronizedMethodRule
name - Property in SynchronizedOnThisRule
name - Property in SystemErrPrintRule
name - Property in SystemOutPrintRule
name - Property in SystemRunFinalizersOnExitRule
name - Property in ThreadLocalNotStaticFinalRule
name - Property in ThreadYieldRule
name - Property in ThrowErrorRule
name - Property in ThrowExceptionFromFinallyBlockRule
name - Property in ThrowExceptionRule
name - Property in ThrowNullPointerExceptionRule
name - Property in ThrowRuntimeExceptionRule
name - Property in ThrowThrowableRule
name - Property in UnnecessaryGroovyImportRule
name - Property in UnnecessaryTernaryExpressionRule
name - Property in UnusedImportRule
name - Property in UnusedPrivateFieldRule
name - Property in UnusedPrivateMethodRule
name - Property in UnusedVariableRule
name - Property in VariableNameRule
name - Property in VolatileLongOrDoubleFieldRule
name - Property in WhileStatementBracesRule
NestedBlockDepthAstVisitor - Class in org.codenarc.rule.size
NestedBlockDepthAstVisitor() - Constructor in NestedBlockDepthAstVisitor
NestedBlockDepthRule - Class in org.codenarc.rule.size
Rule that checks for blocks or closures nested more than a configured maximum number.
NestedBlockDepthRule() - Constructor in NestedBlockDepthRule
NestedSynchronizationAstVisitor - Class in org.codenarc.rule.concurrency
NestedSynchronizationAstVisitor() - Constructor in NestedSynchronizationAstVisitor
NestedSynchronizationRule - Class in org.codenarc.rule.concurrency
Rule to detect nested synchronization blocks.
NestedSynchronizationRule() - Constructor in NestedSynchronizationRule
NEW_BOOLEAN - Property in BooleanInstantiationAstVisitor
NEW_STRING - Property in StringInstantiationAstVisitor
normalizePath(String) - Method in AbstractSourceCode
Return the normalized value of the specified path.
numberOfFilesInThisDirectory - Property in DirectoryResults

O

options - Property in Report
outputFile - Property in AbstractReportWriter

P

PackageNameAstVisitor - Class in org.codenarc.rule.naming
PackageNameAstVisitor() - Constructor in PackageNameAstVisitor
packageNameForImport(ImportNode) - Method in AbstractRule
Return the package name for the specified import statement or else an empty String or an empty String if the import contains no package component
packageNameRequired - Property in PackageNameRule
PackageNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the package name of a class matches a regular expression.
PackageNameRule() - Constructor in PackageNameRule
ParameterNameAstVisitor - Class in org.codenarc.rule.naming
ParameterNameAstVisitor() - Constructor in ParameterNameAstVisitor
ParameterNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of each parameter matches a regular expression.
ParameterNameRule() - Constructor in ParameterNameRule
parseArgs(String[]) - Method in CodeNarc
path - Property in ClassPathResource
path - Property in SourceString
path - Property in UrlResource
PathUtil - Class in org.codenarc.util
Path-related utility methods.
PrintlnAstVisitor - Class in org.codenarc.rule.logging
PrintlnAstVisitor() - Constructor in PrintlnAstVisitor
PrintlnRule - Class in org.codenarc.rule.logging
Rule that checks for calls to this.print(), this.println() or this.printf().
PrintlnRule() - Constructor in PrintlnRule
PrintStackTraceAstVisitor - Class in org.codenarc.rule.logging
PrintStackTraceAstVisitor() - Constructor in PrintStackTraceAstVisitor
PrintStackTraceRule - Class in org.codenarc.rule.logging
Rule that checks for calls to printStackTrace().
PrintStackTraceRule() - Constructor in PrintStackTraceRule
priority - Property in AbcComplexityRule
priority - Property in AbstractClassNameRule
priority - Property in BooleanInstantiationRule
priority - Property in CatchErrorRule
priority - Property in CatchExceptionRule
priority - Property in CatchNullPointerExceptionRule
priority - Property in CatchRuntimeExceptionRule
priority - Property in CatchThrowableRule
priority - Property in ClassNameRule
priority - Property in ClassSizeRule
priority - Property in CloneableWithoutCloneRule
priority - Property in ConstantIfExpressionRule
priority - Property in ConstantTernaryExpressionRule
priority - Property in CyclomaticComplexityRule
priority - Property in DuplicateImportRule
priority - Property in ElseBlockBracesRule
priority - Property in EmptyCatchBlockRule
priority - Property in EmptyElseBlockRule
priority - Property in EmptyFinallyBlockRule
priority - Property in EmptyForStatementRule
priority - Property in EmptyIfStatementRule
priority - Property in EmptySwitchStatementRule
priority - Property in EmptySynchronizedStatementRule
priority - Property in EmptyTryBlockRule
priority - Property in EmptyWhileStatementRule
priority - Property in EqualsAndHashCodeRule
priority - Property in FieldNameRule
priority - Property in ForStatementBracesRule
priority - Property in GrailsPublicControllerMethodRule
priority - Property in GrailsServletContextReferenceRule
priority - Property in GrailsSessionReferenceRule
priority - Property in GrailsStatelessServiceRule
priority - Property in IfStatementBracesRule
priority - Property in IllegalRegexRule
priority - Property in ImportFromSamePackageRule
priority - Property in InterfaceNameRule
priority - Property in JUnitAssertAlwaysFailsRule
priority - Property in JUnitAssertAlwaysSucceedsRule
priority - Property in JUnitPublicNonTestMethodRule
priority - Property in JUnitSetUpCallsSuperRule
priority - Property in JUnitTearDownCallsSuperRule
priority - Property in MethodNameRule
priority - Property in MethodSizeRule
priority - Property in NestedBlockDepthRule
priority - Property in NestedSynchronizationRule
priority - Property in PackageNameRule
priority - Property in ParameterNameRule
priority - Property in PrintlnRule
priority - Property in PrintStackTraceRule
priority - Property in PropertyNameRule
priority - Property in RequiredRegexRule
priority - Property in ReturnFromFinallyBlockRule
priority - Property in StatelessClassRule
priority - Property in StringInstantiationRule
priority - Property in SynchronizedMethodRule
priority - Property in SynchronizedOnThisRule
priority - Property in SystemErrPrintRule
priority - Property in SystemOutPrintRule
priority - Property in SystemRunFinalizersOnExitRule
priority - Property in ThreadLocalNotStaticFinalRule
priority - Property in ThreadYieldRule
priority - Property in ThrowErrorRule
priority - Property in ThrowExceptionFromFinallyBlockRule
priority - Property in ThrowExceptionRule
priority - Property in ThrowNullPointerExceptionRule
priority - Property in ThrowRuntimeExceptionRule
priority - Property in ThrowThrowableRule
priority - Property in UnnecessaryGroovyImportRule
priority - Property in UnnecessaryTernaryExpressionRule
priority - Property in UnusedImportRule
priority - Property in UnusedPrivateFieldRule
priority - Property in UnusedPrivateMethodRule
priority - Property in UnusedVariableRule
priority - Property in VariableNameRule
priority - Property in VolatileLongOrDoubleFieldRule
priority - Property in WhileStatementBracesRule
PropertiesFileRuleSetConfigurer - Class in org.codenarc.ruleset
Reads the properties file named "codenarc.properties", if found on the classpath, and applies the property values to matching Rules within a specified RuleSet.
PropertiesFileRuleSetConfigurer() - Constructor in PropertiesFileRuleSetConfigurer
PropertyNameAstVisitor - Class in org.codenarc.rule.naming
PropertyNameAstVisitor() - Constructor in PropertyNameAstVisitor
PropertyNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of each property matches a regular expression.
PropertyNameRule() - Constructor in PropertyNameRule
PropertyUtil - Class in org.codenarc.util
Contains property-related static utility methods

Q


R

regex - Property in AbstractClassNameRule
regex - Property in ClassNameRule
regex - Property in FieldNameRule
regex - Property in IllegalRegexRule
regex - Property in InterfaceNameRule
regex - Property in MethodNameRule
regex - Property in PackageNameRule
regex - Property in ParameterNameRule
regex - Property in PropertyNameRule
regex - Property in RequiredRegexRule
regex - Property in VariableNameRule
Report - Class in org.codenarc.ant
JavaBean class holding the properties for a element with the CodeNarc Ant Task.
Report() - Constructor in Report
ReportOption - Class in org.codenarc.ant
JavaBean class holding the properties for a
ReportOption() - Constructor in ReportOption
reports - Property in CodeNarc
ReportWriter - Interface in org.codenarc.report
Represents the interface of an object that can write out a report
ReportWriterFactory - Class in org.codenarc.report
Factory for ReportWriter objects based on the report type (name).
ReportWriterFactory() - Constructor in ReportWriterFactory
reportWriters - Property in CodeNarcRunner
reportWriters - Property in CodeNarcTask
RequiredRegexRule - Class in org.codenarc.rule.generic
Checks for a specified regular expression that must exist within the source code.
RequiredRegexRule() - Constructor in RequiredRegexRule
Resource - Interface in org.codenarc.util.io
Defines the interface for objects that represent a resource (e.g. a file) and provide access to its InputStream.
resourceBundle - Property in AbstractReportWriter
ResourceFactory - Interface in org.codenarc.util.io
Defines the interface for factory objects that create/return Resource instances.
Results - Interface in org.codenarc.results
Represents the results of applying rules to one or more source files/directories
ReturnFromFinallyBlockAstVisitor - Class in org.codenarc.rule.basic
ReturnFromFinallyBlockAstVisitor() - Constructor in ReturnFromFinallyBlockAstVisitor
ReturnFromFinallyBlockRule - Class in org.codenarc.rule.basic
Rule that checks for a return from within a finally block
ReturnFromFinallyBlockRule() - Constructor in ReturnFromFinallyBlockRule
ReturnFromFinallyRule - Class in org.codenarc.rule.basic
ReturnFromFinallyRule() - Constructor in ReturnFromFinallyRule
Rule - Interface in org.codenarc.rule
Represents a source code analysis rule
rule - Property in AbstractAstVisitor
rule(String, Closure) - Method in TopLevelDelegate
rule - Property in Violation
RuleSet - Interface in org.codenarc.ruleset
Represents a set of (configured) Rule objects that can be applied for static analysis.
ruleSet - Property in AnalysisContext
The RuleSet containing the rules being applied.
ruleSet - Property in CodeNarcTask
ruleset(Closure) - Method in RuleSetBuilder
ruleSet - Property in RuleSetDelegate
ruleset(String, Closure) - Method in TopLevelDelegate
RuleSetBuilder - Class in org.codenarc.ruleset
A Builder for RuleSets.
RuleSetBuilder() - Constructor in RuleSetBuilder
RuleSetDelegate - Class in org.codenarc.ruleset
RuleSetDelegate(RuleSet) - Constructor in RuleSetDelegate
ruleSetFiles - Property in CodeNarc
ruleSetFiles - Property in CodeNarcRunner
ruleSetFiles - Property in CodeNarcTask
The path to the Groovy or XML RuleSet definition files, relative to the classpath.
RuleSetUtil - Class in org.codenarc.ruleset
A private utility class for the RuleSet classes.

S

SEP - Property in DirectorySourceAnalyzer
SEP - Property in FilesystemSourceAnalyzer
SERVICE_CLASSES - Property in GrailsUtil
SERVICE_FILES - Property in GrailsUtil
setAddToIgnoreFieldNames(String) - Method in StatelessClassRule
Add more field names to the existing ignoreFieldNames property value.
setApplyToFilenames(String) - Method in AbstractRule
Throws UnsupportedOperationException
setDefaultsIfNecessary() - Method in CodeNarc
setDoNotApplyToFilenames(String) - Method in AbstractRule
Throws UnsupportedOperationException
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 AstVisitor
Set the Rule associated with this visitor
setSourceCode(SourceCode) - Method in AstVisitor
Set the SourceCode associated with this visitor
shouldApplyThisRuleTo(def) - Method in AbstractAstVisitorRule
Return true if this rule should be applied for the specified ClassNode, based on the configuration of this rule.
shouldVisit(ClassNode) - Method in AbstractClassNameAstVisitor
shouldVisit(ClassNode) - Method in AbstractTypeNameAstVisitor
shouldVisit(ClassNode) - Method in ClassNameAstVisitor
shouldVisit(ClassNode) - Method in InterfaceNameAstVisitor
SOURCE_LINE_LAST_SEGMENT_LENGTH - Property in AbstractAstVisitor
SourceAnalyzer - Interface in 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.
sourceAnalyzer - Property in CodeNarcRunner
SourceCode - Interface in org.codenarc.source
Represents a unit of source code to be analyzed
sourceCode - Property in AbstractAstVisitor
SourceCodeCriteria - Class in org.codenarc.source
Represents the set of criteria used to filter source code (files).
SourceCodeCriteria() - Constructor in SourceCodeCriteria
sourceDirectories - Property in AnalysisContext
The List of source directories being analyzed.
sourceDirectories - Property in DirectorySourceAnalyzer
The list of source directories, relative to the baseDirectory if it is not null.
SourceFile - Class in 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 source line corresponding to the specified AST node
sourceLine - Property in Violation
sourceLineAndNumberForImport(SourceCode, ImportNode) - Method in AbstractRule
Return the source line and line number for the specified import
SourceString - Class in 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
StatelessClassAstVisitor - Class in org.codenarc.rule.generic
StatelessClassAstVisitor() - Constructor in StatelessClassAstVisitor
StatelessClassRule - Class in org.codenarc.rule.generic
Rule that checks for non-final fields on a class.
StatelessClassRule() - Constructor in StatelessClassRule
staticFinalRegex - Property in FieldNameRule
staticFinalRegex - Property in PropertyNameRule
staticRegex - Property in FieldNameRule
staticRegex - Property in PropertyNameRule
StringInstantiationAstVisitor - Class in org.codenarc.rule.basic
StringInstantiationAstVisitor() - Constructor in StringInstantiationAstVisitor
StringInstantiationRule - Class in org.codenarc.rule.basic
Rule that checks for direct call to the String constructor that accepts a String literal.
StringInstantiationRule() - Constructor in StringInstantiationRule
SynchronizedMethodAstVisitor - Class in org.codenarc.rule.concurrency
SynchronizedMethodAstVisitor() - Constructor in SynchronizedMethodAstVisitor
SynchronizedMethodRule - Class in org.codenarc.rule.concurrency
Synchronized Method Rule - This rule reports uses of the synchronized keyword on methods.
SynchronizedMethodRule() - Constructor in SynchronizedMethodRule
SynchronizedOnThisAstVisitor - Class in org.codenarc.rule.concurrency
SynchronizedOnThisAstVisitor() - Constructor in SynchronizedOnThisAstVisitor
SynchronizedOnThisRule - Class in org.codenarc.rule.concurrency
Synchronized On This Rule - This rule reports uses of the synchronized blocks where the synchronization reference is 'this'.
SynchronizedOnThisRule() - Constructor in SynchronizedOnThisRule
SystemErrPrintAstVisitor - Class in org.codenarc.rule.logging
SystemErrPrintAstVisitor() - Constructor in SystemErrPrintAstVisitor
SystemErrPrintRule - Class in org.codenarc.rule.logging
Rule that checks for calls to System.err.print(), System.err.println() or System.err.printf().
SystemErrPrintRule() - Constructor in SystemErrPrintRule
SystemOutPrintAstVisitor - Class in org.codenarc.rule.logging
SystemOutPrintAstVisitor() - Constructor in SystemOutPrintAstVisitor
SystemOutPrintRule - Class in org.codenarc.rule.logging
Rule that checks for calls to System.out.print(), System.out.println() or System.out.printf().
SystemOutPrintRule() - Constructor in SystemOutPrintRule
SystemRunFinalizersOnExitAstVisitor - Class in org.codenarc.rule.concurrency
SystemRunFinalizersOnExitAstVisitor() - Constructor in SystemRunFinalizersOnExitAstVisitor
SystemRunFinalizersOnExitRule - Class in org.codenarc.rule.concurrency
Method calls to System.runFinalizersOnExit() should not be allowed.
SystemRunFinalizersOnExitRule() - Constructor in SystemRunFinalizersOnExitRule

T

TextReportWriter - Class in org.codenarc.report
ReportWriter that generates an simple ASCII text report.
TextReportWriter() - Constructor in TextReportWriter
ThreadLocalNotStaticFinalAstVisitor - Class in org.codenarc.rule.concurrency
ThreadLocalNotStaticFinalAstVisitor() - Constructor in ThreadLocalNotStaticFinalAstVisitor
ThreadLocalNotStaticFinalRule - Class in org.codenarc.rule.concurrency
ThreadLocal fields should be static and final.
ThreadLocalNotStaticFinalRule() - Constructor in ThreadLocalNotStaticFinalRule
ThreadYieldAstVisitor - Class in org.codenarc.rule.concurrency
ThreadYieldAstVisitor() - Constructor in ThreadYieldAstVisitor
ThreadYieldRule - Class in org.codenarc.rule.concurrency
Method calls to Thread.yield() should not be allowed.
ThreadYieldRule() - Constructor in ThreadYieldRule
ThrowErrorRule - Class in org.codenarc.rule.exceptions
Rule that checks for throwing an instance of java.lang.Error
ThrowErrorRule() - Constructor in ThrowErrorRule
ThrowExceptionFromFinallyBlockAstVisitor - Class in org.codenarc.rule.basic
ThrowExceptionFromFinallyBlockAstVisitor() - Constructor in ThrowExceptionFromFinallyBlockAstVisitor
ThrowExceptionFromFinallyBlockRule - Class in org.codenarc.rule.basic
Rule that checks for throwing an exception from within a finally block
ThrowExceptionFromFinallyBlockRule() - Constructor in ThrowExceptionFromFinallyBlockRule
ThrowExceptionFromFinallyRule - Class in org.codenarc.rule.basic
ThrowExceptionFromFinallyRule() - Constructor in ThrowExceptionFromFinallyRule
ThrowExceptionRule - Class in org.codenarc.rule.exceptions
Rule that checks for throwing an instance of java.lang.Exception
ThrowExceptionRule() - Constructor in ThrowExceptionRule
ThrowNullPointerExceptionRule - Class in org.codenarc.rule.exceptions
Rule that checks for throwing an instance of java.lang.NullPointerException
ThrowNullPointerExceptionRule() - Constructor in ThrowNullPointerExceptionRule
ThrowRuntimeExceptionRule - Class in org.codenarc.rule.exceptions
Rule that checks for throwing an instance of java.lang.RuntimeException
ThrowRuntimeExceptionRule() - Constructor in ThrowRuntimeExceptionRule
ThrowThrowableRule - Class in org.codenarc.rule.exceptions
Rule that checks for throwing an instance of java.lang.Throwable
ThrowThrowableRule() - Constructor in ThrowThrowableRule
title - Property in CodeNarc
title - Property in HtmlReportWriter
title - Property in Report
title - Property in TextReportWriter
title - Property in XmlReportWriter
toFile - Property in Report
TopLevelDelegate - Class in org.codenarc.ruleset
TopLevelDelegate() - Constructor in TopLevelDelegate
toString() - Method in AbstractRule
toString() - Method in DirectoryResults
toString() - Method in FileResults
toString() - Method in HtmlReportWriter
toString() - Method in SourceFile
toString() - Method in SourceString
toString() - Method in Violation
type - Property in Report

U

UnnecessaryGroovyImportRule - Class in org.codenarc.rule.imports
Rule that checks for imports from any packages that are already automatically imported by Groovy classes, including java.lang, java.net, java.util, java.io, java.net, groovy.lang and groovy.util, as well as the classes java.math.BigDecimal and java.math.BigInteger
UnnecessaryGroovyImportRule() - Constructor in UnnecessaryGroovyImportRule
UnnecessaryTernaryExpressionAstVisitor - Class in org.codenarc.rule.basic
UnnecessaryTernaryExpressionAstVisitor() - Constructor in UnnecessaryTernaryExpressionAstVisitor
UnnecessaryTernaryExpressionRule - Class in org.codenarc.rule.basic
Rule that checks for ternary expressions where the conditional expression always evaluates to a boolean and the true and false expressions are merely returning true and false constants.
UnnecessaryTernaryExpressionRule() - Constructor in UnnecessaryTernaryExpressionRule
UnusedImportRule - Class in org.codenarc.rule.imports
Rule that checks for an unreferenced import
UnusedImportRule() - Constructor in UnusedImportRule
UnusedPrivateFieldAstVisitor - Class in org.codenarc.rule.unused
UnusedPrivateFieldAstVisitor() - Constructor in UnusedPrivateFieldAstVisitor
UnusedPrivateFieldRule - Class in org.codenarc.rule.unused
Rule that checks for private fields that are not referenced within the same class.
UnusedPrivateFieldRule() - Constructor in UnusedPrivateFieldRule
UnusedPrivateMethodAstVisitor - Class in org.codenarc.rule.unused
UnusedPrivateMethodAstVisitor() - Constructor in UnusedPrivateMethodAstVisitor
UnusedPrivateMethodRule - Class in org.codenarc.rule.unused
Rule that checks for private methods that are not referenced within the same class.
UnusedPrivateMethodRule() - Constructor in UnusedPrivateMethodRule
UnusedVariableAstVisitor - Class in org.codenarc.rule.unused
UnusedVariableAstVisitor() - Constructor in UnusedVariableAstVisitor
UnusedVariableRule - Class in org.codenarc.rule.unused
Rule that checks for variables that are not referenced.
UnusedVariableRule() - Constructor in UnusedVariableRule
UrlResource - Class in org.codenarc.util.io
A Resource implementation based on java.net.URL.
UrlResource(String) - Constructor in UrlResource
Construct a new FileResource

V

validate() - Method in AbstractRule
Allows rules to perform validation.
validate() - Method in ClassNameRule
validate() - Method in FieldNameRule
validate() - Method in ParameterNameRule
validate() - Method in PropertyNameRule
value - Property in ReportOption
VariableNameAstVisitor - Class in org.codenarc.rule.naming
VariableNameAstVisitor() - Constructor in VariableNameAstVisitor
VariableNameRule - Class in org.codenarc.rule.naming
Rule that verifies that the name of each variable matches a regular expression.
VariableNameRule() - Constructor in VariableNameRule
VERSION_FILE - Property in AbstractReportWriter
Violation - Class in org.codenarc.rule
Represents a single instance of a rule violation
Violation() - Constructor in Violation
violationMessage - Property in AbstractRule
If not null, this is used as the message for all violations of this rule, overriding any message generated by the concrete rule subclass.
violations - Property in AbstractAstVisitor
visitBlockStatement(BlockStatement) - Method in NestedBlockDepthAstVisitor
visitBlockStatement(BlockStatement) - Method in UnusedVariableAstVisitor
visitCaseStatement(CaseStatement) - Method in NestedBlockDepthAstVisitor
visitCatchStatement(CatchStatement) - Method in CommonCatchAstVisitor
visitCatchStatement(CatchStatement) - Method in EmptyCatchBlockAstVisitor
visitCatchStatement(CatchStatement) - Method in NestedBlockDepthAstVisitor
visitClass(ClassNode) - Method in AbstractMethodMetricAstVisitor
visitClass(ClassNode) - Method in AbstractTypeNameAstVisitor
visitClass(ClassNode) - Method in ClassSizeAstVisitor
visitClass(ClassNode) - Method in CloneableWithoutCloneAstVisitor
visitClass(ClassNode) - Method in EqualsAndHashCodeAstVisitor
visitClass(ClassNode) - Method in NestedBlockDepthAstVisitor
visitClass(ClassNode) - Method in PackageNameAstVisitor
visitClass(ClassNode) - Method in UnusedPrivateFieldAstVisitor
visitClass(ClassNode) - Method in UnusedPrivateMethodAstVisitor
visitClosureExpression(ClosureExpression) - Method in NestedBlockDepthAstVisitor
visitClosureExpression(ClosureExpression) - Method in NestedSynchronizationAstVisitor
visitClosureExpression(ClosureExpression) - Method in ParameterNameAstVisitor
visitConstructor(ConstructorNode) - Method in ParameterNameAstVisitor
visitConstructorCallExpression(ConstructorCallExpression) - Method in AbstractConstructorCallAstVisitor
visitConstructorOrMethod(MethodNode, boolean) - Method in CloneableWithoutCloneAstVisitor
visitConstructorOrMethod(MethodNode, boolean) - Method in MethodSizeAstVisitor
visitDeclarationExpression(DeclarationExpression) - Method in UnusedVariableAstVisitor
visitDeclarationExpression(DeclarationExpression) - Method in VariableNameAstVisitor
visited - Property in AbstractAstVisitor
visitField(FieldNode) - Method in FieldNameAstVisitor
visitField(FieldNode) - Method in StatelessClassAstVisitor
visitField(FieldNode) - Method in ThreadLocalNotStaticFinalAstVisitor
visitField(FieldNode) - Method in VolatileLongOrDoubleFieldVisitor
visitFieldExpression(FieldExpression) - Method in UnusedPrivateFieldAstVisitor
visitForLoop(ForStatement) - Method in EmptyForStatementAstVisitor
visitForLoop(ForStatement) - Method in ForStatementBracesAstVisitor
visitForLoop(ForStatement) - Method in NestedBlockDepthAstVisitor
visitIfElse(IfStatement) - Method in ConstantIfExpressionAstVisitor
visitIfElse(IfStatement) - Method in ElseBlockBracesAstVisitor
visitIfElse(IfStatement) - Method in EmptyElseBlockAstVisitor
visitIfElse(IfStatement) - Method in EmptyIfStatementAstVisitor
visitIfElse(IfStatement) - Method in IfStatementBracesAstVisitor
visitIfElse(IfStatement) - Method in NestedBlockDepthAstVisitor
visitMethod(MethodNode) - Method in GrailsPublicControllerMethodAstVisitor
visitMethod(MethodNode) - Method in JUnitPublicNonTestMethodAstVisitor
visitMethod(MethodNode) - Method in JUnitSetUpCallsSuperAstVisitor
visitMethod(MethodNode) - Method in JUnitTearDownCallsSuperAstVisitor
visitMethod(MethodNode) - Method in MethodNameAstVisitor
visitMethod(MethodNode) - Method in ParameterNameAstVisitor
visitMethod(MethodNode) - Method in SynchronizedMethodAstVisitor
visitMethod(MethodNode) - Method in UnusedPrivateFieldAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in BooleanInstantiationAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in JUnitAssertAlwaysFailsAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in JUnitAssertAlwaysSucceedsAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in PrintlnAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in PrintStackTraceAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in SystemErrPrintAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in SystemOutPrintAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in SystemRunFinalizersOnExitAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in ThreadYieldAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in UnusedPrivateMethodAstVisitor
visitMethodCallExpression(MethodCallExpression) - Method in UnusedVariableAstVisitor
visitProperty(PropertyNode) - Method in FieldNameAstVisitor
visitProperty(PropertyNode) - Method in PropertyNameAstVisitor
visitProperty(PropertyNode) - Method in UnusedPrivateFieldAstVisitor
visitPropertyExpression(PropertyExpression) - Method in UnusedPrivateFieldAstVisitor
visitReturnStatement(ReturnStatement) - Method in ReturnFromFinallyBlockAstVisitor
visitSwitch(SwitchStatement) - Method in EmptySwitchStatementAstVisitor
visitSynchronizedStatement(SynchronizedStatement) - Method in EmptySynchronizedStatementAstVisitor
visitSynchronizedStatement(SynchronizedStatement) - Method in NestedBlockDepthAstVisitor
visitSynchronizedStatement(SynchronizedStatement) - Method in NestedSynchronizationAstVisitor
visitSynchronizedStatement(SynchronizedStatement) - Method in SynchronizedOnThisAstVisitor
visitTernaryExpression(TernaryExpression) - Method in ConstantTernaryExpressionAstVisitor
visitTernaryExpression(TernaryExpression) - Method in UnnecessaryTernaryExpressionAstVisitor
visitThrowStatement(ThrowStatement) - Method in CommonThrowAstVisitor
visitThrowStatement(ThrowStatement) - Method in ThrowExceptionFromFinallyBlockAstVisitor
visitTryCatchFinally(TryCatchStatement) - Method in AbstractFinallyAstVisitor
visitTryCatchFinally(TryCatchStatement) - Method in EmptyFinallyBlockAstVisitor
visitTryCatchFinally(TryCatchStatement) - Method in EmptyTryBlockAstVisitor
visitTryCatchFinally(TryCatchStatement) - Method in NestedBlockDepthAstVisitor
visitVariableExpression(VariableExpression) - Method in GrailsServletContextReferenceAstVisitor
visitVariableExpression(VariableExpression) - Method in GrailsSessionReferenceAstVisitor
visitVariableExpression(VariableExpression) - Method in UnusedPrivateFieldAstVisitor
visitVariableExpression(VariableExpression) - Method in UnusedVariableAstVisitor
visitWhileLoop(WhileStatement) - Method in EmptyWhileStatementAstVisitor
visitWhileLoop(WhileStatement) - Method in NestedBlockDepthAstVisitor
visitWhileLoop(WhileStatement) - Method in WhileStatementBracesAstVisitor
VolatileLongOrDoubleFieldRule - Class in org.codenarc.rule.concurrency
This rule reports long or double fields which are declared as volatile.
VolatileLongOrDoubleFieldRule() - Constructor in VolatileLongOrDoubleFieldRule
VolatileLongOrDoubleFieldVisitor - Class in org.codenarc.rule.concurrency
VolatileLongOrDoubleFieldVisitor() - Constructor in VolatileLongOrDoubleFieldVisitor

W

WhileStatementBracesAstVisitor - Class in org.codenarc.rule.braces
WhileStatementBracesAstVisitor() - Constructor in WhileStatementBracesAstVisitor
WhileStatementBracesRule - Class in org.codenarc.rule.braces
Rule that checks that while statements use braces rather than a single statement.
WhileStatementBracesRule() - Constructor in WhileStatementBracesRule
WildcardPattern - Class in org.codenarc.util
Represents a string pattern that may optionally include wildcards ('*', '**' or '?')
WildcardPattern(String, boolean) - Constructor in WildcardPattern
Construct a new WildcardPattern instance on a single pattern or a comma-separated list of patterns.
writeReport(AnalysisContext, Results) - Method in AbstractReportWriter
Write out a report for the specified analysis results
writeReport(Writer, AnalysisContext, Results) - Method in HtmlReportWriter
Write out a report to the specified Writer for the analysis results
writeReport(AnalysisContext, Results) - Method in ReportWriter
Write out a report for the specified analysis results
writeReport(Writer, AnalysisContext, Results) - Method in TextReportWriter
writeReport(Writer, AnalysisContext, Results) - Method in XmlReportWriter
writeToStandardOut - Property in AbstractReportWriter

X

XmlFileRuleSet - Class in org.codenarc.ruleset
A RuleSet implementation that parses Rule definitions from XML read from a file.
XmlFileRuleSet(String) - Constructor in XmlFileRuleSet
Construct a new instance on the specified RuleSet file path
XmlReaderRuleSet - Class in org.codenarc.ruleset
A RuleSet implementation that parses Rule definitions from XML read from a Reader.
XmlReaderRuleSet(Reader) - Constructor in XmlReaderRuleSet
Construct a new instance on the specified Reader
XmlReportWriter - Class in org.codenarc.report
ReportWriter that generates an XML report.
XmlReportWriter() - Constructor in XmlReportWriter

Y


Z


_


Groovy Documentation