KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * @(#)IMethodCode.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 import org.apache.bcel.classfile.LineNumberTable;
30 import org.apache.bcel.classfile.Method;
31 import org.apache.bcel.generic.Instruction;
32
33
34 /**
35  * Contains the BCEL bytecode for a method, and provides helper methods for
36  * generating the marks for certain bytecode instructions.
37  *
38  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
39  * @version $Date: 2004/04/15 05:48:25 $
40  * @since December 15, 2002
41  */
42 public interface IMethodCode
43 {
44     /**
45      * Returns the original BCEL Method object.
46      *
47      * @return the original BCEL Method object
48      */
49     public Method getOriginalMethod();
50     
51     
52     /**
53      * Returns the line number table for the original BCEL method object.
54      *
55      * @return the LineNumberTable, or <tt>null</tt> if there isn't one
56      * for this method.
57      */
58     public LineNumberTable getLineNumberTable();
59     
60     
61     /**
62      * A helper to get the method name.
63      *
64      * @return the method name
65      */
66     public String JavaDoc getMethodName();
67     
68     
69     /**
70      * A helper to get the class name.
71      *
72      * @return the class name
73      */
74     public String JavaDoc getClassName();
75     
76     
77     /**
78      * Returns the number of bytecode instructions in the method.
79      *
80      * @return the number of bytecode instructions
81      */
82     public int getInstructionCount();
83     
84     
85     /**
86      * Returns the bytecode instruction at the given index. If the index
87      * is out of range (&lt; 0 or &gt;= <tt>getInstructionCount()</tt>),
88      * then a <tt>IndexOutOfBoundsException</tt> is thrown.
89      *
90      * @param index the 0-based index of the method's instruction list
91      * @return the instruction at <tt>index</tt>
92      */
93     public Instruction getInstructionAt( int index );
94     
95     
96     /**
97      * Marks an instruction for coverage analysis. If the index
98      * is out of range (&lt; 0 or &gt;= <tt>getInstructionCount()</tt>),
99      * then a <tt>IndexOutOfBoundsException</tt> is thrown.
100      *
101      * @param index the 0-based index of the method's instruction list
102      * @param meta meta-data the analysis module records in association with
103      * the mark. This cannot be <tt>null</tt>.
104      * @exception IllegalArgumentException if <tt>meta</tt> is <tt>null</tt>.
105      * @exception IndexOutOfBoundsException if <tt>index</tt> is not within
106      * the valid range.
107      */
108     public void markInstruction( int index, IAnalysisMetaData meta );
109 }
110
111
Popular Tags