UnusedPrivateFieldRule (CodeNarc 3.3.0 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.codenarc.rule.unused.UnusedPrivateFieldRule

```
class UnusedPrivateFieldRule
extends AbstractSharedAstVisitorRule
```
Rule that checks for private fields that are not referenced within the same class.
Ignore fields annotated with
Delegate.:
The ignoreFieldNames property optionally specifies one or more (comma-separated) field names that should be ignored (i.e., that should not cause a rule violation). The name(s) may optionally include wildcard characters ('*' or '?').
The ignoreClassesAnnotatedWithNames property optionally specifies one or more (comma-separated) annotation names; any classes annotated with those should be ignored (i.e., should not cause a rule violation). The name(s) may optionally include wildcard characters ('*' or '?').

Authors:
Chris Mair
Hamlet D'Arcy

Inherited fields
Fields inherited from class	Fields
`class AbstractAstVisitorRule`	`CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME`

Properties Summary

Properties
Type	Name and description
`boolean`	`allowConstructorOnlyUsages`
`java.lang.String`	`ignoreClassesAnnotatedWithNames`
`java.lang.String`	`ignoreFieldNames`
`java.lang.String`	`name`
`int`	`priority`

Constructor Summary

Constructors
Constructor and description
`UnusedPrivateFieldRule ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected AstVisitor`	`getAstVisitor(SourceCode sourceCode)`
	`protected java.util.List<Violation>`	`getViolations(AstVisitor visitor, SourceCode sourceCode)`
	`protected boolean`	`shouldApplyThisRuleTo(ClassNode classNode)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractSharedAstVisitorRule`	`applyTo, applyVisitor, getAstVisitor, getViolations`
`class AbstractAstVisitorRule`	`applyTo, compare, getApplyToClassNames, getAstVisitor, getAstVisitorClass, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo`
`class AbstractRule`	`applyTo, applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getName, getPriority, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setName, setPriority, setViolationMessage, toString, validate`

- Property Detail
  - boolean allowConstructorOnlyUsages
  - java.lang.String ignoreClassesAnnotatedWithNames
  - java.lang.String ignoreFieldNames
  - java.lang.String name
  - int priority
- Constructor Detail
  - UnusedPrivateFieldRule()
- Method Detail
  - @java.lang.Override protected AstVisitor getAstVisitor(SourceCode sourceCode)
  - @java.lang.Override protected java.util.List<Violation> getViolations(AstVisitor visitor, SourceCode sourceCode)
  - @java.lang.Override protected boolean shouldApplyThisRuleTo(ClassNode classNode)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation