com.atlassian.clover.registry

Class Clover2Registry

java.lang.Object

com.atlassian.clover.registry.Clover2Registry

All Implemented Interfaces:

InstrumentationTarget

public class Clover2Registry
extends Object
implements InstrumentationTarget

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Clover2Registry.InstrumentationInfo provides high level information about an instrumentation "session", where a session is defined as a call to startInstr(), zero or more instrumentation events (e.g InstrumentationSessionImpl.enterFile(java.lang.String, java.io.File, int, int, long, long, long) etc), then a call to InstrumentationSessionImpl.finishAndApply()

Constructor Summary

Constructors

Constructor and Description
Clover2Registry(File regFile, RegAccessMode accessMode, String name)
Clover2Registry(File regFile, String name) creates a fresh registry with no elements in it

Method Summary

Modifier and Type	Method and Description
UpdatableRegFile	applyAndAppendToFile(UpdatableRegFile regFile, InstrumentationSessionImpl.Update update) Apply changes to the model and then append the changes to the registry on disk
RegistryUpdate	applyUpdate(long expectedVersion, InstrumentationSessionImpl.Update update) Applies the instrumentation session update to the registry.
Clover2Registry	copyForBackgroundCoverageLoad()
static Clover2Registry	createOrLoad(File registryFile, String projectName)
boolean	fileExists()
static Clover2Registry	fromFile(File registryFile)
static Clover2Registry	fromFile(File registryFile, HasMetricsFilter filter, ProgressListener progressListener)
static Clover2Registry	fromInitString(String initstring, String name)
ContextStore	getContextStore()
CoverageData	getCoverageData()
int	getDataLength()
long	getFirstVersion()
String	getInitstring()
List	getInstrHistory()
ProjectView.Original	getModel()
long	getPastInstrTimestamp(int numPastInstrs)
FullProjectInfo	getProject()
String	getProjectName()
File	getRegistryFile()
long	getVersion()
boolean	isOutOfDate()
boolean	isReadOnly()
ProjectView.Filtered	newProjectView(HasMetricsFilter.Invertable filter)
void	resolve(Path sourcePath)
RegFile	saveAndAppendToFile()
RegFile	saveAndOverwriteFile()
protected RegFile	saveAndOverwriteFile(FullProjectInfo project, List<Clover2Registry.InstrumentationInfo> instrumentationHistory, ContextStore contexts, CoverageData coverageData)
void	setContextStore(ContextStore contexts)
void	setCoverageData(CoverageData data)
void	setProjectName(String name)
void	setVersion(long version)
InstrumentationSession	startInstr()
InstrumentationSession	startInstr(String encoding)

Methods inherited from class java.lang.Object

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

Constructor Detail

Clover2Registry

public Clover2Registry(File regFile,
                       String name)

creates a fresh registry with no elements in it

Parameters:

regFile - the file that this registry will be written to when store() is called

name - the project name to associate with this registry

Clover2Registry

public Clover2Registry(File regFile,
                       RegAccessMode accessMode,
                       String name)

Method Detail

copyForBackgroundCoverageLoad

public Clover2Registry copyForBackgroundCoverageLoad()

fromInitString

public static Clover2Registry fromInitString(String initstring,
                                             String name)
                                      throws CloverException

Throws:

CloverException

fromFile

public static Clover2Registry fromFile(File registryFile)
                                throws CloverException

Throws:

CloverException

fromFile

public static Clover2Registry fromFile(File registryFile,
                                       HasMetricsFilter filter,
                                       ProgressListener progressListener)
                                throws CloverException

Throws:

CloverException

createOrLoad

public static Clover2Registry createOrLoad(File registryFile,
                                           String projectName)
                                    throws IOException,
                                           CloverException

Throws:

IOException

CloverException

saveAndOverwriteFile

public RegFile saveAndOverwriteFile()
                             throws IOException,
                                    CloverRegistryException

Throws:

IOException

CloverRegistryException

saveAndOverwriteFile

protected RegFile saveAndOverwriteFile(FullProjectInfo project,
                                       List<Clover2Registry.InstrumentationInfo> instrumentationHistory,
                                       ContextStore contexts,
                                       CoverageData coverageData)
                                throws IOException,
                                       CloverRegistryException

Throws:

IOException

CloverRegistryException

saveAndAppendToFile

public RegFile saveAndAppendToFile()
                            throws IOException,
                                   CloverRegistryException

Throws:

IOException

CloverRegistryException

applyAndAppendToFile

public UpdatableRegFile applyAndAppendToFile(UpdatableRegFile regFile,
                                             InstrumentationSessionImpl.Update update)
                                      throws IOException,
                                             CloverRegistryException

Apply changes to the model and then append the changes to the registry on disk

Returns:

ExistingRegFile the new registry file representation suitable for further appending of updates

Throws:

IOException

CloverRegistryException

applyUpdate

public RegistryUpdate applyUpdate(long expectedVersion,
                                  InstrumentationSessionImpl.Update update)
                           throws ConcurrentInstrumentationException

Applies the instrumentation session update to the registry. This method is not threadsafe and should be called when interim model changes will not be visible to the environment.

Specified by:

applyUpdate in interface InstrumentationTarget

Throws:

ConcurrentInstrumentationException - if another instrumentation session update was applied between the start and application of the supplied instrumentation session update.

newProjectView

public ProjectView.Filtered newProjectView(HasMetricsFilter.Invertable filter)

startInstr

public InstrumentationSession startInstr()
                                  throws CloverException

Throws:

CloverException

startInstr

public InstrumentationSession startInstr(String encoding)
                                  throws CloverException

Throws:

CloverException

fileExists

public boolean fileExists()

isOutOfDate

public boolean isOutOfDate()

getRegistryFile

public File getRegistryFile()

getProjectName

public String getProjectName()

setProjectName

public void setProjectName(String name)

getVersion

public long getVersion()

getFirstVersion

public long getFirstVersion()

setVersion

public void setVersion(long version)

getModel

public ProjectView.Original getModel()

isReadOnly

public boolean isReadOnly()

setCoverageData

public void setCoverageData(CoverageData data)

getCoverageData

public CoverageData getCoverageData()

getDataLength

public int getDataLength()

getProject

public FullProjectInfo getProject()

getInstrHistory

public List getInstrHistory()

getContextStore

public ContextStore getContextStore()

setContextStore

public void setContextStore(ContextStore contexts)

getInitstring

public String getInitstring()

getPastInstrTimestamp

public long getPastInstrTimestamp(int numPastInstrs)

resolve

public void resolve(Path sourcePath)