1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 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.api;
21
22 import java.io.File;
23 import java.util.List;
24
25 /**
26 * The first module that is run as part of Checkstyle and controls its entire
27 * behavior and children.
28 */
29 public interface RootModule extends Configurable {
30
31 /** Cleans up the object. **/
32 void destroy();
33
34 /**
35 * Processes a set of files.
36 * Once this is done, it is highly recommended to call for
37 * the destroy method to close and remove the listeners.
38 *
39 * @param files the list of files to be audited.
40 * @return the total number of audit events with error severity found
41 * @throws CheckstyleException if error condition within Checkstyle occurs
42 * @see #destroy()
43 */
44 int process(List<File> files) throws CheckstyleException;
45
46 /**
47 * Add the listener that will be used to receive events from the audit.
48 *
49 * @param listener the nosy thing
50 */
51 void addListener(AuditListener listener);
52
53 /**
54 * Sets the classloader used to load Checkstyle core and custom module
55 * classes when the module tree is being built up.
56 * If no custom ModuleFactory is being set for the root module then
57 * this module classloader must be specified.
58 *
59 * @param moduleClassLoader the classloader used to load module classes
60 */
61 void setModuleClassLoader(ClassLoader moduleClassLoader);
62
63 }