net.masterthought.cucumber

Class Configuration

java.lang.Object

net.masterthought.cucumber.Configuration

public class Configuration
extends Object

Constructor Summary

Constructors

Constructor and Description
Configuration(File reportOutputDirectory, String projectName)

Method Summary

Modifier and Type	Method and Description
void	addClassifications(String name, String value) Adds metadata that will be displayed at the main page of the report.
String	getBuildNumber()
List<Map.Entry<String,String>>	getClassifications() Returns the classification for the report.
File	getEmbeddingDirectory()
String	getProjectName()
File	getReportDirectory()
SortingMethod	getSortingMethod() Returns the default sorting method.
Collection<Pattern>	getTagsToExcludeFromChart()
int	getTrendsLimit()
File	getTrendsStatsFile()
boolean	isParallelTesting()
boolean	isRunWithJenkins()
boolean	isTrendsStatsFile() Checks if the file for the trends was set.
void	setBuildNumber(String buildNumber) Sets number of the build.
void	setParallelTesting(boolean parallelTesting)
void	setRunWithJenkins(boolean runWithJenkins)
void	setSortingMethod(SortingMethod sortingMethod) Configure how items will be sorted in the report by default.
void	setTagsToExcludeFromChart(String... patterns) Stores the regex patterns to be used for filtering out tags from the 'Tags Overview' chart
void	setTrends(File trendsFile, int trendsLimit) Sets configuration for trends.
void	setTrendsStatsFile(File trendsFile) Calls setTrends(File, int) with zero limit.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration(File reportOutputDirectory,
                     String projectName)

Method Detail

isParallelTesting

public boolean isParallelTesting()

setParallelTesting

public void setParallelTesting(boolean parallelTesting)

isRunWithJenkins

public boolean isRunWithJenkins()

setRunWithJenkins

public void setRunWithJenkins(boolean runWithJenkins)

getReportDirectory

public File getReportDirectory()

getTrendsStatsFile

public File getTrendsStatsFile()

isTrendsStatsFile

public boolean isTrendsStatsFile()

Checks if the file for the trends was set.

Returns:

true if the file location was provided, otherwise false

setTrendsStatsFile

public void setTrendsStatsFile(File trendsFile)

Calls setTrends(File, int) with zero limit.

Parameters:

trendsFile - file with trends

getTrendsLimit

public int getTrendsLimit()

setTrends

public void setTrends(File trendsFile,
                      int trendsLimit)

Sets configuration for trends. When the limit is set to 0 then all items will be displayed.

Parameters:

trendsFile - file where information about previous builds is stored

trendsLimit - number of builds that should be presented (older builds are skipped)

getBuildNumber

public String getBuildNumber()

setBuildNumber

public void setBuildNumber(String buildNumber)

Sets number of the build. If the {setRunWithJenkins(boolean) executed on Jenkins}, this should be integer value so the number of previous build can be calculated properly.

Parameters:

buildNumber - number of the build

getProjectName

public String getProjectName()

getEmbeddingDirectory

public File getEmbeddingDirectory()

getTagsToExcludeFromChart

public Collection<Pattern> getTagsToExcludeFromChart()

Returns:

Patterns to be used to filter out tags in the 'Tags Overview' chart. Returns an empty list by default.

setTagsToExcludeFromChart

public void setTagsToExcludeFromChart(String... patterns)

Stores the regex patterns to be used for filtering out tags from the 'Tags Overview' chart

Parameters:

patterns - Regex patterns to match against tags

Throws:

ValidationException - when any of the given strings is not a valid regex pattern.

addClassifications

public void addClassifications(String name,
                               String value)

Adds metadata that will be displayed at the main page of the report. It is useful when there is a few reports are generated at the same time but with different parameters/configurations.

Parameters:

name - name of the property

value - value of the property

getClassifications

public List<Map.Entry<String,String>> getClassifications()

Returns the classification for the report.

setSortingMethod

public void setSortingMethod(SortingMethod sortingMethod)

Configure how items will be sorted in the report by default.

Parameters:

sortingMethod - how the items should be sorted

getSortingMethod

public SortingMethod getSortingMethod()

Returns the default sorting method.