Coverage Report - com.puppycrawl.tools.checkstyle.api.AuditListener
 
Classes in this File Line Coverage Branch Coverage Complexity
AuditListener
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.util.EventListener;
 23  
 
 24  
 /**
 25  
  * Listener in charge of receiving events from the Checker.
 26  
  * Typical events sequence is:
 27  
  * <pre>
 28  
  * auditStarted
 29  
  *   (fileStarted
 30  
  *     (addError)*
 31  
  *   fileFinished )*
 32  
  * auditFinished
 33  
  * </pre>
 34  
  * @author <a href="mailto:stephane.bailliez@wanadoo.fr">Stephane Bailliez</a>
 35  
  */
 36  
 public interface AuditListener
 37  
     extends EventListener {
 38  
     /**
 39  
      * Notify that the audit is about to start.
 40  
      * @param event the event details
 41  
      */
 42  
     void auditStarted(AuditEvent event);
 43  
 
 44  
     /**
 45  
      * Notify that the audit is finished.
 46  
      * @param event the event details
 47  
      */
 48  
     void auditFinished(AuditEvent event);
 49  
 
 50  
     /**
 51  
      * Notify that audit is about to start on a specific file.
 52  
      * @param event the event details
 53  
      */
 54  
     void fileStarted(AuditEvent event);
 55  
 
 56  
     /**
 57  
      * Notify that audit is finished on a specific file.
 58  
      * @param event the event details
 59  
      */
 60  
     void fileFinished(AuditEvent event);
 61  
 
 62  
     /**
 63  
      * Notify that an audit error was discovered on a specific file.
 64  
      * @param event the event details
 65  
      */
 66  
     void addError(AuditEvent event);
 67  
 
 68  
     /**
 69  
      * Notify that an exception happened while performing audit.
 70  
      * @param event the event details
 71  
      * @param throwable details of the exception
 72  
      */
 73  
     void addException(AuditEvent event, Throwable throwable);
 74  
 }