View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle;
21  
22  import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
23  
24  /**
25   * A module factory creates Objects from a given name.
26   * It's purpose is to map the short names like
27   * {@code AvoidStarImport} to full class names like
28   * {@code com.puppycrawl.tools.checkstyle.checks.AvoidStarImportCheck}.
29   * A ModuleFactory can implement this name resolution by using naming
30   * conventions, fallback strategies, etc.
31   *
32   * @author lkuehne
33   */
34  @FunctionalInterface
35  public interface ModuleFactory {
36      /**
37       * Creates a new instance of a class from a given name.
38       * If the provided module name is a class name an instance of that class
39       * is returned. If the name is not a class name the ModuleFactory uses
40       * heuristics to find the corresponding class.
41       *
42       * @param name the name of the module, might be a short name
43       * @return the created module
44       * @throws CheckstyleException if no module can be instantiated from name
45       */
46      Object createModule(String name) throws CheckstyleException;
47  }