BlockMetrics (OpenClover 4.5.2 API)

java.lang.Object
- com.atlassian.clover.registry.metrics.BlockMetrics

All Implemented Interfaces:

BlockMetrics

Direct Known Subclasses:

ClassMetrics
```
public class BlockMetrics
extends Object
implements BlockMetrics
```

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`VALUE_UNDEFINED` Constant used to indicate that given metric cannot be calculated (for example statement percentage coverage when code has 0 statements), so it's value is undefined.

Constructor Summary

Constructors
Constructor and Description

BlockMetrics(HasMetrics owner)

Constructors
Constructor and Description
`BlockMetrics(HasMetrics owner)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BlockMetrics`	`add(BlockMetrics metrics)`
`void`	`addComplexity(int complexity)`
`void`	`addNumBranches(int numBranches)`
`void`	`addNumCoveredBranches(int numCoveredBranches)`
`void`	`addNumCoveredStatements(int numCoveredStatements)`
`void`	`addNumStatements(int numStatements)`
`boolean`	`equals(Object o)`
`double`	`getAvgTestExecutionTime()`
`int`	`getComplexity()`
`float`	`getComplexityDensity()`
`protected double`	`getFraction(double num, int dem)`
`protected float`	`getFraction(float num, int dem)`
`int`	`getNumBranches()`
`int`	`getNumCoveredBranches()`
`int`	`getNumCoveredElements()`
`int`	`getNumCoveredStatements()`
`int`	`getNumElements()`
`int`	`getNumStatements()`
`int`	`getNumTestErrors()`
`int`	`getNumTestFailures()`
`int`	`getNumTestPasses()`
`int`	`getNumTests()`
`int`	`getNumTestsRun()`
`int`	`getNumUncoveredElements()`
`HasMetrics`	`getOwner()`
`float`	`getPcCoveredBranches()`
`float`	`getPcCoveredElements()`
`float`	`getPcCoveredStatements()`
`float`	`getPcTestErrors()`
`float`	`getPcTestFailures()`
`float`	`getPcTestPasses()`
`float`	`getPcTestPassesFailures()`
`float`	`getPcUncoveredElements()`
`double`	`getTestExecutionTime()`
`String`	`getType()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`static boolean`	`isUndefined(float value)` Returns true if given metric value is undefined.
`void`	`setComplexity(int complexity)`
`void`	`setNumBranches(int numBranches)`
`void`	`setNumCoveredBranches(int numCoveredBranches)`
`void`	`setNumCoveredStatements(int numCoveredStatements)`
`void`	`setNumStatements(int numStatements)`
`void`	`setNumTestErrors(int numTestErrors)`
`void`	`setNumTestFailures(int numTestFailures)`
`void`	`setNumTestPasses(int numTestPasses)`
`void`	`setNumTests(int numTests)`
`void`	`setOwner(HasMetrics owner)`
`void`	`setTestExecutionTime(double testExecutionTime)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - VALUE_UNDEFINED
```
public static float VALUE_UNDEFINED
```
    Constant used to indicate that given metric cannot be calculated (for example statement percentage coverage when code has 0 statements), so it's value is undefined.
- Constructor Detail
  - BlockMetrics
```
public BlockMetrics(HasMetrics owner)
```
- Method Detail
  - isUndefined
```
public static boolean isUndefined(float value)
```
    Returns true if given metric value is undefined.
    
    Parameters:
    
    value - - value to be checked
    
    Returns:
    
    true if it equals VALUE_UNDEFINED, false otherwise
    
    See Also:
    
    VALUE_UNDEFINED
  - getOwner
```
public HasMetrics getOwner()
```
    Specified by:
    
    getOwner in interface BlockMetrics
  - setOwner
```
public void setOwner(HasMetrics owner)
```
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface BlockMetrics
  - getNumStatements
```
public int getNumStatements()
```
    Specified by:
    
    getNumStatements in interface BlockMetrics
  - addNumStatements
```
public void addNumStatements(int numStatements)
```
  - setNumStatements
```
public void setNumStatements(int numStatements)
```
  - getNumCoveredStatements
```
public int getNumCoveredStatements()
```
    Specified by:
    
    getNumCoveredStatements in interface BlockMetrics
  - addNumCoveredStatements
```
public void addNumCoveredStatements(int numCoveredStatements)
```
  - setNumCoveredStatements
```
public void setNumCoveredStatements(int numCoveredStatements)
```
  - getNumBranches
```
public int getNumBranches()
```
    Specified by:
    
    getNumBranches in interface BlockMetrics
  - addNumBranches
```
public void addNumBranches(int numBranches)
```
  - setNumBranches
```
public void setNumBranches(int numBranches)
```
  - getNumCoveredBranches
```
public int getNumCoveredBranches()
```
    Specified by:
    
    getNumCoveredBranches in interface BlockMetrics
  - addNumCoveredBranches
```
public void addNumCoveredBranches(int numCoveredBranches)
```
  - setNumCoveredBranches
```
public void setNumCoveredBranches(int numCoveredBranches)
```
  - getComplexity
```
public int getComplexity()
```
    Specified by:
    
    getComplexity in interface BlockMetrics
  - addComplexity
```
public void addComplexity(int complexity)
```
  - setComplexity
```
public void setComplexity(int complexity)
```
  - getNumTests
```
public int getNumTests()
```
    Specified by:
    
    getNumTests in interface BlockMetrics
  - setNumTests
```
public void setNumTests(int numTests)
```
  - getNumTestPasses
```
public int getNumTestPasses()
```
    Specified by:
    
    getNumTestPasses in interface BlockMetrics
  - setNumTestPasses
```
public void setNumTestPasses(int numTestPasses)
```
  - getNumTestFailures
```
public int getNumTestFailures()
```
    Specified by:
    
    getNumTestFailures in interface BlockMetrics
  - setNumTestFailures
```
public void setNumTestFailures(int numTestFailures)
```
  - getNumTestErrors
```
public int getNumTestErrors()
```
    Specified by:
    
    getNumTestErrors in interface BlockMetrics
  - setNumTestErrors
```
public void setNumTestErrors(int numTestErrors)
```
  - getTestExecutionTime
```
public double getTestExecutionTime()
```
    Specified by:
    
    getTestExecutionTime in interface BlockMetrics
  - setTestExecutionTime
```
public void setTestExecutionTime(double testExecutionTime)
```
  - getNumElements
```
public int getNumElements()
```
    Specified by:
    
    getNumElements in interface BlockMetrics
  - getNumCoveredElements
```
public int getNumCoveredElements()
```
    Specified by:
    
    getNumCoveredElements in interface BlockMetrics
  - getNumUncoveredElements
```
public int getNumUncoveredElements()
```
    Specified by:
    
    getNumUncoveredElements in interface BlockMetrics
  - getPcCoveredStatements
```
public float getPcCoveredStatements()
```
    Specified by:
    
    getPcCoveredStatements in interface BlockMetrics
  - getPcCoveredBranches
```
public float getPcCoveredBranches()
```
    Specified by:
    
    getPcCoveredBranches in interface BlockMetrics
  - getPcCoveredElements
```
public float getPcCoveredElements()
```
    Specified by:
    
    getPcCoveredElements in interface BlockMetrics
  - getPcUncoveredElements
```
public float getPcUncoveredElements()
```
    Specified by:
    
    getPcUncoveredElements in interface BlockMetrics
  - getAvgTestExecutionTime
```
public double getAvgTestExecutionTime()
```
    Specified by:
    
    getAvgTestExecutionTime in interface BlockMetrics
  - getPcTestPasses
```
public float getPcTestPasses()
```
    Specified by:
    
    getPcTestPasses in interface BlockMetrics
  - getPcTestErrors
```
public float getPcTestErrors()
```
    Specified by:
    
    getPcTestErrors in interface BlockMetrics
  - getPcTestFailures
```
public float getPcTestFailures()
```
    Specified by:
    
    getPcTestFailures in interface BlockMetrics
  - getNumTestsRun
```
public int getNumTestsRun()
```
    Specified by:
    
    getNumTestsRun in interface BlockMetrics
  - getPcTestPassesFailures
```
public float getPcTestPassesFailures()
```
    Specified by:
    
    getPcTestPassesFailures in interface BlockMetrics
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface BlockMetrics
  - getComplexityDensity
```
public float getComplexityDensity()
```
    Specified by:
    
    getComplexityDensity in interface BlockMetrics
  - add
```
public BlockMetrics add(BlockMetrics metrics)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getFraction
```
protected double getFraction(double num,
                             int dem)
```
  - getFraction
```
protected float getFraction(float num,
                            int dem)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BlockMetrics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VALUE_UNDEFINED

Constructor Detail

BlockMetrics

Method Detail

isUndefined

getOwner

setOwner

getType

getNumStatements

addNumStatements

setNumStatements

getNumCoveredStatements

addNumCoveredStatements

setNumCoveredStatements

getNumBranches

addNumBranches

setNumBranches

getNumCoveredBranches

addNumCoveredBranches

setNumCoveredBranches

getComplexity

addComplexity

setComplexity

getNumTests

setNumTests

getNumTestPasses

setNumTestPasses

getNumTestFailures

setNumTestFailures

getNumTestErrors

setNumTestErrors

getTestExecutionTime

setTestExecutionTime

getNumElements

getNumCoveredElements

getNumUncoveredElements

getPcCoveredStatements

getPcCoveredBranches

getPcCoveredElements

getPcUncoveredElements

getAvgTestExecutionTime

getPcTestPasses

getPcTestErrors

getPcTestFailures

getNumTestsRun

getPcTestPassesFailures

isEmpty

getComplexityDensity

add

equals

hashCode

getFraction

getFraction

toString