KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > mountainminds > eclemma > core > launching > ICoverageLaunchInfo


1 /*******************************************************************************
2  * Copyright (c) 2006 Mountainminds GmbH & Co. KG
3  * This software is provided under the terms of the Eclipse Public License v1.0
4  * See http://www.eclipse.org/legal/epl-v10.html.
5  *
6  * $Id: ICoverageLaunchInfo.java 399 2007-08-30 19:12:38Z mtnminds $
7  ******************************************************************************/
8 package com.mountainminds.eclemma.core.launching;
9
10 import org.eclipse.core.runtime.CoreException;
11 import org.eclipse.core.runtime.IPath;
12 import org.eclipse.core.runtime.IProgressMonitor;
13
14 import com.mountainminds.eclemma.core.IInstrumentation;
15
16 /**
17  * Descriptor how a particular launch was instrumented. To every launch in
18  * "Coverage" mode an instance is attached.
19  *
20  * @author Marc R. Hoffmann
21  * @version $Revision: 399 $
22  */
23 public interface ICoverageLaunchInfo {
24   
25   /**
26    * Returns the location of the coverage data file (<code>*.ec</code>) for this
27    * launch.
28    *
29    * @return absolute path of the coverage data file
30    */
31   public IPath getCoverageFile();
32
33   /**
34    * Instruments the selected class path entries.
35    *
36    * @param monitor monitor for progress feedback and cancelation
37    * @param inplace if <code>true</code>, class files will be directly modified
38    * @throws CoreException in case of internal inconsistencies
39    */
40   public void instrument(IProgressMonitor monitor, boolean inplace) throws CoreException;
41
42   /**
43    * Returns the list of locations with instrumented class path entries along
44    * with instumentation meta data.
45    *
46    * @return intrumentaion data for class path entries
47    */
48   public IInstrumentation[] getInstrumentations();
49   
50   /**
51    * Returns the instrumentation information for the class path with the given
52    * original path. If this class path entry has not been instrumented
53    * <code>null</code> is returned.
54    *
55    * @param originalpath original class path location
56    * @return instrumentation information or <code>null</code>
57    */
58   public IInstrumentation getInstrumentation(String JavaDoc originalpath);
59   
60   /**
61    * Return the absolute location of the JAR file that will be created to
62    * inject EMMA properties into the target application.
63    *
64    * @return absolute path of the EMMA properties JAR file
65    */
66   public IPath getPropertiesJARFile();
67   
68   /**
69    * Allow the implementation to perform internal cleanup when this info object
70    * is no longer required.
71    */
72   public void dispose();
73
74 }
75
Popular Tags