Coverage Report - org.apache.maven.plugin.checkstyle.CheckstyleReportListener
 
Classes in this File Line Coverage Branch Coverage Complexity
CheckstyleReportListener
78%
37/47
91%
11/12
1,438
 
 1  
 package org.apache.maven.plugin.checkstyle;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one
 5  
  * or more contributor license agreements.  See the NOTICE file
 6  
  * distributed with this work for additional information
 7  
  * regarding copyright ownership.  The ASF licenses this file
 8  
  * to you under the Apache License, Version 2.0 (the
 9  
  * "License"); you may not use this file except in compliance
 10  
  * with the License.  You may obtain a copy of the License at
 11  
  *
 12  
  *   http://www.apache.org/licenses/LICENSE-2.0
 13  
  *
 14  
  * Unless required by applicable law or agreed to in writing,
 15  
  * software distributed under the License is distributed on an
 16  
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 17  
  * KIND, either express or implied.  See the License for the
 18  
  * specific language governing permissions and limitations
 19  
  * under the License.
 20  
  */
 21  
 
 22  
 import com.puppycrawl.tools.checkstyle.api.AuditEvent;
 23  
 import com.puppycrawl.tools.checkstyle.api.AuditListener;
 24  
 import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
 25  
 import com.puppycrawl.tools.checkstyle.api.Configuration;
 26  
 import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
 27  
 
 28  
 import org.codehaus.plexus.util.StringUtils;
 29  
 
 30  
 import java.io.File;
 31  
 import java.util.ArrayList;
 32  
 import java.util.List;
 33  
 
 34  
 /**
 35  
  * Listener in charge of receiving events from the Checker.
 36  
  *
 37  
  * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
 38  
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
 39  
  * @version $Id: org.apache.maven.plugin.checkstyle.CheckstyleReportListener.html 816673 2012-05-08 14:06:16Z hboutemy $
 40  
  */
 41  
 public class CheckstyleReportListener
 42  
     extends AutomaticBean
 43  
     implements AuditListener
 44  
 {
 45  
     private List<File> sourceDirectories;
 46  
 
 47  
     private CheckstyleResults results;
 48  
 
 49  
     private String currentFile;
 50  
 
 51  
     private List<AuditEvent> events;
 52  
 
 53  
     private SeverityLevel severityLevel;
 54  
 
 55  
     private Configuration checkstyleConfiguration;
 56  
 
 57  
     /**
 58  
      * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
 59  
      */
 60  
     public CheckstyleReportListener( File sourceDirectory )
 61  8
     {
 62  8
         this.sourceDirectories = new ArrayList<File>();
 63  8
         this.sourceDirectories.add( sourceDirectory );
 64  8
     }
 65  
     /**
 66  
      * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
 67  
      * @param configuration checkstyle configuration
 68  
      * @since 2.5
 69  
      */
 70  
     public CheckstyleReportListener( File sourceDirectory, Configuration configuration )
 71  0
     {
 72  0
         this.sourceDirectories = new ArrayList<File>();
 73  0
         this.sourceDirectories.add( sourceDirectory );
 74  0
         this.checkstyleConfiguration = configuration;
 75  0
     }
 76  
 
 77  
     /**
 78  
      * @param configuration checkstyle configuration
 79  
      * @since 2.5
 80  
      */
 81  
     public CheckstyleReportListener( Configuration configuration )
 82  17
     {
 83  17
         this.sourceDirectories = new ArrayList<File>();
 84  17
         this.checkstyleConfiguration = configuration;
 85  17
     }
 86  
 
 87  
     /**
 88  
      * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
 89  
      */
 90  
     public void addSourceDirectory( File sourceDirectory )
 91  
     {
 92  21
         this.sourceDirectories.add( sourceDirectory );
 93  21
     }
 94  
 
 95  
     /**
 96  
      * @param severityLevel
 97  
      */
 98  
     public void setSeverityLevelFilter( SeverityLevel severityLevel )
 99  
     {
 100  8
         this.severityLevel = severityLevel;
 101  8
     }
 102  
 
 103  
     /**
 104  
      * @return
 105  
      */
 106  
     public SeverityLevel getSeverityLevelFilter()
 107  
     {
 108  8
         return severityLevel;
 109  
     }
 110  
 
 111  
     /** {@inheritDoc} */
 112  
     public void auditStarted( AuditEvent event )
 113  
     {
 114  25
         setResults( new CheckstyleResults() );
 115  25
     }
 116  
 
 117  
     /** {@inheritDoc} */
 118  
     public void auditFinished( AuditEvent event )
 119  
     {
 120  
         //do nothing
 121  25
     }
 122  
 
 123  
     /** {@inheritDoc} */
 124  
     public void fileStarted( AuditEvent event )
 125  
     {
 126  49
         final String fileName = StringUtils.replace( event.getFileName(), "\\", "/" );
 127  
 
 128  49
         for ( File sourceDirectory : sourceDirectories )
 129  
         {
 130  65
             String sourceDirectoryPath = StringUtils.replace( sourceDirectory.getPath(), "\\", "/" );
 131  
             
 132  65
             if ( fileName.startsWith( sourceDirectoryPath + "/" ) )
 133  
             {
 134  49
                 currentFile = StringUtils.substring( fileName, sourceDirectoryPath.length() + 1 );
 135  
 
 136  49
                 events = getResults().getFileViolations( currentFile );
 137  
             }
 138  65
         }
 139  
 
 140  49
         if ( events == null )
 141  
         {
 142  0
             events = new ArrayList<AuditEvent>();
 143  
         }
 144  49
     }
 145  
 
 146  
     /** {@inheritDoc} */
 147  
     public void fileFinished( AuditEvent event )
 148  
     {
 149  49
         getResults().setFileViolations( currentFile, events );
 150  49
         currentFile = null;
 151  49
     }
 152  
 
 153  
     /** {@inheritDoc} */
 154  
     public void addError( AuditEvent event )
 155  
     {
 156  169
         if ( SeverityLevel.IGNORE.equals( event.getSeverityLevel() ) )
 157  
         {
 158  32
             return;
 159  
         }
 160  
 
 161  137
         if ( severityLevel == null || severityLevel.equals( event.getSeverityLevel() ) )
 162  
         {
 163  101
             events.add( event );
 164  
         }
 165  137
     }
 166  
 
 167  
     /** {@inheritDoc} */
 168  
     public void addException( AuditEvent event, Throwable throwable )
 169  
     {
 170  
         //Do Nothing
 171  0
     }
 172  
 
 173  
     /**
 174  
      * @return
 175  
      */
 176  
     public CheckstyleResults getResults()
 177  
     {
 178  122
         results.setConfiguration( checkstyleConfiguration );
 179  122
         return results;
 180  
     }
 181  
 
 182  
     /**
 183  
      * @param results
 184  
      */
 185  
     public void setResults( CheckstyleResults results )
 186  
     {
 187  25
         this.results = results;
 188  25
     }
 189  
 
 190  
     /**
 191  
      * @since 2.5
 192  
      */
 193  
     public Configuration getCheckstyleConfiguration()
 194  
     {
 195  0
         return checkstyleConfiguration;
 196  
     }
 197  
 
 198  
     /**
 199  
      * @since 2.5
 200  
      */
 201  
     public void setCheckstyleConfiguration( Configuration checkstyleConfiguration )
 202  
     {
 203  0
         this.checkstyleConfiguration = checkstyleConfiguration;
 204  0
     }
 205  
 
 206  
 }
 207