org.xenei.contracts.maven

Class ReportConfig

java.lang.Object

org.xenei.contracts.maven.ReportConfig

public class ReportConfig
extends java.lang.Object

Configuration for a report

Constructor Summary

Constructors

Constructor and Description
ReportConfig() Constructor

Method Summary

Modifier and Type	Method and Description
org.xenei.classpathutils.ClassPathFilter	getFilter() Gets the filter
boolean	isFailOnError() Returns true if this report generates a build error on errors.
boolean	isReporting() Returns true if this report is enabled.
void	setFailOnError(boolean failOnError) If true the build will fail on an error in this report.
void	setFilter(java.lang.String filter) Set the class filter.
void	setReport(boolean reporting) If true this report will be generated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportConfig

public ReportConfig()

Constructor

Method Detail

setReport

public void setReport(boolean reporting)

If true this report will be generated. Defaults to true

Parameters:

reporting - true if this report should be generated.

setFailOnError

public void setFailOnError(boolean failOnError)

If true the build will fail on an error in this report. Defaults to false

Parameters:

failOnError - if true the build will fail on error.

isReporting

public boolean isReporting()

Returns true if this report is enabled.

Returns:

returns true if this report is enabled.

isFailOnError

public boolean isFailOnError()

Returns true if this report generates a build error on errors.

Returns:

true if this report generates a build error on errors.

getFilter

public org.xenei.classpathutils.ClassPathFilter getFilter()

Gets the filter

Returns:

the filter.

setFilter

public void setFilter(java.lang.String filter)
               throws java.lang.IllegalArgumentException

Set the class filter. Only classes that pass the filter will be included. By default the filter accepts all classes. Passing a null or null length string will result in all classes passing the test.

Parameters:

filter - The string representation of the filter. May be null.

Throws:

java.lang.IllegalArgumentException - if the filter can not be parsed.