SingularFieldRule (PMD Java 7.1.0 API)

java.lang.Object
- net.sourceforge.pmd.properties.AbstractPropertySource
- - net.sourceforge.pmd.lang.rule.AbstractRule
  - - net.sourceforge.pmd.lang.java.rule.AbstractJavaRule
    - - net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule
      - net.sourceforge.pmd.lang.java.rule.design.SingularFieldRule

All Implemented Interfaces:

AstVisitor, JavaVisitor, Rule, PropertySource
```
public class SingularFieldRule
extends AbstractJavaRulechainRule
```
A singular field is a field that may be converted to a local variable. This means, that in every method the field is used, there is no path that uses the value that the field has before the method is called. In other words, the field is overwritten before any read.

Author:

Eric Olander, Wouter Zelle, Clément Fournier

Since:

Created on April 17, 2005, 9:49 PM

Field Summary
- Fields inherited from interface net.sourceforge.pmd.lang.rule.Rule
  VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors
Constructor Description

SingularFieldRule()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static boolean`	`mayBeSingular(ModifierOwner varId)`	Deprecated. This method will be removed.
`Object`	`visitJavaNode(JavaNode node, Object data)`

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule
buildTargetSelector

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRule
apply, visitNode

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule
addExample, asCtx, deepCopy, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getPriority, getPropertySourceType, getRuleClass, getRuleSetName, getSince, getTargetSelector, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, start

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource
definePropertyDescriptor, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.lang.ast.AstVisitor
cannotVisit

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaVisitor
visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource
definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from interface net.sourceforge.pmd.lang.rule.Rule
initialize

- Constructor Detail
  - SingularFieldRule
```
public SingularFieldRule()
```
- Method Detail
  - visitJavaNode
```
public Object visitJavaNode(JavaNode node,
                            Object data)
```
    Specified by:
    
    visitJavaNode in interface JavaVisitor
    
    Overrides:
    
    visitJavaNode in class AbstractJavaRulechainRule
  - mayBeSingular
```
@Deprecated
public static boolean mayBeSingular(ModifierOwner varId)
```
    Deprecated.
    This method will be removed. Don't use it.
    
    This method is only relevant for this rule. It will be removed in the future.