com.puppycrawl.tools.checkstyle.checks.metrics
Class ClassFanOutComplexityCheck

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.metrics.AbstractClassCouplingCheck
                  com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class ClassFanOutComplexityCheck

extends AbstractClassCouplingCheck

The # of other classes a given class relies on. Also the square of this has been shown to indicate the amount of maintenence required in functional programs (on a file basis) at least.

Author:

Simon Harris, o_sukhodolsky

Constructor Summary

ClassFanOutComplexityCheck()
Creates new instance of this check.

Method Summary

protected java.lang.String	getLogMessageId()
int[]	getRequiredTokens() The tokens that this check must be registered for.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck

beginTree, getDefaultTokens, getMax, leaveToken, setMax, visitToken

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

destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, 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

ClassFanOutComplexityCheck

public ClassFanOutComplexityCheck()

Creates new instance of this check.

Method Detail

getRequiredTokens

public int[] getRequiredTokens()

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getLogMessageId

protected java.lang.String getLogMessageId()

Specified by:

getLogMessageId in class AbstractClassCouplingCheck

Returns:

message key we use for log violations.