org.xwiki.tool.checkstyle
Class XWikiClassFanOutComplexityCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              org.xwiki.tool.checkstyle.AbstractXWikiClassCouplingCheck
                  org.xwiki.tool.checkstyle.XWikiClassFanOutComplexityCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public final class XWikiClassFanOutComplexityCheck
extends AbstractXWikiClassCouplingCheck

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

Copied from the Checkstyle source (because it cannot be extended, see https://sourceforge.net/p/checkstyle/feature-requests/575/) to fix the following issues:

• https://sourceforge.net/p/checkstyle/feature-requests/607/
• https://sourceforge.net/p/checkstyle/bugs/684/

Since:

5.0M1

Version:

$Id: 59b04a55922b7c5e3a1c3e6e146c35b4892de703 $

Constructor Summary

XWikiClassFanOutComplexityCheck()
Creates new instance of this check.

Method Summary

protected String	getLogMessageId()
int[]	getRequiredTokens()

Methods inherited from class org.xwiki.tool.checkstyle.AbstractXWikiClassCouplingCheck

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

XWikiClassFanOutComplexityCheck

public XWikiClassFanOutComplexityCheck()

Creates new instance of this check.

Method Detail

getRequiredTokens

public int[] getRequiredTokens()

Overrides:

getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.Check

getLogMessageId

protected String getLogMessageId()

Specified by:

getLogMessageId in class AbstractXWikiClassCouplingCheck

Returns:

message key we use for log violations.