001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle;
021
022import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
023
024/**
025 * A module factory creates Objects from a given name.
026 * Its purpose is to map the short names like
027 * {@code AvoidStarImport} to full class names like
028 * {@code com.puppycrawl.tools.checkstyle.checks.AvoidStarImportCheck}.
029 * A ModuleFactory can implement this name resolution by using naming
030 * conventions, fallback strategies, etc.
031 *
032 */
033@FunctionalInterface
034public interface ModuleFactory {
035
036    /**
037     * Creates a new instance of a class from a given name.
038     * If the provided module name is a class name an instance of that class
039     * is returned. If the name is not a class name the ModuleFactory uses
040     * heuristics to find the corresponding class.
041     *
042     * @param name the name of the module, might be a short name
043     * @return the created module
044     * @throws CheckstyleException if no module can be instantiated from name
045     */
046    Object createModule(String name) throws CheckstyleException;
047
048}