org.codehaus.mojo.cobertura.configuration
Class ConfigInstrumentation

java.lang.Object
  org.codehaus.mojo.cobertura.configuration.ConfigInstrumentation

public class ConfigInstrumentation
extends Object

The Configuration for the Instrumentation.

Author:

Joakim Erdfelt

Constructor Summary

ConfigInstrumentation()
Construct a new ConfigInstrumentation object.

Method Summary

void	addExclude(String exclude) Add an Exclude to the underlying list.
void	addIgnore(String ignore) Add an Ignore to the underlying list.
void	addIgnoreMethodAnnotation(String ignoreMethodAnnotation) Add an IgnoreMethodAnnotation to the underlying list.
void	addInclude(String include) Add an Include ot the underlying list.
File	getBasedir()
List<String>	getExcludes() Get the Exclude List.
List<String>	getIgnoreMethodAnnotations() Get the ignoreMethodAnnotations setting.
List<String>	getIgnores() Get the Ignore List.
boolean	getIgnoreTrivial() Get the ignoreTrivial setting.
List<String>	getIncludes() Get the Include List.
String	getMaxmem() Get the maxmem setting.
void	setBasedir(File basedir)
void	setIgnoreMethodAnnotations(List<String> ignoreMethodAnnotations) IgnoreMethodAnnotation switch used to specify an annotation that, when present on a method, will cause Cobertura to ignore the method in the coverage report.
void	setIgnoreTrivial(boolean ignoreTrivial) IgnoreTrivial switch that tells Cobertura to ignore the following in the coverage report: Getter methods that simply read a class field; Setter methods that set a class field; Constructors that only set class fields and call a super class constructor.
void	setMaxmem(String maxmem) Sets the max memory for the JVM used to run the InstrumentationTask task.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigInstrumentation

public ConfigInstrumentation()

Construct a new ConfigInstrumentation object.

Method Detail

addExclude

public void addExclude(String exclude)

Add an Exclude to the underlying list.

Parameters:

exclude - the exlude string.

addIgnore

public void addIgnore(String ignore)

Add an Ignore to the underlying list.

Parameters:

ignore - the ignore string.

addIgnoreMethodAnnotation

public void addIgnoreMethodAnnotation(String ignoreMethodAnnotation)

Add an IgnoreMethodAnnotation to the underlying list.

Parameters:

ignoreMethodAnnotation - the ignore string.

addInclude

public void addInclude(String include)

Add an Include ot the underlying list.

Parameters:

include - the include string.

getBasedir

public File getBasedir()

Returns:

Returns the basedir.

getExcludes

public List<String> getExcludes()

Get the Exclude List.

Returns:

the exlude list.

getIgnores

public List<String> getIgnores()

Get the Ignore List.

Returns:

the ignore list.

getIncludes

public List<String> getIncludes()

Get the Include List.

Returns:

the include list.

setBasedir

public void setBasedir(File basedir)

Parameters:

basedir - The basedir to set.

getMaxmem

public String getMaxmem()

Get the maxmem setting.

Returns:

the maxmem setting.

setMaxmem

public void setMaxmem(String maxmem)

Sets the max memory for the JVM used to run the InstrumentationTask task. The format is "". Ex: "64m" where 64 is the value, and "m" denotes megabytes.

Parameters:

maxmem - the value to which maxmem will be set

getIgnoreTrivial

public boolean getIgnoreTrivial()

Get the ignoreTrivial setting.

Returns:

the ignoreTrivial setting.

setIgnoreTrivial

public void setIgnoreTrivial(boolean ignoreTrivial)

IgnoreTrivial switch that tells Cobertura to ignore the following in the coverage report: Getter methods that simply read a class field; Setter methods that set a class field; Constructors that only set class fields and call a super class constructor.

Parameters:

ignoreTrivial - enable ignoreTrivial

getIgnoreMethodAnnotations

public List<String> getIgnoreMethodAnnotations()

Get the ignoreMethodAnnotations setting.

Returns:

the ignoreMethodAnnotations setting.

setIgnoreMethodAnnotations

public void setIgnoreMethodAnnotations(List<String> ignoreMethodAnnotations)

IgnoreMethodAnnotation switch used to specify an annotation that, when present on a method, will cause Cobertura to ignore the method in the coverage report.

Parameters:

ignoreMethodAnnotations -

toString

public String toString()

Overrides:

toString in class Object