View Javadoc

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.SeverityLevel;
26  import org.codehaus.plexus.util.StringUtils;
27  
28  import java.io.File;
29  import java.util.ArrayList;
30  import java.util.Iterator;
31  import java.util.List;
32  
33  /**
34   * Listener in charge of receiving events from the Checker.
35   *
36   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
37   * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
38   * @version $Id: CheckstyleReportListener.html 816654 2012-05-08 13:54:20Z hboutemy $
39   */
40  public class CheckstyleReportListener
41      extends AutomaticBean
42      implements AuditListener
43  {
44      private List sourceDirectories;
45  
46      private CheckstyleResults results;
47  
48      private String currentFile;
49  
50      private List events;
51  
52      private SeverityLevel severityLevel;
53  
54      /**
55       * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
56       */
57      public CheckstyleReportListener( File sourceDirectory )
58      {
59          this.sourceDirectories = new ArrayList();
60          this.sourceDirectories.add( sourceDirectory );
61      }
62  
63      /**
64       * @param sourceDirectory assume that is <code>sourceDirectory</code> is a not null directory and exists
65       */
66      public void addSourceDirectory( File sourceDirectory )
67      {
68          this.sourceDirectories.add( sourceDirectory );
69      }
70  
71      /**
72       * @param severityLevel
73       */
74      public void setSeverityLevelFilter( SeverityLevel severityLevel )
75      {
76          this.severityLevel = severityLevel;
77      }
78  
79      /**
80       * @return
81       */
82      public SeverityLevel getSeverityLevelFilter()
83      {
84          return severityLevel;
85      }
86  
87      /** {@inheritDoc} */
88      public void auditStarted( AuditEvent event )
89      {
90          setResults( new CheckstyleResults() );
91      }
92  
93      /** {@inheritDoc} */
94      public void auditFinished( AuditEvent event )
95      {
96          //do nothing
97      }
98  
99      /** {@inheritDoc} */
100     public void fileStarted( AuditEvent event )
101     {
102         for ( Iterator it = sourceDirectories.iterator(); it.hasNext(); )
103         {
104             File sourceDirectory = (File) it.next();
105 
106             currentFile = StringUtils.substring( event.getFileName(), sourceDirectory.getPath().length() + 1 );
107             currentFile = StringUtils.replace( currentFile, "\\", "/" );
108 
109             events = getResults().getFileViolations( currentFile );
110         }
111 
112         if ( events == null )
113         {
114             events = new ArrayList();
115         }
116     }
117 
118     /** {@inheritDoc} */
119     public void fileFinished( AuditEvent event )
120     {
121         getResults().setFileViolations( currentFile, events );
122         currentFile = null;
123     }
124 
125     /** {@inheritDoc} */
126     public void addError( AuditEvent event )
127     {
128         if ( SeverityLevel.IGNORE.equals( event.getSeverityLevel() ) )
129         {
130             return;
131         }
132 
133         if ( severityLevel == null || severityLevel.equals( event.getSeverityLevel() ) )
134         {
135             events.add( event );
136         }
137     }
138 
139     /** {@inheritDoc} */
140     public void addException( AuditEvent event, Throwable throwable )
141     {
142         //Do Nothing
143     }
144 
145     /**
146      * @return
147      */
148     public CheckstyleResults getResults()
149     {
150         return results;
151     }
152 
153     /**
154      * @param results
155      */
156     public void setResults( CheckstyleResults results )
157     {
158         this.results = results;
159     }
160 }
161