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

java.lang.Object
  extended by com.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended by com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended by com.puppycrawl.tools.checkstyle.api.Check
              extended by com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck
                  extended by com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck
All Implemented Interfaces:
Configurable, Contextualizable

public final class ClassFanOutComplexityCheck
extends AbstractClassCouplingCheck

The number 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  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
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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()
Description copied from class: Check
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 String getLogMessageId()
Specified by:
getLogMessageId in class AbstractClassCouplingCheck
Returns:
message key we use for log violations.


Copyright © 2001-2012. All Rights Reserved.