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 reportDirectory, String projectName)

Method Summary

Modifier and Type	Method and Description
void	addClassificationFiles(List<String> classificationFiles) Adds properties files which house classifications in key value pairings.
void	addClassifications(String name, String value) Adds metadata that will be displayed at the main page of the report.
void	addReducingMethod(ReducingMethod reducingMethod) Sets how the report should or reduced, merged or modified.
boolean	containsReducingMethod(ReducingMethod reducingMethod) Checks if the configuration has given ReducingMethod set.
String	getBuildNumber() Gets the build number for this report.
List<String>	getClassificationFiles() Returns the list of properties files.
List<Map.Entry<String,String>>	getClassifications() Returns the classification for the report.
File	getEmbeddingDirectory() Gets directory where the attachments are stored.
String	getProjectName() Returns the project name.
List<ReducingMethod>	getReducingMethods() Gets how the report should be reduced, merged or modified.
File	getReportDirectory() Returns directory where the report should be stored.
SortingMethod	getSortingMethod() Returns the default sorting method.
Collection<Pattern>	getTagsToExcludeFromChart()
int	getTrendsLimit() Returns number of historical reports presented by trends.
File	getTrendsStatsFile() Returns file with history with trends.
boolean	isRunWithJenkins() Validates if the configuration is prepared to be run on Jenkins.
boolean	isTrendsAvailable() Checks if the trends page should be generated and displayed.
boolean	isTrendsStatsFile() Checks if the file for the trends was set.
void	setBuildNumber(String buildNumber) Sets number of the build.
void	setRunWithJenkins(boolean runWithJenkins) Desides if the configuration is prepared to be run on Jenkins.
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 limit) 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 reportDirectory,
                     String projectName)

Method Detail

isRunWithJenkins

public boolean isRunWithJenkins()

Validates if the configuration is prepared to be run on Jenkins.

Returns:

true if running on Jenkins, false otherwise

setRunWithJenkins

public void setRunWithJenkins(boolean runWithJenkins)

Desides if the configuration is prepared to be run on Jenkins.

Parameters:

runWithJenkins - true if running on Jenkins, false otherwise

getReportDirectory

public File getReportDirectory()

Returns directory where the report should be stored.

Returns:

directory for the report

getTrendsStatsFile

public File getTrendsStatsFile()

Returns file with history with trends.

Returns:

file with trends

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()

Returns number of historical reports presented by trends.

Returns:

number of reports in trends

isTrendsAvailable

public boolean isTrendsAvailable()

Checks if the trends page should be generated and displayed.

Returns:

true if the page with trends should be displayed

setTrends

public void setTrends(File trendsFile,
                      int limit)

Sets configuration for trends. When the limit is set to 0 then all items will be stored and displayed. To disable saving and displaying trends page set to 0.

Parameters:

trendsFile - file where information about previous builds is stored

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

getBuildNumber

public String getBuildNumber()

Gets the build number for this report.

Returns:

build number

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()

Returns the project name.

Returns:

name of the project

getEmbeddingDirectory

public File getEmbeddingDirectory()

Gets directory where the attachments are stored.

Returns:

directory for attachment

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.

addReducingMethod

public void addReducingMethod(ReducingMethod reducingMethod)

Sets how the report should or reduced, merged or modified.

Parameters:

reducingMethod - type of reduction

getReducingMethods

public List<ReducingMethod> getReducingMethods()

Gets how the report should be reduced, merged or modified.

Returns:

type or reduction

containsReducingMethod

public boolean containsReducingMethod(ReducingMethod reducingMethod)

Checks if the configuration has given ReducingMethod set.

Parameters:

reducingMethod - method to validate

Returns:

true if method was set, otherwise false

addClassificationFiles

public void addClassificationFiles(List<String> classificationFiles)

Adds properties files which house classifications in key value pairings. When these properties files get processed these classifications get displayed on the main page of the report as metadata in the order in which they appear within the file.

getClassificationFiles

public List<String> getClassificationFiles()

Returns the list of properties files.