Class AbstractClassCouplingCheck

    • Field Detail

      • DOT

        private static final java.lang.String DOT
        A package separator - "."
        See Also:
        Constant Field Values
      • DEFAULT_EXCLUDED_CLASSES

        private static final java.util.Set<java.lang.String> DEFAULT_EXCLUDED_CLASSES
        Class names to ignore.
      • DEFAULT_EXCLUDED_PACKAGES

        private static final java.util.Set<java.lang.String> DEFAULT_EXCLUDED_PACKAGES
        Package names to ignore.
      • excludeClassesRegexps

        private final java.util.List<java.util.regex.Pattern> excludeClassesRegexps
        User-configured regular expressions to ignore classes.
      • excludedClasses

        private java.util.Set<java.lang.String> excludedClasses
        User-configured class names to ignore.
      • excludedPackages

        private java.util.Set<java.lang.String> excludedPackages
        User-configured package names to ignore.
      • max

        private int max
        Allowed complexity.
    • Constructor Detail

      • AbstractClassCouplingCheck

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

      • getLogMessageId

        protected abstract java.lang.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:
        TokenTypes
      • getMax

        public final int getMax()
        Returns allowed complexity.
        Returns:
        allowed complexity.
      • setMax

        public final void setMax​(int max)
        Sets maximum allowed complexity.
        Parameters:
        max - allowed complexity.
      • setExcludedClasses

        public final void setExcludedClasses​(java.lang.String... excludedClasses)
        Sets user-excluded classes to ignore.
        Parameters:
        excludedClasses - the list of classes to ignore.
      • setExcludeClassesRegexps

        public void setExcludeClassesRegexps​(java.lang.String... from)
        Sets user-excluded regular expression of classes to ignore.
        Parameters:
        from - array representing regular expressions of classes to ignore.
      • setExcludedPackages

        public final void setExcludedPackages​(java.lang.String... excludedPackages)
        Sets user-excluded pakcages to ignore. All exlcuded 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
      • 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
      • visitPackageDef

        private void visitPackageDef​(DetailAST pkg)
        Stores package of current class we check.
        Parameters:
        pkg - package definition.
      • visitClassDef

        private void visitClassDef​(DetailAST classDef)
        Creates new context for a given class.
        Parameters:
        classDef - class definition node.
      • leaveClassDef

        private void leaveClassDef()
        Restores previous context.