IReportStyle


1   /*
2    * @(#)IReportStyle.java
3    *
4    * Copyright (C) 2003 Matt Albrecht
5    * groboclown@users.sourceforge.net
6    * http://groboutils.sourceforge.net
7    *
8    *  Permission is hereby granted, free of charge, to any person obtaining a
9    *  copy of this software and associated documentation files (the "Software"),
10   *  to deal in the Software without restriction, including without limitation
11   *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
12   *  and/or sell copies of the Software, and to permit persons to whom the 
13   *  Software is furnished to do so, subject to the following conditions:
14   *
15   *  The above copyright notice and this permission notice shall be included in 
16   *  all copies or substantial portions of the Software. 
17   *
18   *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
19   *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
20   *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL 
21   *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
22   *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
23   *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
24   *  DEALINGS IN THE SOFTWARE.
25   */
26  
27  package net.sourceforge.groboutils.codecoverage.v2.ant;
28  
29  import java.io.IOException  ;
30  import java.util.Vector  ;
31  
32  import org.apache.tools.ant.BuildException;
33  import org.apache.tools.ant.Project;
34  import org.w3c.dom.Document  ;
35  
36  
37  /**
38   * Describes a report style, used to generate readable reports from the
39   * XML output.
40   *
41   * @author    Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
42   * @version   $Date: 2004/04/15 05:48:25 $
43   * @since     November 22, 2003
44   */
45  public interface IReportStyle
46  {
47      /**
48       * @param doc the XML document of the coverage report to process.
49       */
50      public void generateReport( Project project, Document   doc,
51              String   moduleName )
52              throws BuildException, IOException  ;
53      
54      /**
55       * Called when the task is finished generating all the reports.  This
56       * may be useful for styles that join all the reports together.
57       */
58      public void reportComplete( Project project, Vector   errors )
59              throws BuildException, IOException  ;
60  }
61  
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags