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