KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > codecoverage > v2 > module > DefaultAnalysisMetaData


1 /*
2  * @(#)DefaultAnalysisMetaData.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.module;
28
29 import net.sourceforge.groboutils.codecoverage.v2.IAnalysisMetaData;
30
31
32 /**
33  * Contains data necessary for storing the meta-data associated with a specific
34  * marked bytecode instruction.
35  * <P>
36  * There is an optional "weight" value which can associate a number from
37  * -128 to 127 for this particular instruction. This will create a weighted
38  * coverage value to indicate on each summary level how important it is
39  * for this particular bytecode to be executed. If the analysis module doesn't
40  * use weights, then this should return the same value for all instructions.
41  *
42  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
43  * @version $Date: 2003/02/10 22:51:28 $
44  * @since December 15, 2002
45  */
46 public class DefaultAnalysisMetaData implements IAnalysisMetaData
47 {
48     private String JavaDoc covered;
49     private String JavaDoc notCovered;
50     private byte weight;
51     
52     
53     public DefaultAnalysisMetaData( String JavaDoc c, String JavaDoc nc, byte w )
54     {
55         if (c == null || nc == null)
56         {
57             throw new IllegalArgumentException JavaDoc( "No null args." );
58         }
59         this.covered = c;
60         this.notCovered = nc;
61         this.weight = w;
62     }
63     
64     
65     /**
66      * Returns the formatted, localized text for a report on this instruction
67      * if it was covered during the runtime execution.
68      *
69      * @return formatted, localized, human-readable report
70      */
71     public String JavaDoc getCoveredFormattedText()
72     {
73         return this.covered;
74     }
75     
76     
77     /**
78      * Returns the formatted, localized text for a report on this instruction
79      * if it was <em>not</em> covered during the runtime execution.
80      *
81      * @return formatted, localized, human-readable report
82      */
83     public String JavaDoc getNotCoveredFormattedText()
84     {
85         return this.notCovered;
86     }
87     
88     
89     /**
90      * Returns any value in the range of a <tt>byte</tt> that assigns an
91      * importance "weight" to this instruction. If weights are not used
92      * by the analysis module, then this needs to return the same value
93      * for every instruction.
94      *
95      * @return an instruction weight value.
96      */
97     public byte getInstructionWeight()
98     {
99         return this.weight;
100     }
101 }
102
103
Popular Tags