1 /*
2 * EL4J, the Extension Library for the J2EE, adds incremental enhancements to
3 * the spring framework, http://el4j.sf.net
4 * Copyright (C) 2008 by ELCA Informatique SA, Av. de la Harpe 22-24,
5 * 1000 Lausanne, Switzerland, http://www.elca.ch
6 *
7 * EL4J is published under the GNU Lesser General Public License (LGPL)
8 * Version 2.1. See http://www.gnu.org/licenses/
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Lesser General Public License for more details.
14 *
15 * For alternative licensing, please contact info@elca.ch
16 */
17 package ch.elca.el4j.coberturaruntime;
18
19 /**
20 * Cobertura runtime controller interface.
21 *
22 * @svnLink $Revision: 3873 $;$Date: 2009-08-04 13:59:45 +0200 (Di, 04. Aug 2009) $;$Author: swismer $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/cobertura-runtime/src/main/java/ch/elca/el4j/coberturaruntime/CoberturaRuntimeController.java $
23 *
24 * @author Martin Zeltner (MZE)
25 */
26 public interface CoberturaRuntimeController {
27 /**
28 * Starts recording of cobertura.
29 *
30 * @return Returns <code>true</code> if the recording could be started and cobertura was not already running.
31 */
32 public boolean startRecording();
33
34 /**
35 * Stops recording of cobertura.
36 *
37 * @return Returns <code>true</code> if the recording could be stopped and cobertura was not already stopped.
38 */
39 public boolean stopRecording();
40
41 /**
42 * @return Returns <code>true</code> if cobertura is currently recording.
43 */
44 public boolean isRecording();
45
46 /**
47 * Flushes the made records to the given data file.
48 */
49 public void flushRecords();
50
51 /**
52 * @return Returns the path to the cobertura data file.
53 */
54 public String getDataFilePath();
55
56 /**
57 * Generates the cobertura report of the current state.
58 *
59 * @return Returns the directory path of the generated report.
60 */
61 public String generateReport();
62 }