KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > codecoverage > v2 > IAnalysisMetaData


1 /*
2  * @(#)IAnalysisMetaData.java
3  *
4  * Copyright (C) 2002-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;
28
29
30 /**
31  * Contains data necessary for storing the meta-data associated with a specific
32  * marked bytecode instruction.
33  * <P>
34  * There is an optional "weight" value which can associate a number from
35  * -128 to 127 for this particular instruction. This will create a weighted
36  * coverage value to indicate on each summary level how important it is
37  * for this particular bytecode to be executed. If the analysis module doesn't
38  * use weights, then this should return the same value for all instructions.
39  *
40  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
41  * @version $Date: 2003/02/10 22:51:25 $
42  * @since December 15, 2002
43  */
44 public interface IAnalysisMetaData
45 {
46     /**
47      * Returns the formatted, localized text for a report on this instruction
48      * if it was covered during the runtime execution.
49      *
50      * @return formatted, localized, human-readable report
51      */
52     public String JavaDoc getCoveredFormattedText();
53     
54     
55     /**
56      * Returns the formatted, localized text for a report on this instruction
57      * if it was <em>not</em> covered during the runtime execution.
58      *
59      * @return formatted, localized, human-readable report
60      */
61     public String JavaDoc getNotCoveredFormattedText();
62     
63     
64     /**
65      * Returns any value in the range of a <tt>byte</tt> that assigns an
66      * importance "weight" to this instruction. If weights are not used
67      * by the analysis module, then this needs to return the same value
68      * for every instruction.
69      *
70      * @return an instruction weight value.
71      */
72     public byte getInstructionWeight();
73 }
74
75
Popular Tags