com.puppycrawl.tools.checkstyle.checks.usage
Class OneMethodPrivateFieldCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
                  com.puppycrawl.tools.checkstyle.checks.usage.OneMethodPrivateFieldCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class OneMethodPrivateFieldCheck

extends AbstractUsageCheck

Checks that a private field is used in more than one method, constructor, or initializer.

Rationale: a private field used in only one method, constructor, or initializer should be replaced by a local variable.

An example of how to configure the check is:

 <module name="usage.OneMethodPrivateField"/>
 

Author:

Rick Giles

Constructor Summary

OneMethodPrivateFieldCheck()

Method Summary

void	applyTo(java.util.Set aNodes) Applies this check to a set of nodes.
int[]	getDefaultTokens() Returns the default token a check is interested in.
java.lang.String	getErrorKey() Returns the key for the Checkstyle error message.
boolean	mustCheckReferenceCount(DetailAST aAST) Determines whether the reference count of an aAST is required.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck

beginTree, finishTree, getASTManager, getIgnoreFormat, getRegexp, logError, setIgnoreFormat, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

destroy, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OneMethodPrivateFieldCheck

public OneMethodPrivateFieldCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

Check

getErrorKey

public java.lang.String getErrorKey()

Description copied from class: AbstractUsageCheck

Returns the key for the Checkstyle error message.

Specified by:

getErrorKey in class AbstractUsageCheck

Returns:

the key for the Checkstyle error message.

See Also:

AbstractUsageCheck

mustCheckReferenceCount

public boolean mustCheckReferenceCount(DetailAST aAST)

Description copied from class: AbstractUsageCheck

Determines whether the reference count of an aAST is required.

Specified by:

mustCheckReferenceCount in class AbstractUsageCheck

Parameters:

aAST - the node to check.

Returns:

true if the reference count of aAST is required.

See Also:

AbstractUsageCheck

applyTo

public void applyTo(java.util.Set aNodes)

Description copied from class: AbstractUsageCheck

Applies this check to a set of nodes.

Overrides:

applyTo in class AbstractUsageCheck

Parameters:

aNodes - the nodes to check.

See Also:

AbstractUsageCheck