PackageObjectFactory.java

///////////////////////////////////////////////////////////////////////////////////////////////

// checkstyle: Checks Java source code and other text files for adherence to a set of rules.

// Copyright (C) 2001-2022 the original author or authors.

//

// This library is free software; you can redistribute it and/or

// modify it under the terms of the GNU Lesser General Public

// License as published by the Free Software Foundation; either

// version 2.1 of the License, or (at your option) any later version.

//

// This library is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

// Lesser General Public License for more details.

//

// You should have received a copy of the GNU Lesser General Public

// License along with this library; if not, write to the Free Software

// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

///////////////////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle;

import java.io.IOException;

import java.util.Collections;

import java.util.HashMap;

import java.util.LinkedHashSet;

import java.util.List;

import java.util.Map;

import java.util.Map.Entry;

import java.util.Set;

import java.util.stream.Collectors;

import java.util.stream.Stream;

import com.puppycrawl.tools.checkstyle.api.CheckstyleException;

import com.puppycrawl.tools.checkstyle.api.Violation;

import com.puppycrawl.tools.checkstyle.utils.ModuleReflectionUtil;

/**

 * A factory for creating objects from package names and names.

 * Consider the below example for better understanding.

 * <ul>

 *     <li>module name - name of java class that represents module;</li>

 *     <li>module full name - fully qualifies name of java class that represents module;</li>

 *     <li>check module short name - name of Check without 'Check' suffix;</li>

 *     <li>check module name - name of java class that represents Check (with 'Check' suffix);</li>

 *     <li>

 *         check module full name - fully qualifies name of java class

 *         that represents Check (with 'Check' suffix).

 *     </li>

 * </ul>

 */

public class PackageObjectFactory implements ModuleFactory {

    /**

     * Enum class to define loading options.

     */

        /**

         * Searching from registered checkstyle modules and from packages given in constructor.

         **/

        /**

         * As SEARCH_REGISTERED_PACKAGES and also try to load class from all of packages given in

         * constructor.

         * Required for eclipse-cs plugin.

         **/

    }

    /** Base package of checkstyle modules checks. */

    public static final String BASE_PACKAGE = "com.puppycrawl.tools.checkstyle";

    /** Exception message when it is unable to create a class instance. */

    public static final String UNABLE_TO_INSTANTIATE_EXCEPTION_MESSAGE =

            "PackageObjectFactory.unableToInstantiateExceptionMessage";

    /** Exception message when there is ambiguous module name in config file. */

    public static final String AMBIGUOUS_MODULE_NAME_EXCEPTION_MESSAGE =

            "PackageObjectFactory.ambiguousModuleNameExceptionMessage";

    /** Suffix of checks. */

    public static final String CHECK_SUFFIX = "Check";

    /** Character separate package names in qualified name of java class. */

    public static final String PACKAGE_SEPARATOR = ".";

    /** Exception message when null class loader is given. */

    public static final String NULL_LOADER_MESSAGE = "moduleClassLoader must not be null";

    /** Exception message when null package name is given. */

    public static final String NULL_PACKAGE_MESSAGE = "package name must not be null";

    /** Separator to use in strings. */

    public static final String STRING_SEPARATOR = ", ";

    /** Map of Checkstyle module names to their fully qualified names. */

    /** Package names to prepend to class names. */

    private final Set<String> packages;

    /** The class loader used to load Checkstyle core and custom modules. */

    private final ClassLoader moduleClassLoader;

    /** Map of third party Checkstyle module names to the set of their fully qualified names. */

    private Map<String, Set<String>> thirdPartyNameToFullModuleNames;

    /** Module load option which defines class search type. */

    private ModuleLoadOption moduleLoadOption;

    static {

    /**

     * Creates a new {@code PackageObjectFactory} instance.

     *

     * @param packageNames package names to use

     * @param moduleClassLoader class loader used to load Checkstyle

     *          core and custom modules

     */

    public PackageObjectFactory(Set<String> packageNames, ClassLoader moduleClassLoader) {

    /**

     * Creates a new {@code PackageObjectFactory} instance.

     *

     * @param packageNames package names to use

     * @param moduleClassLoader class loader used to load Checkstyle

     *          core and custom modules

     * @param moduleLoadOption loading option

     * @throws IllegalArgumentException if moduleClassLoader is null or packageNames contains null

     */

    public PackageObjectFactory(Set<String> packageNames, ClassLoader moduleClassLoader,

        }

        }

        // create a copy of the given set, but retain ordering

    /**

     * Creates a new {@code PackageObjectFactory} instance.

     *

     * @param packageName The package name to use

     * @param moduleClassLoader class loader used to load Checkstyle

     *          core and custom modules

     * @throws IllegalArgumentException if moduleClassLoader is null or packageNames is null

     */

        }

        }

    /**

     * Creates a new instance of a class from a given name, or that name

     * concatenated with "Check". If the name is

     * a class name, creates an instance of the named class. Otherwise, creates

     * an instance of a class name obtained by concatenating the given name

     * to a package name from a given list of package names.

     *

     * @param name the name of a class.

     * @return the {@code Object} created by loader.

     * @throws CheckstyleException if an error occurs.

     */

    @Override

    public Object createModule(String name) throws CheckstyleException {

        // if the name is a simple class name, try to find it in maps at first

            // find the name in third party map

                }

            }

        }

        }

                && moduleLoadOption == ModuleLoadOption.TRY_IN_ALL_REGISTERED_PACKAGES) {

        }

                        + STRING_SEPARATOR + nameCheck + STRING_SEPARATOR

            }

                Definitions.CHECKSTYLE_BUNDLE, UNABLE_TO_INSTANTIATE_EXCEPTION_MESSAGE,

        }

    }

    /**

     * Create object from one of Checkstyle module names.

     *

     * @param name name of module.

     * @return instance of module.

     * @throws CheckstyleException if the class fails to instantiate or there are ambiguous classes.

     */

    private Object createFromStandardCheckSet(String name) throws CheckstyleException {

            }

        else {

        }

    }

    /**

     * Create object with the help of the supplied map.

     *

     * @param name name of module.

     * @param map the supplied map.

     * @return instance of module if it is found in modules map and no ambiguous classes exist.

     * @throws CheckstyleException if the class fails to instantiate or there are ambiguous classes.

     */

    private Object createObjectFromMap(String name, Map<String, Set<String>> map)

            throws CheckstyleException {

            }

        else {

        }

    }

    /**

     * Create Object from optional full module names.

     * In most case, there should be only one element in {@code fullModuleName}, otherwise

     * an exception would be thrown.

     *

     * @param name name of module

     * @param fullModuleNames the supplied full module names set

     * @return instance of module if there is only one element in {@code fullModuleName}

     * @throws CheckstyleException if the class fails to instantiate or there are more than one

     *      element in {@code fullModuleName}

     */

    private Object createObjectFromFullModuleNames(String name, Set<String> fullModuleNames)

            throws CheckstyleException {

        final Object returnValue;

        }

        else {

                    Definitions.CHECKSTYLE_BUNDLE, AMBIGUOUS_MODULE_NAME_EXCEPTION_MESSAGE,

        }

    }

    /**

     * Generate the map of third party Checkstyle module names to the set of their fully qualified

     * names.

     *

     * @param loader the class loader used to load Checkstyle package names

     * @return the map of third party Checkstyle module names to the set of their fully qualified

     *      names

     */

    private Map<String, Set<String>> generateThirdPartyNameToFullModuleName(ClassLoader loader) {

        Map<String, Set<String>> returnValue;

        try {

        }

    }

    /**

     * Returns simple check name from full modules names map.

     *

     * @param fullName name of the class for joining.

     * @return simple check name.

     */

    public static String getShortFromFullModuleNames(String fullName) {

    }

    /**

     * Creates a string by joining package names with a class name.

     *

     * @param className name of the class for joining.

     * @param packages packages names.

     * @return a string which is obtained by joining package names with a class name.

     */

    private static String joinPackageNamesWithClassName(String className, Set<String> packages) {

                    PACKAGE_SEPARATOR + className));

    }

    /**

     * Creates a new instance of a named class.

     *

     * @param className the name of the class to instantiate.

     * @return the {@code Object} created by loader or null.

     * @throws CheckstyleException if the class fails to instantiate.

     */

    private Object createObject(String className) throws CheckstyleException {

        try {

        }

            // ignore the exception

            try {

            }

        }

    }

    /**

     * Searching to class with given name (or name concatenated with "Check") in existing

     * packages. Returns instance if class found or, otherwise, null.

     *

     * @param name the name of a class.

     * @return the {@code Object} created by loader.

     * @throws CheckstyleException if an error occurs.

     */

    private Object createModuleByTryInEachPackage(String name) throws CheckstyleException {

            }

    }

    /**

     * Fill short-to-full module names map.

     */

    private static void fillShortToFullModuleNamesMap() {

    /**

     * Fill short-to-full module names map with Checks from annotation package.

     */

    private static void fillChecksFromAnnotationPackage() {

                BASE_PACKAGE + ".checks.annotation.AnnotationLocationCheck");

                BASE_PACKAGE + ".checks.annotation.AnnotationOnSameLineCheck");

                BASE_PACKAGE + ".checks.annotation.AnnotationUseStyleCheck");

                BASE_PACKAGE + ".checks.annotation.MissingDeprecatedCheck");

                BASE_PACKAGE + ".checks.annotation.MissingOverrideCheck");

                BASE_PACKAGE + ".checks.annotation.PackageAnnotationCheck");

                BASE_PACKAGE + ".checks.annotation.SuppressWarningsCheck");

    /**

     * Fill short-to-full module names map with Checks from blocks package.

     */

    private static void fillChecksFromBlocksPackage() {

                BASE_PACKAGE + ".checks.blocks.AvoidNestedBlocksCheck");

                BASE_PACKAGE + ".checks.blocks.EmptyBlockCheck");

                BASE_PACKAGE + ".checks.blocks.EmptyCatchBlockCheck");

                BASE_PACKAGE + ".checks.blocks.LeftCurlyCheck");

                BASE_PACKAGE + ".checks.blocks.NeedBracesCheck");

                BASE_PACKAGE + ".checks.blocks.RightCurlyCheck");

    /**

     * Fill short-to-full module names map with Checks from coding package.

     */

    // -@cs[ExecutableStatementCount] splitting this method is not reasonable.

    // -@cs[JavaNCSS] splitting this method is not reasonable.

    private static void fillChecksFromCodingPackage() {

                BASE_PACKAGE + ".checks.coding.ArrayTrailingCommaCheck");

                BASE_PACKAGE + ".checks.coding.AvoidDoubleBraceInitializationCheck");

                BASE_PACKAGE + ".checks.coding.AvoidInlineConditionalsCheck");

                BASE_PACKAGE + ".checks.coding.AvoidNoArgumentSuperConstructorCallCheck");

                BASE_PACKAGE + ".checks.coding.CovariantEqualsCheck");

                BASE_PACKAGE + ".checks.coding.DeclarationOrderCheck");

                BASE_PACKAGE + ".checks.coding.DefaultComesLastCheck");

                BASE_PACKAGE + ".checks.coding.EmptyStatementCheck");

                BASE_PACKAGE + ".checks.coding.EqualsAvoidNullCheck");

                BASE_PACKAGE + ".checks.coding.EqualsHashCodeCheck");

                BASE_PACKAGE + ".checks.coding.ExplicitInitializationCheck");

                BASE_PACKAGE + ".checks.coding.FallThroughCheck");

                BASE_PACKAGE + ".checks.coding.FinalLocalVariableCheck");

                BASE_PACKAGE + ".checks.coding.HiddenFieldCheck");

                BASE_PACKAGE + ".checks.coding.IllegalCatchCheck");

                BASE_PACKAGE + ".checks.coding.IllegalInstantiationCheck");

                BASE_PACKAGE + ".checks.coding.IllegalThrowsCheck");

                BASE_PACKAGE + ".checks.coding.IllegalTokenCheck");

                BASE_PACKAGE + ".checks.coding.IllegalTokenTextCheck");

                BASE_PACKAGE + ".checks.coding.IllegalTypeCheck");

                BASE_PACKAGE + ".checks.coding.InnerAssignmentCheck");

                BASE_PACKAGE + ".checks.coding.MagicNumberCheck");

                BASE_PACKAGE + ".checks.coding.MissingCtorCheck");

                BASE_PACKAGE + ".checks.coding.MissingSwitchDefaultCheck");

                BASE_PACKAGE + ".checks.coding.ModifiedControlVariableCheck");

                BASE_PACKAGE + ".checks.coding.MultipleStringLiteralsCheck");

                BASE_PACKAGE + ".checks.coding.MultipleVariableDeclarationsCheck");

                BASE_PACKAGE + ".checks.coding.NestedForDepthCheck");

                BASE_PACKAGE + ".checks.coding.NestedIfDepthCheck");

                BASE_PACKAGE + ".checks.coding.NestedTryDepthCheck");

                BASE_PACKAGE + ".checks.coding.NoCloneCheck");

                BASE_PACKAGE + ".checks.coding.NoEnumTrailingCommaCheck");

                BASE_PACKAGE + ".checks.coding.NoFinalizerCheck");

                BASE_PACKAGE + ".checks.coding.OneStatementPerLineCheck");

                BASE_PACKAGE + ".checks.coding.OverloadMethodsDeclarationOrderCheck");

                BASE_PACKAGE + ".checks.coding.PackageDeclarationCheck");

                BASE_PACKAGE + ".checks.coding.ParameterAssignmentCheck");

                BASE_PACKAGE + ".checks.coding.RequireThisCheck");

                BASE_PACKAGE + ".checks.coding.ReturnCountCheck");

                BASE_PACKAGE + ".checks.coding.SimplifyBooleanExpressionCheck");

                BASE_PACKAGE + ".checks.coding.SimplifyBooleanReturnCheck");

                BASE_PACKAGE + ".checks.coding.StringLiteralEqualityCheck");

                BASE_PACKAGE + ".checks.coding.SuperCloneCheck");

                BASE_PACKAGE + ".checks.coding.SuperFinalizeCheck");

                BASE_PACKAGE + ".checks.coding.UnnecessaryParenthesesCheck");

                BASE_PACKAGE

                        + ".checks.coding.UnnecessarySemicolonAfterOuterTypeDeclarationCheck");

                BASE_PACKAGE

                    + ".checks.coding.UnnecessarySemicolonAfterTypeMemberDeclarationCheck");

                BASE_PACKAGE + ".checks.coding.UnnecessarySemicolonInEnumerationCheck");

                BASE_PACKAGE + ".checks.coding.UnnecessarySemicolonInTryWithResourcesCheck");

                BASE_PACKAGE + ".checks.coding.VariableDeclarationUsageDistanceCheck");

                BASE_PACKAGE + ".checks.coding.NoArrayTrailingCommaCheck");

                BASE_PACKAGE + ".checks.coding.MatchXpathCheck");

                BASE_PACKAGE + ".checks.coding.UnusedLocalVariableCheck");

    /**

     * Fill short-to-full module names map with Checks from design package.

     */

    private static void fillChecksFromDesignPackage() {

                BASE_PACKAGE + ".checks.design.DesignForExtensionCheck");

                BASE_PACKAGE + ".checks.design.FinalClassCheck");

                BASE_PACKAGE + ".checks.design.HideUtilityClassConstructorCheck");

                BASE_PACKAGE + ".checks.design.InnerTypeLastCheck");

                BASE_PACKAGE + ".checks.design.InterfaceIsTypeCheck");

                BASE_PACKAGE + ".checks.design.MutableExceptionCheck");

                BASE_PACKAGE + ".checks.design.OneTopLevelClassCheck");

                BASE_PACKAGE + ".checks.design.ThrowsCountCheck");

                BASE_PACKAGE + ".checks.design.VisibilityModifierCheck");

    /**

     * Fill short-to-full module names map with Checks from header package.

     */

    private static void fillChecksFromHeaderPackage() {

                BASE_PACKAGE + ".checks.header.HeaderCheck");

                BASE_PACKAGE + ".checks.header.RegexpHeaderCheck");

    /**

     * Fill short-to-full module names map with Checks from imports package.

     */

    private static void fillChecksFromImportsPackage() {

                BASE_PACKAGE + ".checks.imports.AvoidStarImportCheck");

                BASE_PACKAGE + ".checks.imports.AvoidStaticImportCheck");

                BASE_PACKAGE + ".checks.imports.CustomImportOrderCheck");

                BASE_PACKAGE + ".checks.imports.IllegalImportCheck");

                BASE_PACKAGE + ".checks.imports.ImportControlCheck");

                BASE_PACKAGE + ".checks.imports.ImportOrderCheck");

                BASE_PACKAGE + ".checks.imports.RedundantImportCheck");

                BASE_PACKAGE + ".checks.imports.UnusedImportsCheck");

    /**

     * Fill short-to-full module names map with Checks from indentation package.

     */

    private static void fillChecksFromIndentationPackage() {

                BASE_PACKAGE + ".checks.indentation.CommentsIndentationCheck");

                BASE_PACKAGE + ".checks.indentation.IndentationCheck");

    /**

     * Fill short-to-full module names map with Checks from javadoc package.

     */

    private static void fillChecksFromJavadocPackage() {

                BASE_PACKAGE + ".checks.javadoc.AtclauseOrderCheck");

                BASE_PACKAGE + ".checks.javadoc.InvalidJavadocPositionCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocBlockTagLocationCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocContentLocationCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocMethodCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocMissingLeadingAsteriskCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocPackageCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocParagraphCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocStyleCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocTagContinuationIndentationCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocTypeCheck");

                BASE_PACKAGE + ".checks.javadoc.JavadocVariableCheck");

                BASE_PACKAGE + ".checks.javadoc.MissingJavadocMethodCheck");

                BASE_PACKAGE + ".checks.javadoc.MissingJavadocPackageCheck");

                BASE_PACKAGE + ".checks.javadoc.MissingJavadocTypeCheck");

                BASE_PACKAGE + ".checks.javadoc.NonEmptyAtclauseDescriptionCheck");

                BASE_PACKAGE + ".checks.javadoc.RequireEmptyLineBeforeBlockTagGroupCheck");

                BASE_PACKAGE + ".checks.javadoc.SingleLineJavadocCheck");

                BASE_PACKAGE + ".checks.javadoc.SummaryJavadocCheck");

                BASE_PACKAGE + ".checks.javadoc.WriteTagCheck");

    /**

     * Fill short-to-full module names map with Checks from metrics package.

     */

    private static void fillChecksFromMetricsPackage() {

                BASE_PACKAGE + ".checks.metrics.BooleanExpressionComplexityCheck");

                BASE_PACKAGE + ".checks.metrics.ClassDataAbstractionCouplingCheck");

                BASE_PACKAGE + ".checks.metrics.ClassFanOutComplexityCheck");

                BASE_PACKAGE + ".checks.metrics.CyclomaticComplexityCheck");

                BASE_PACKAGE + ".checks.metrics.JavaNCSSCheck");

                BASE_PACKAGE + ".checks.metrics.NPathComplexityCheck");

    /**

     * Fill short-to-full module names map with Checks from modifier package.

     */

    private static void fillChecksFromModifierPackage() {

            BASE_PACKAGE + ".checks.modifier.ClassMemberImpliedModifierCheck");

            BASE_PACKAGE + ".checks.modifier.InterfaceMemberImpliedModifierCheck");

                BASE_PACKAGE + ".checks.modifier.ModifierOrderCheck");

                BASE_PACKAGE + ".checks.modifier.RedundantModifierCheck");

    /**

     * Fill short-to-full module names map with Checks from naming package.

     */

    private static void fillChecksFromNamingPackage() {

                BASE_PACKAGE + ".checks.naming.AbbreviationAsWordInNameCheck");

                BASE_PACKAGE + ".checks.naming.AbstractClassNameCheck");

                BASE_PACKAGE + ".checks.naming.CatchParameterNameCheck");

                BASE_PACKAGE + ".checks.naming.ClassTypeParameterNameCheck");

                BASE_PACKAGE + ".checks.naming.ConstantNameCheck");

                BASE_PACKAGE + ".checks.naming.InterfaceTypeParameterNameCheck");

                BASE_PACKAGE + ".checks.naming.LambdaParameterNameCheck");

                BASE_PACKAGE + ".checks.naming.LocalFinalVariableNameCheck");

                BASE_PACKAGE + ".checks.naming.LocalVariableNameCheck");

                BASE_PACKAGE + ".checks.naming.MemberNameCheck");

                BASE_PACKAGE + ".checks.naming.MethodNameCheck");

                BASE_PACKAGE + ".checks.naming.MethodTypeParameterNameCheck");

                BASE_PACKAGE + ".checks.naming.PackageNameCheck");

                BASE_PACKAGE + ".checks.naming.ParameterNameCheck");