Package com.puppycrawl.tools.checkstyle.checks.metrics

Class AbstractClassCouplingCheck

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
All Implemented Interfaces:
Configurable, Contextualizable
Direct Known Subclasses:
ClassDataAbstractionCouplingCheck, ClassFanOutComplexityCheck
public abstract class AbstractClassCouplingCheck extends AbstractCheck
Base class for coupling calculation.

  • Constructor Details

    • AbstractClassCouplingCheck

      protected AbstractClassCouplingCheck(int defaultMax)
      Creates new instance of the check.
      Parameters:
      defaultMax - default value for allowed complexity.

  • Method Details

    • getLogMessageId

      protected abstract String getLogMessageId()
      Returns message key we use for log violations.
      Returns:
      message key we use for log violations.

    • getDefaultTokens

      public final int[] getDefaultTokens()
      Description copied from class: AbstractCheck
      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 AbstractCheck
      Returns:
      the default tokens
      See Also:

    • setMax

      public final void setMax(int max)
      Setter to specify the maximum threshold allowed.
      Parameters:
      max - allowed complexity.

    • setExcludedClasses

      public final void setExcludedClasses(String... excludedClasses)
      Setter to specify user-configured class names to ignore.
      Parameters:
      excludedClasses - the list of classes to ignore.

    • setExcludeClassesRegexps

      public void setExcludeClassesRegexps(String... from)
      Setter to specify user-configured regular expressions to ignore classes.
      Parameters:
      from - array representing regular expressions of classes to ignore.

    • setExcludedPackages

      public final void setExcludedPackages(String... excludedPackages)
      Setter to specify user-configured packages to ignore. All excluded packages should end with a period, so it also appends a dot to a package name.
      Parameters:
      excludedPackages - the list of packages to ignore.

    • beginTree

      public final void beginTree(DetailAST ast)
      Description copied from class: AbstractCheck
      Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
      Overrides:
      beginTree in class AbstractCheck
      Parameters:
      ast - the root of the tree

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process

    • leaveToken

      public void leaveToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called after all the child nodes have been process.
      Overrides:
      leaveToken in class AbstractCheck
      Parameters:
      ast - the token leaving