com.atlassian.clover.cfg.instr

Class InstrumentationConfig

java.lang.Object

com.atlassian.clover.cfg.instr.InstrumentationConfig

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JavaInstrumentationConfig

public class InstrumentationConfig
extends Object
implements Serializable

Instrumentation settings common for Java and Groovy.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DB_DIR
static String	DEFAULT_DB_FILE
static int	DEFAULT_FLUSHING
static String	DIRECTED_FLUSH_POLICY
static int	DIRECTED_FLUSHING
static String[]	FLUSH_VALUES
static String	INTERVAL_FLUSH_POLICY
static int	INTERVAL_FLUSHING
static String	THREADED_FLUSH_POLICY
static int	THREADED_FLUSHING

Constructor Summary

Constructors

Constructor and Description
InstrumentationConfig()

Method Summary

Modifier and Type	Method and Description
void	addMethodContext(MethodContextDef context)
void	addProfile(CloverProfile profile)
void	addStatementContext(StatementContextDef context)
String	createDefaultInitStringDir()
String	getClassNotFoundMsg()
File	getDefaultBaseDir()
String	getDistributedConfigString()
String	getEncoding()
int	getFlushInterval()
int	getFlushPolicy()
String	getFlushPolicyString()
Collection<File>	getIncludedFiles()
String	getInitString()
int	getInstrLevel()
List<MethodContextDef>	getMethodContexts()
List<CloverProfile>	getProfiles() Returns list of Clover's runtime profiles or null if none was defined.
String	getProjectName()
File	getRegistryFile() If the registry file is set, then return it, otherwise a new File object will be created using the initString that is set.
String	getRuntimeInitString()
List<StatementContextDef>	getStatementContexts()
TestDetector	getTestDetector()
File	getTmpDir()
String	getValidationFailureReason()
boolean	hasCustomContexts()
boolean	isClassInstrStrategy()
boolean	isEnabled()
boolean	isIntervalBasedFlushing()
boolean	isRecordTestResults()
boolean	isRelative()
boolean	isReportInitErrors()
boolean	isSliceRecording()
boolean	isStatementInstrEnabled()
boolean	isTestDetector()
static InstrumentationConfig	loadFromStream(InputStream stream)
String	resolveInitString()
void	saveToFile(File file)
void	setClassInstrStragegy(boolean useClass)
void	setClassNotFoundMsg(String classNotFoundMsg)
void	setDefaultBaseDir(File defaultBaseDir)
void	setDistributedConfig(DistributedConfig distributedConfig)
void	setEnabled(boolean enabled)
void	setEncoding(String encoding)
void	setFlushInterval(int flushInterval)
void	setFlushPolicy(int flushPolicy)
void	setFlushPolicyFromString(String fp)
void	setIncludedFiles(Collection<File> includedFiles)
void	setInitstring(String initstring)
void	setInstrLevel(int instrLevel)
void	setInstrLevelStrategy(String value)
void	setInstrStrategy(String value)
void	setProjectName(String projectName)
void	setRecordTestResults(boolean recordTestResults)
void	setRegistryFile(File registryFile)
void	setRelative(boolean relative)
void	setReportInitErrors(boolean reportInitErrors)
void	setSliceRecording(boolean sliceRecording)
void	setTestDetector(TestDetector detector)
void	setTmpDir(File tmpDir)
protected void	setValidationFailureReason(String reason)
boolean	validate() Implement validation in sub-classes.

Methods inherited from class java.lang.Object

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

Field Detail

DIRECTED_FLUSHING

public static final int DIRECTED_FLUSHING

See Also:

Constant Field Values

INTERVAL_FLUSHING

public static final int INTERVAL_FLUSHING

See Also:

Constant Field Values

THREADED_FLUSHING

public static final int THREADED_FLUSHING

See Also:

Constant Field Values

DIRECTED_FLUSH_POLICY

public static final String DIRECTED_FLUSH_POLICY

See Also:

Constant Field Values

INTERVAL_FLUSH_POLICY

public static final String INTERVAL_FLUSH_POLICY

See Also:

Constant Field Values

THREADED_FLUSH_POLICY

public static final String THREADED_FLUSH_POLICY

See Also:

Constant Field Values

FLUSH_VALUES

public static final String[] FLUSH_VALUES

DEFAULT_FLUSHING

public static final int DEFAULT_FLUSHING

See Also:

Constant Field Values

DEFAULT_DB_DIR

public static final String DEFAULT_DB_DIR

See Also:

Constant Field Values

DEFAULT_DB_FILE

public static final String DEFAULT_DB_FILE

Constructor Detail

InstrumentationConfig

public InstrumentationConfig()

Method Detail

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isReportInitErrors

public boolean isReportInitErrors()

setReportInitErrors

public void setReportInitErrors(boolean reportInitErrors)

isTestDetector

public boolean isTestDetector()

getTestDetector

public TestDetector getTestDetector()

setTestDetector

public void setTestDetector(TestDetector detector)

getInitString

public String getInitString()

isRelative

public boolean isRelative()

setRelative

public void setRelative(boolean relative)

getFlushPolicy

public int getFlushPolicy()

setFlushPolicy

public void setFlushPolicy(int flushPolicy)

setFlushPolicyFromString

public void setFlushPolicyFromString(String fp)
                              throws CloverException

Throws:

CloverException

getFlushPolicyString

public String getFlushPolicyString()

isClassInstrStrategy

public boolean isClassInstrStrategy()

setClassInstrStragegy

public void setClassInstrStragegy(boolean useClass)

setInstrStrategy

public void setInstrStrategy(String value)

getRegistryFile

public File getRegistryFile()
                     throws CloverException

If the registry file is set, then return it, otherwise a new File object will be created using the initString that is set.

Returns:

the registry file to use.

Throws:

CloverException - if error resolving initstring

setRegistryFile

public void setRegistryFile(File registryFile)

setInitstring

public void setInitstring(String initstring)

getRuntimeInitString

public String getRuntimeInitString()
                            throws CloverException

Throws:

CloverException

getProjectName

public String getProjectName()

setProjectName

public void setProjectName(String projectName)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

isIntervalBasedFlushing

public boolean isIntervalBasedFlushing()

isSliceRecording

public boolean isSliceRecording()

setSliceRecording

public void setSliceRecording(boolean sliceRecording)

getFlushInterval

public int getFlushInterval()

setFlushInterval

public void setFlushInterval(int flushInterval)

getDefaultBaseDir

public File getDefaultBaseDir()

setDefaultBaseDir

public void setDefaultBaseDir(File defaultBaseDir)

getTmpDir

public File getTmpDir()

setTmpDir

public void setTmpDir(File tmpDir)

getInstrLevel

public int getInstrLevel()

setInstrLevel

public void setInstrLevel(int instrLevel)

isStatementInstrEnabled

public boolean isStatementInstrEnabled()

setInstrLevelStrategy

public void setInstrLevelStrategy(String value)

resolveInitString

public String resolveInitString()

createDefaultInitStringDir

public String createDefaultInitStringDir()
                                  throws CloverException

Throws:

CloverException

setRecordTestResults

public void setRecordTestResults(boolean recordTestResults)

isRecordTestResults

public boolean isRecordTestResults()

getMethodContexts

public List<MethodContextDef> getMethodContexts()

addMethodContext

public void addMethodContext(MethodContextDef context)

getStatementContexts

public List<StatementContextDef> getStatementContexts()

addStatementContext

public void addStatementContext(StatementContextDef context)

hasCustomContexts

public boolean hasCustomContexts()

setDistributedConfig

public void setDistributedConfig(DistributedConfig distributedConfig)

getDistributedConfigString

public String getDistributedConfigString()

Returns:

the distributedConfig as a String, or null if distributedConfig is null.

getClassNotFoundMsg

public String getClassNotFoundMsg()

setClassNotFoundMsg

public void setClassNotFoundMsg(String classNotFoundMsg)

getIncludedFiles

public Collection<File> getIncludedFiles()

setIncludedFiles

public void setIncludedFiles(Collection<File> includedFiles)

saveToFile

public void saveToFile(File file)
                throws IOException

Throws:

IOException

loadFromStream

public static InstrumentationConfig loadFromStream(InputStream stream)
                                            throws IOException,
                                                   ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getProfiles

public List<CloverProfile> getProfiles()

Returns list of Clover's runtime profiles or null if none was defined.

Returns:

List<CloverProfile>

addProfile

public void addProfile(CloverProfile profile)

validate

public boolean validate()

Implement validation in sub-classes.

getValidationFailureReason

public String getValidationFailureReason()

setValidationFailureReason

protected void setValidationFailureReason(String reason)