Coverage Report - com.puppycrawl.tools.checkstyle.api.RootModule
 
Classes in this File Line Coverage Branch Coverage Complexity
RootModule
N/A
N/A
1
 
 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.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  
  * @author Richard Veach
 29  
  */
 30  
 public interface RootModule extends Configurable {
 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  
      * @param files the list of files to be audited.
 39  
      * @return the total number of errors found
 40  
      * @throws CheckstyleException if error condition within Checkstyle occurs
 41  
      * @see #destroy()
 42  
      */
 43  
     int process(List<File> files) throws CheckstyleException;
 44  
 
 45  
     /**
 46  
      * Add the listener that will be used to receive events from the audit.
 47  
      * @param listener the nosy thing
 48  
      */
 49  
     void addListener(AuditListener listener);
 50  
 
 51  
     /**
 52  
      * Sets the classloader used to load Checkstyle core and custom module
 53  
      * classes when the module tree is being built up.
 54  
      * If no custom ModuleFactory is being set for the root module then
 55  
      * this module classloader must be specified.
 56  
      * @param moduleClassLoader the classloader used to load module classes
 57  
      */
 58  
     void setModuleClassLoader(ClassLoader moduleClassLoader);
 59  
 }