KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > mountainminds > eclemma > core > IInstrumentation


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: IInstrumentation.java 11 2006-08-28 20:06:31Z mho $
7  ******************************************************************************/
8 package com.mountainminds.eclemma.core;
9
10 import org.eclipse.core.runtime.IPath;
11 import org.eclipse.core.runtime.IProgressMonitor;
12
13 /**
14  * Instances of {@link IInstrumentation} describe a set of instrumented Java
15  * classes. This interface is not intended to be implemented by clients,
16  * instances are returned by
17  * {@link IClassFiles#instrument(boolean, IProgressMonitor)}.
18  *
19  * @author Marc R. Hoffmann
20  * @version $Revision: 11 $
21  */
22 public interface IInstrumentation {
23
24   /**
25    * Returns the {@link IClassFiles} object that describe the source of this
26    * instrumentation.
27    *
28    * @return {@link IClassFiles} object
29    */
30   public IClassFiles getClassFiles();
31
32   /**
33    * Returns <code>true</code> if this instrumentation has been performed
34    * in-place.
35    *
36    * @return <code>true</code> if this instrumentation was in-place
37    */
38   public boolean isInplace();
39
40   /**
41    * Returns the absolute path to the instrumented class files. If in-place
42    * instrumentation was performed, this corresponds to the location of the
43    * original class files.
44    *
45    * @return absolute path to the instrumented class files
46    */
47   public IPath getOutputLocation();
48
49   /**
50    * Returns the absolute path to the Emma meta data file that has been written
51    * during instrumentation.
52    *
53    * @return absolute path to the meta data file
54    */
55   public IPath getMetaDataFile();
56
57 }
58
Popular Tags