KickJava   Java API By Example, From Geeks To Geeks.

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


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: ISessionImporter.java 85 2006-09-14 20:11:47Z mho $
7  ******************************************************************************/

8 package com.mountainminds.eclemma.core;
9
10 import org.eclipse.core.runtime.CoreException;
11 import org.eclipse.core.runtime.IProgressMonitor;
12
13 /**
14  * API for importing sessions. This interface is not intended to be implemented
15  * by clients. Use {@link CoverageTools#getImporter()} to get an instance.
16  *
17  * @author Marc R. Hoffmann
18  * @version $Revision: 85 $
19  */

20 public interface ISessionImporter {
21
22   /**
23    * Sets the description for the imported session.
24    *
25    * @param description
26    * textual description of the session
27    */

28   public void setDescription(String JavaDoc description);
29
30   /**
31    * Sets the path to the coverage file to import.
32    *
33    * @param file
34    * coverage file to import
35    */

36   public void setCoverageFile(String JavaDoc file);
37
38   /**
39    * Sets the list of class files that should be considered for coverage
40    * analysis.
41    *
42    * @param classfiles
43    * class files for analysis
44    */

45   public void setClassFiles(IClassFiles[] classfiles);
46
47   /**
48    * Specifies whether the original file should be copied while importing.
49    * Otherwise the coverage file a referenced only.
50    *
51    * @param copy
52    * flag, whether the coverage file should be copied
53    */

54   public void setCopy(boolean copy);
55
56   /**
57    * A call to this method triggers the actual import process.
58    *
59    * @param monitor
60    * progress monitor
61    * @throws CoreException
62    * if something goes wrong during export
63    */

64   public void importSession(IProgressMonitor monitor) throws CoreException;
65
66 }
67
Popular Tags