com.atlassian.clover.reporters.util

Class HistoricalSupport

java.lang.Object

com.atlassian.clover.reporters.util.HistoricalSupport

public class HistoricalSupport
extends Object

Helper class that provides utility methods to support the generation of historical reports

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HistoricalSupport.HasMetricsWrapper

Constructor Summary

Constructors

Constructor and Description
HistoricalSupport()

Method Summary

Modifier and Type	Method and Description
static SortedMap<Long,HasMetrics>	getAllProjectMetrics(File[] files)
static List<MetricsDiffSummary>	getClassesMetricsDifference(HasMetrics then, HasMetrics now, Percentage threshold, boolean onlyDiffs)
static List<MetricsDiffSummary>	getClassesMetricsDifference(HasMetrics then, HasMetrics now, Percentage threshold, Column column, boolean onlyDiffs) Returns a list of all movers
static MetricsDiffSummary	getClassMetricsDiff(ClassInfo c1, ClassInfo c2, Percentage threshold, Column column)
static HasMetrics	getFullMetrics(HistoricalSupport.HasMetricsWrapper wrapper, String pkg) get full, class-level model for the given aggregate metrics object
static MetricsDiffSummary	getNewClassMetrics(ClassInfo c1, ClassInfo c2, Column column)
static List<MetricsDiffSummary>	getPackageClassesMetricsDiff(BasePackageInfo then, BasePackageInfo now, Percentage threshold, Column column, boolean onlyDiffs)
static List<MetricsDiffSummary>	getProjectClassesMetricsDiff(BaseProjectInfo then, BaseProjectInfo now, Percentage threshold, Column column, boolean onlyDiffs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistoricalSupport

public HistoricalSupport()

Method Detail

getAllProjectMetrics

public static SortedMap<Long,HasMetrics> getAllProjectMetrics(File[] files)
                                                       throws IOException

Throws:

IOException

getFullMetrics

public static HasMetrics getFullMetrics(HistoricalSupport.HasMetricsWrapper wrapper,
                                        String pkg)
                                 throws IOException,
                                        CloverException

get full, class-level model for the given aggregate metrics object

Throws:

IOException

CloverException

getClassesMetricsDifference

public static List<MetricsDiffSummary> getClassesMetricsDifference(HasMetrics then,
                                                                   HasMetrics now,
                                                                   Percentage threshold,
                                                                   boolean onlyDiffs)
                                                            throws CloverException

Throws:

CloverException

getClassesMetricsDifference

public static List<MetricsDiffSummary> getClassesMetricsDifference(HasMetrics then,
                                                                   HasMetrics now,
                                                                   Percentage threshold,
                                                                   Column column,
                                                                   boolean onlyDiffs)
                                                            throws CloverException

Returns a list of all movers

Parameters:

column - Controls which column of the metrics to use, also an "output parameter" to keep the maximum value of this column

Throws:

CloverException - Throws CloverException when a user defines an invalid expression column

getProjectClassesMetricsDiff

public static List<MetricsDiffSummary> getProjectClassesMetricsDiff(BaseProjectInfo then,
                                                                    BaseProjectInfo now,
                                                                    Percentage threshold,
                                                                    Column column,
                                                                    boolean onlyDiffs)
                                                             throws CloverException

Throws:

CloverException

getPackageClassesMetricsDiff

public static List<MetricsDiffSummary> getPackageClassesMetricsDiff(BasePackageInfo then,
                                                                    BasePackageInfo now,
                                                                    Percentage threshold,
                                                                    Column column,
                                                                    boolean onlyDiffs)
                                                             throws CloverException

Throws:

CloverException

getClassMetricsDiff

public static MetricsDiffSummary getClassMetricsDiff(ClassInfo c1,
                                                     ClassInfo c2,
                                                     Percentage threshold,
                                                     Column column)
                                              throws CloverException

Throws:

CloverException

getNewClassMetrics

public static MetricsDiffSummary getNewClassMetrics(ClassInfo c1,
                                                    ClassInfo c2,
                                                    Column column)
                                             throws CloverException

Throws:

CloverException