com.atlassian.clover

Class CloverDatabase

java.lang.Object

com.atlassian.clover.CloverDatabase

public class CloverDatabase
extends Object

encapsulates a Clover2 registry + recording files.

Constructor Summary

Constructors

Constructor and Description
CloverDatabase(Clover2Registry registry)
CloverDatabase(File regFile, boolean readOnly, String name, ContextSet contextFilter, CoverageDataSpec spec) Constructs a new database with an empty registry
CloverDatabase(String initstring)
CloverDatabase(String initstring, HasMetricsFilter includeFilter, String name)
CloverDatabase(String initstring, HasMetricsFilter includeFilter, String name, String filterSpec)
CloverDatabase(String initstring, HasMetricsFilter includeFilter, String name, String filterSpec, ProgressListener progressListener) create a new instance

Method Summary

Modifier and Type	Method and Description
CloverDatabase	copyForBackgroundCoverageDataLoad()
FullProjectInfo	getAppOnlyModel()
ContextSet	getContextSet(String spec)
ContextStore	getContextStore()
CoverageData	getCoverageData()
FullProjectInfo	getFullModel()
String	getInitstring()
FullProjectInfo	getModel(CodeType codeType)
String	getName()
long	getRecordingTimestamp()
Clover2Registry	getRegistry()
TestCaseInfo	getTestCase(int id)
Set<TestCaseInfo>	getTestHits(CoverageDataRange range) Gets test hits for a given range - FileInfo, ClassInfo etc
FullProjectInfo	getTestOnlyModel()
boolean	hasCoverage()
boolean	isCoverageOutOfDate()
boolean	isOutOfDate()
boolean	isRecordingInProgress()
static boolean	isRecordingInProgress(File pathToRegistry)
boolean	isRegistryOutOfDate()
CoverageData	loadCoverageData()
CoverageData	loadCoverageData(CoverageDataSpec spec)
CoverageData	loadCoverageData(CoverageDataSpec spec, ProgressListener progressListener)
static CloverDatabase	loadWithCoverage(String initString, CoverageDataSpec spec)
Map<TestCaseInfo,BitSet>	mapTestsAndCoverageForFile(FullFileInfo fileInfo)
static void	merge(List<CloverDatabaseSpec> dbspecs, String initString)
static void	merge(List<CloverDatabaseSpec> dbspecs, String initString, boolean update, Interval updateSpan, ProgressListener listener) merge a list of databases to a new database, specified by initString.
static void	merge(List<CloverDatabaseSpec> dbspecs, String initString, ProgressListener listener)
void	resolve(Path sourcePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

CloverDatabase

public CloverDatabase(String initstring)
               throws CloverException

Throws:

CloverException

CloverDatabase

public CloverDatabase(String initstring,
                      HasMetricsFilter includeFilter,
                      String name)
               throws CloverException

Throws:

CloverException

CloverDatabase

public CloverDatabase(String initstring,
                      HasMetricsFilter includeFilter,
                      String name,
                      String filterSpec)
               throws CloverException

Throws:

CloverException

CloverDatabase

public CloverDatabase(String initstring,
                      HasMetricsFilter includeFilter,
                      String name,
                      String filterSpec,
                      ProgressListener progressListener)
               throws CloverException

create a new instance

Parameters:

initstring - the location of the database to load

includeFilter - a filter that is applied to the loading of the registry. It controls what elements are visible to the database

name - an alternative name for the model

filterSpec - the filter to use when excluding metrics

progressListener - progress listener

Throws:

CloverException - if something goes wrong.

CloverDatabase

public CloverDatabase(File regFile,
                      boolean readOnly,
                      String name,
                      ContextSet contextFilter,
                      CoverageDataSpec spec)

Constructs a new database with an empty registry

CloverDatabase

public CloverDatabase(Clover2Registry registry)

Method Detail

copyForBackgroundCoverageDataLoad

public CloverDatabase copyForBackgroundCoverageDataLoad()

loadCoverageData

public CoverageData loadCoverageData()
                              throws CloverException

Throws:

CloverException

loadCoverageData

public CoverageData loadCoverageData(CoverageDataSpec spec)
                              throws CloverException

Throws:

CloverException

loadCoverageData

public CoverageData loadCoverageData(CoverageDataSpec spec,
                                     ProgressListener progressListener)
                              throws CloverException

Throws:

CloverException

getInitstring

public String getInitstring()

getName

public String getName()

getModel

public FullProjectInfo getModel(CodeType codeType)

getTestOnlyModel

public FullProjectInfo getTestOnlyModel()

getAppOnlyModel

public FullProjectInfo getAppOnlyModel()

getFullModel

public FullProjectInfo getFullModel()

isOutOfDate

public boolean isOutOfDate()

isRegistryOutOfDate

public boolean isRegistryOutOfDate()

isCoverageOutOfDate

public boolean isCoverageOutOfDate()

isRecordingInProgress

public boolean isRecordingInProgress()

isRecordingInProgress

public static boolean isRecordingInProgress(File pathToRegistry)

resolve

public void resolve(Path sourcePath)

getContextSet

public ContextSet getContextSet(String spec)

getTestHits

public Set<TestCaseInfo> getTestHits(CoverageDataRange range)

Gets test hits for a given range - FileInfo, ClassInfo etc

Returns:

a set of TestCaseInfos that hit the given receptor

See Also:

CoverageDataProvider

mapTestsAndCoverageForFile

public Map<TestCaseInfo,BitSet> mapTestsAndCoverageForFile(FullFileInfo fileInfo)

getRegistry

public Clover2Registry getRegistry()

getContextStore

public ContextStore getContextStore()

getCoverageData

public CoverageData getCoverageData()

getTestCase

public TestCaseInfo getTestCase(int id)

hasCoverage

public boolean hasCoverage()

getRecordingTimestamp

public long getRecordingTimestamp()

loadWithCoverage

public static CloverDatabase loadWithCoverage(String initString,
                                              CoverageDataSpec spec)
                                       throws CloverException

Throws:

CloverException

merge

public static void merge(List<CloverDatabaseSpec> dbspecs,
                         String initString)
                  throws CloverException,
                         IOException

Throws:

CloverException

IOException

merge

public static void merge(List<CloverDatabaseSpec> dbspecs,
                         String initString,
                         ProgressListener listener)
                  throws CloverException,
                         IOException

Throws:

CloverException

IOException

merge

public static void merge(List<CloverDatabaseSpec> dbspecs,
                         String initString,
                         boolean update,
                         Interval updateSpan,
                         ProgressListener listener)
                  throws CloverException,
                         IOException

merge a list of databases to a new database, specified by initString. if update is true and a database exists at initString, it is included in the merge, using updateSpan for the span. If update is set to false, any existing database at initString is overwritten. Progress is reported via listener

Parameters:

dbspecs - list of databases to merge

initString - destination database. If this exists and update is set to true, will be merged

update - if true, merge any existing database at initString

updateSpan - if update is true, the span to use when merging any existing database

listener - gets progress callbacks

Throws:

CloverException

IOException