aboutsummaryrefslogtreecommitdiffstats
path: root/org.jacoco.core/src/org/jacoco/core/analysis/ILine.java
blob: 8029f40740c809d3dcdfbe68c70e8a57afbe9411 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*******************************************************************************
 * Copyright (c) 2009, 2010 Mountainminds GmbH & Co. KG and Contributors
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Marc R. Hoffmann - initial API and implementation
 *    
 *******************************************************************************/
package org.jacoco.core.analysis;

/**
 * The instruction and branch coverage of a single source line is described by
 * this interface.
 * 
 * @author Marc R. Hoffmann
 * @version $Revision: 11 $
 */
public interface ILine {

	/**
	 * Flag for lines that do not contain instructions (value is 0x00).
	 */
	public static final byte NO_CODE = 0x00;

	/**
	 * Flag for lines where no instruction or branch is covered (value is 0x01).
	 */
	public static final byte NOT_COVERED = 0x01;

	/**
	 * Flag for lines where all instructions and branches are covered (value is
	 * 0x02).
	 */
	public static final byte FULLY_COVERED = 0x02;

	/**
	 * Flag for lines where only a part of the instructions or branches are
	 * covered (value is 0x03).
	 */
	public static final byte PARTLY_COVERED = NOT_COVERED | FULLY_COVERED;

	/**
	 * Returns the coverage status of the given line.
	 * 
	 * @see #NO_CODE
	 * @see #NOT_COVERED
	 * @see #PARTLY_COVERED
	 * @see #FULLY_COVERED
	 * 
	 * @return status of this line
	 */
	public byte getStatus();

	/**
	 * Returns the instruction counter for this line.
	 * 
	 * @return instruction counter
	 */
	public ICounter getInstructionCounter();

	/**
	 * Returns the branches counter for this line.
	 * 
	 * @return branches counter
	 */
	public ICounter getBranchCounter();

}