01: /*
02: * @(#)IAnalysisModule.java
03: *
04: * Copyright (C) 2002-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;
28:
29: /**
30: * Processes a method for coverage analysis. The analysis should mark
31: * certain bytecode instructions with <tt>IAnalysisMetaData</tt> for
32: * report generation. Each module generates data that is used for one
33: * specific measure type, such as source line coverage, or branch coverage.
34: * The coverage amount is based on the number of marks added verses the
35: * number of marks (and which ones) encountered during a run.
36: *
37: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
38: * @version $Date: 2003/02/10 22:51:25 $
39: * @since December 15, 2002
40: * @see IAnalysisMetaData
41: */
42: public interface IAnalysisModule {
43: /**
44: * Returns the human-readable name of the measure.
45: */
46: public String getMeasureName();
47:
48: /**
49: * Returns the unit name for this particular coverage measure.
50: */
51: public String getMeasureUnit();
52:
53: /**
54: * Returns the text format used in meta-data formatted text. This should
55: * be the mime encoding type, such as "text/plain" or "text/html".
56: */
57: public String getMimeEncoding();
58:
59: /**
60: * Perform the analysis on the method. <tt>method</tt> should never
61: * be <tt>null</tt>, so null checking isn't necessary;
62: * <tt>NullPointerException</tt>s are an acceptable exception to be
63: * thrown from this method.
64: */
65: public void analyze(IMethodCode method);
66: }
|