KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * @(#)FunctionMeasure.java
3  *
4  * Copyright (C) 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
30 import net.sourceforge.groboutils.codecoverage.v2.IAnalysisMetaData;
31 import net.sourceforge.groboutils.codecoverage.v2.IAnalysisModule;
32 import net.sourceforge.groboutils.codecoverage.v2.IMethodCode;
33
34
35 /**
36  * Processes methods for function coverage analysis, which checks that each
37  * method/function has been invoked. Currently, this
38  * does not support localization.
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:26 $
42  * @since February 17, 2003
43  * @see IAnalysisMetaData
44  */
45 public class FunctionMeasure implements IAnalysisModule
46 {
47     /**
48      * Returns the human-readable name of the measure.
49      */
50     public String JavaDoc getMeasureName()
51     {
52         return "Function";
53     }
54     
55     /**
56      * Returns the unit name for this particular coverage measure.
57      */
58     public String JavaDoc getMeasureUnit()
59     {
60         return "functions";
61     }
62     
63     
64     /**
65      * Returns the text format used in meta-data formatted text. This should
66      * be the mime encoding type, such as "text/plain" or "text/html".
67      */
68     public String JavaDoc getMimeEncoding()
69     {
70         return "text/plain";
71     }
72     
73     
74     /**
75      * Perform the analysis on the method.
76      */
77     public void analyze( IMethodCode method )
78     {
79         IAnalysisMetaData amd = createAnalysisMetaData(
80             method.getClassName(), method.getMethodName() );
81         method.markInstruction( 0, amd );
82     }
83     
84     
85     private IAnalysisMetaData createAnalysisMetaData( String JavaDoc clazz,
86             String JavaDoc method )
87     {
88         return new DefaultAnalysisMetaData(
89             "Method "+method+" in class "+clazz,
90             "Didn't ever invoke method "+method+" in class "+clazz+".",
91             (byte)0 );
92     }
93 }
94
95
Popular Tags