com.atlassian.clover.recorder

Class GrowableCoverageRecorder

java.lang.Object

com_atlassian_clover.CoverageRecorder

com.atlassian.clover.recorder.BaseCoverageRecorder

com.atlassian.clover.recorder.GrowableCoverageRecorder

Direct Known Subclasses:

SharedCoverageRecorder

public class GrowableCoverageRecorder
extends BaseCoverageRecorder

CoverageRecorder which can grow its capacity to record coverage. This is necessary where the original Clover database is unavailable due to various deployment scenarios and Clover should make best efforts to record coverage.

This class will emit proxy CoverageRecorders from withCapacityFor(int) which can track enough coverage required at the point when they were requested (normally when a Clovered class is first loaded). If more coverage needs to be tracked a subsequent call to withCapacityFor(int) should be made for a new proxy which satisfies the new requirements. A call to withCapacityFor(int) on a proxy will, if the proxy cannot support the required number of elements, will redirect to the underlying GrowableCoverageRecorder which will return a sufficenly large proxy (having grown the underlying CoverageMatrix in a thread safe manner).

Proxies and the original GrowableCoverageRecorder share coverage by sharing int[] sections of the total logical coverage array (which in essence becomes an int[][] ie a matrix). The master matrix may grow but because the original int[] objects remain in use and shared across all subsequent proxies the total coverage is shared in a relatively thread safe fashion (note: we still suffer the elements[i]++ MT problem).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrowableCoverageRecorder.FixedProxy A lightweight proxy which provides just enough coverage capacity for the class that asked for it but delegates to the original GrowableCoverageRecorder for all other functions.

Field Summary

Fields inherited from class com.atlassian.clover.recorder.BaseCoverageRecorder

activeFlusher, alternateRecName, dbName, dbVersion, flushInterval, flushNeeded, lastFlush, recName, shutdownFlusher, testCoverage, useAlternate, writeStrategy

Fields inherited from class com_atlassian_clover.CoverageRecorder

DISABLE_SHUTDOWNHOOK_MASK, DISABLE_SLICE_FLUSHING_MASK, FLUSH_INTERVAL_MASK, FLUSHPOLICY_DIRECTED, FLUSHPOLICY_INTERVAL, FLUSHPOLICY_MASK, FLUSHPOLICY_THREADED, USE_CURRENT_THREADGROUP_MASK

Method Summary

Modifier and Type	Method and Description
CloverBitSet	compareCoverageWith(CoverageSnapshot before)
CloverBitSet	createEmptyHitsMask()
static CoverageRecorder	createFor(String dbName, long dbVersion, long cfgbits, int maxNumElements) Factory method.
CoverageSnapshot	getCoverageSnapshot()
int	iget(int index)
void	inc(int index) Increment slot at index
String	toString()
CoverageRecorder	withCapacityFor(int maxNumElements) Returns an instance that *may* support recording the number of elements requested (throw growth) else accepts (but harmlessly) discards recording for elements that can't be accepted.
protected String	write() Writes coverage data to disk

Methods inherited from class com.atlassian.clover.recorder.BaseCoverageRecorder

chooseRecordingName, flush, flushNeeded, forceFlush, getDbName, getDbVersion, getRecordingName, getShutdownFlusher, globalSliceEnd, globalSliceEnd, globalSliceStart, globalSliceStart, maybeFlush, sliceEnd, sliceStart, startRun, write

Methods inherited from class com_atlassian_clover.CoverageRecorder

getConfigBits, rethrow

Methods inherited from class java.lang.Object

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

Method Detail

createFor

public static CoverageRecorder createFor(String dbName,
                                         long dbVersion,
                                         long cfgbits,
                                         int maxNumElements)

Factory method. Use this to get an instance of the recorder. Do not call constructors directly (they're not private only for the sake of unit tests).

write

protected String write()
                throws IOException

Description copied from class: BaseCoverageRecorder

Writes coverage data to disk

Specified by:

write in class BaseCoverageRecorder

Throws:

IOException

compareCoverageWith

public CloverBitSet compareCoverageWith(CoverageSnapshot before)

Specified by:

compareCoverageWith in class CoverageRecorder

Returns:

a bit set mask for elements that have had coverage since the CoverageSnapshot was generated

createEmptyHitsMask

public CloverBitSet createEmptyHitsMask()

Specified by:

createEmptyHitsMask in class CoverageRecorder

Returns:

an empty bit set mask sufficient for the current number of elements

iget

public int iget(int index)

Specified by:

iget in class BaseCoverageRecorder

Returns:

coverage for slot at index but increment by one before evaluation

inc

public void inc(int index)

Description copied from class: BaseCoverageRecorder

Increment slot at index

Specified by:

inc in class BaseCoverageRecorder

withCapacityFor

public CoverageRecorder withCapacityFor(int maxNumElements)

Description copied from class: CoverageRecorder

Returns an instance that *may* support recording the number of elements requested (throw growth) else accepts (but harmlessly) discards recording for elements that can't be accepted.

Specified by:

withCapacityFor in class CoverageRecorder

getCoverageSnapshot

public CoverageSnapshot getCoverageSnapshot()

Specified by:

getCoverageSnapshot in class CoverageRecorder

toString

public String toString()

Overrides:

toString in class Object