com.puppycrawl.tools.checkstyle.checks.metrics

Class ClassDataAbstractionCouplingCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.metrics.AbstractClassCouplingCheck

com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class ClassDataAbstractionCouplingCheck
extends AbstractClassCouplingCheck

This metric measures the number of instantiations of other classes within the given class.

Author:

Simon Harris, o_sukhodolsky

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
ClassDataAbstractionCouplingCheck() Creates bew instance of the check.

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
protected String	getLogMessageId() Returns message key we use for log violations.
int[]	getRequiredTokens() The tokens that this check must be registered for.

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

beginTree, getDefaultTokens, leaveToken, setExcludeClassesRegexps, setExcludedClasses, setExcludedPackages, setMax, visitToken

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

clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens

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

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

ClassDataAbstractionCouplingCheck

public ClassDataAbstractionCouplingCheck()

Creates bew instance of the check.

Method Detail

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getLogMessageId

protected String getLogMessageId()

Description copied from class: AbstractClassCouplingCheck

Returns message key we use for log violations.

Specified by:

getLogMessageId in class AbstractClassCouplingCheck

Returns:

message key we use for log violations.