01: /*
02: * @(#)IReportStyle.java
03: *
04: * Copyright (C) 2003 Matt Albrecht
05: * groboclown@users.sourceforge.net
06: * http://groboutils.sourceforge.net
07: *
08: * Permission is hereby granted, free of charge, to any person obtaining a
09: * 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: * Describes a report style, used to generate readable reports from the
38: * XML output.
39: *
40: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
41: * @version $Date: 2004/04/15 05:48:25 $
42: * @since November 22, 2003
43: */
44: public interface IReportStyle {
45: /**
46: * @param doc the XML document of the coverage report to process.
47: */
48: public void generateReport(Project project, Document doc,
49: String moduleName) throws BuildException, IOException;
50:
51: /**
52: * Called when the task is finished generating all the reports. This
53: * may be useful for styles that join all the reports together.
54: */
55: public void reportComplete(Project project, Vector errors)
56: throws BuildException, IOException;
57: }
|