jetbrains.coverage.report

Interface StatisticsCalculator

public interface StatisticsCalculator

Given the coverage data calculates coverage statistics. Not thread safe.

Method Summary

Modifier and Type	Method and Description
void	compute(@NotNull CoverageData coverageData) Computes statistics.
void	compute(@NotNull CoverageData before, @NotNull CoverageData after) Computes statistics with difference information between supplied coverage datas.
@NotNull CoverageStatistics	getForClass(@NotNull ClassInfo classInfo) Returns coverage statistics for single class
@NotNull CoverageStatistics	getForClassWithInnerClasses(@NotNull ClassInfo classInfo) Returns coverage statistics for class including inner classes (inner classes statistics added to the class statistics).
@NotNull CoverageStatistics	getForModule(@Nullable java.lang.String module) Returns coverage statistics for module (e.g.
@NotNull CoverageStatistics	getForNamespace(@Nullable java.lang.String module, java.lang.String namespace) Returns coverage statistics for namespace (e.g.
@NotNull CoverageStatistics	getOverallStats() Returns total statistics for all classes.

Method Detail

compute

void compute(@NotNull
             @NotNull CoverageData coverageData)

Computes statistics.

Parameters:

coverageData - coverage data

compute

void compute(@NotNull
             @NotNull CoverageData before,
             @NotNull
             @NotNull CoverageData after)

Computes statistics with difference information between supplied coverage datas.

Parameters:

before - older coverage

after - newer coverage

getForClass

@NotNull
@NotNull CoverageStatistics getForClass(@NotNull
                                                 @NotNull ClassInfo classInfo)

Returns coverage statistics for single class

Parameters:

classInfo - class

Returns:

see above

getForClassWithInnerClasses

@NotNull
@NotNull CoverageStatistics getForClassWithInnerClasses(@NotNull
                                                                 @NotNull ClassInfo classInfo)

Returns coverage statistics for class including inner classes (inner classes statistics added to the class statistics).

Parameters:

classInfo - class

Returns:

see above

getForNamespace

@NotNull
@NotNull CoverageStatistics getForNamespace(@Nullable
                                                     @Nullable java.lang.String module,
                                                     java.lang.String namespace)

Returns coverage statistics for namespace (e.g. package in Java)

Parameters:

module - module

namespace - namespace

Returns:

see above

getForModule

@NotNull
@NotNull CoverageStatistics getForModule(@Nullable
                                                  @Nullable java.lang.String module)

Returns coverage statistics for module (e.g. .NET assembly)

Parameters:

module - module name

Returns:

see above

getOverallStats

@NotNull
@NotNull CoverageStatistics getOverallStats()

Returns total statistics for all classes.

Returns:

see above