net.thucydides.core.requirements.model

Class Requirement

java.lang.Object

net.thucydides.core.requirements.model.Requirement

All Implemented Interfaces:

Comparable

public class Requirement
extends Object
implements Comparable

A requirement represents a high-level business goal that will appear in the result summary report. This report summarizes the state of the application in terms of what /** have been implemented. Capabilities are implemented via features, which in turn are tested by scenarios.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Requirement.CustomFieldSetter

Constructor Summary

Constructors

Modifier	Constructor and Description
	Requirement()
protected	Requirement(String name, String id, String displayName, String cardNumber, String parent, String type, CustomFieldValue narrative)
protected	Requirement(String name, String id, String displayName, String cardNumber, String parent, String type, CustomFieldValue narrative, List<Requirement> children, List<Example> examples, List<String> releaseVersions)
protected	Requirement(String name, String id, String displayName, String cardNumber, String parent, String type, String path, CustomFieldValue narrative, List<Requirement> children, List<Example> examples, List<String> releaseVersions, List<CustomFieldValue> customFields)
protected	Requirement(String name, String id, String displayName, String cardNumber, String parent, String type, String path, CustomFieldValue narrative, List<Requirement> children, List<Example> examples, List<String> releaseVersions, List<CustomFieldValue> customFields, String featureFileName)
protected	Requirement(String name, String id, String displayName, String cardNumber, String parent, String type, String path, CustomFieldValue narrative, List<Requirement> children, List<Example> examples, List<String> releaseVersions, List<CustomFieldValue> customFields, String featureFileName, List<TestTag> tags, Map<String,Collection<TestTag>> scenarioTags, boolean containsNoScenarios, FeatureBackgroundNarrative background)

Method Summary

Modifier and Type	Method and Description
TestTag	asTag()
TestTag	asUnqualifiedTag()
String	childType()
int	compareTo(Object otherRequirement)
boolean	containsNoScenarios()
Requirement	definedInFile(File featureFile)
boolean	equals(Object o)
FeatureBackgroundNarrative	getBackground()
String	getCardNumber()
List<Requirement>	getChildren()
Stream<Requirement>	getChildrenAsStream()
int	getChildrenCount()
Optional<CustomFieldValue>	getCustomField(String fieldName)
List<String>	getCustomFields()
List<CustomFieldValue>	getCustomFieldValues()
String	getDisplayName()
String	getDisplayName(boolean includeParent)
String	getDisplayNameWithParent()
int	getExampleCount()
List<Example>	getExamples()
String	getFeatureFileName()
String	getId()
String	getName()
CustomFieldValue	getNarrative()
List<Requirement>	getNestedChildren()
String	getOrder()
String	getParent()
String	getPath()
List<String>	getReleaseVersions()
Map<String,Collection<TestTag>>	getScenarioTags()
List<TestTag>	getTags()
String	getType()
boolean	hasChild(Requirement child)
boolean	hasChildren()
Boolean	hasExamples()
int	hashCode()
boolean	hasTag(TestTag tag)
boolean	matches(Requirement that)
boolean	matchesTag(TestTag testTag)
Requirement	merge(Requirement newRequirement)
static RequirementBuilderNameStep	named(String name)
String	qualifiedName()
String	qualifier()
void	setChildren(List<Requirement> children)
void	setParent(String parent)
Stream<Requirement>	stream()
Collection<TestTag>	tagsOfType(List<String> tagTypes)
String	toString()
Requirement	withBackground(FeatureBackgroundNarrative background)
Requirement	withChild(Requirement child)
Requirement	withChildren(List<Requirement> children)
Requirement.CustomFieldSetter	withCustomField(String fieldName)
Requirement	withCustomFields(List<CustomFieldValue> customFields)
Requirement	withDisplayName(String displayName)
Requirement	withExample(Example example)
Requirement	withExamples(List<Example> examples)
Requirement	withFeatureFileyName(String featureFileName)
Requirement	withNarrative(String narrativeText)
Requirement	withNoScenarios()
Requirement	withParent(String parent)
Requirement	withPath(String path)
Requirement	withReleaseVersions(List<String> releaseVersions)
Requirement	withScenarioTags(Map<String,Collection<TestTag>> scenarioTags)
Requirement	withTags(List<TestTag> tags)
Requirement	withType(String type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Requirement

public Requirement()

Requirement

protected Requirement(String name,
                      String id,
                      String displayName,
                      String cardNumber,
                      String parent,
                      String type,
                      CustomFieldValue narrative,
                      List<Requirement> children,
                      List<Example> examples,
                      List<String> releaseVersions)

Requirement

protected Requirement(String name,
                      String id,
                      String displayName,
                      String cardNumber,
                      String parent,
                      String type,
                      CustomFieldValue narrative)

Requirement

protected Requirement(String name,
                      String id,
                      String displayName,
                      String cardNumber,
                      String parent,
                      String type,
                      String path,
                      CustomFieldValue narrative,
                      List<Requirement> children,
                      List<Example> examples,
                      List<String> releaseVersions,
                      List<CustomFieldValue> customFields,
                      String featureFileName)

Requirement

protected Requirement(String name,
                      String id,
                      String displayName,
                      String cardNumber,
                      String parent,
                      String type,
                      String path,
                      CustomFieldValue narrative,
                      List<Requirement> children,
                      List<Example> examples,
                      List<String> releaseVersions,
                      List<CustomFieldValue> customFields,
                      String featureFileName,
                      List<TestTag> tags,
                      Map<String,Collection<TestTag>> scenarioTags,
                      boolean containsNoScenarios,
                      FeatureBackgroundNarrative background)

Requirement

protected Requirement(String name,
                      String id,
                      String displayName,
                      String cardNumber,
                      String parent,
                      String type,
                      String path,
                      CustomFieldValue narrative,
                      List<Requirement> children,
                      List<Example> examples,
                      List<String> releaseVersions,
                      List<CustomFieldValue> customFields)

Method Detail

withNoScenarios

public Requirement withNoScenarios()

getName

public String getName()

getId

public String getId()

getDisplayName

public String getDisplayName()

getDisplayName

public String getDisplayName(boolean includeParent)

getDisplayNameWithParent

public String getDisplayNameWithParent()

getType

public String getType()

childType

public String childType()

getNarrative

public CustomFieldValue getNarrative()

getReleaseVersions

public List<String> getReleaseVersions()

getChildrenCount

public int getChildrenCount()

getParent

public String getParent()

getChildren

public List<Requirement> getChildren()

getChildrenAsStream

public Stream<Requirement> getChildrenAsStream()

hasChild

public boolean hasChild(Requirement child)

getExamples

public List<Example> getExamples()

hasExamples

public Boolean hasExamples()

getExampleCount

public int getExampleCount()

getCardNumber

public String getCardNumber()

compareTo

public int compareTo(Object otherRequirement)

Specified by:

compareTo in interface Comparable

named

public static RequirementBuilderNameStep named(String name)

definedInFile

public Requirement definedInFile(File featureFile)

withChildren

public Requirement withChildren(List<Requirement> children)

setChildren

public void setChildren(List<Requirement> children)

setParent

public void setParent(String parent)

withParent

public Requirement withParent(String parent)

withType

public Requirement withType(String type)

withDisplayName

public Requirement withDisplayName(String displayName)

withFeatureFileyName

public Requirement withFeatureFileyName(String featureFileName)

withExample

public Requirement withExample(Example example)

withExamples

public Requirement withExamples(List<Example> examples)

withReleaseVersions

public Requirement withReleaseVersions(List<String> releaseVersions)

withCustomFields

public Requirement withCustomFields(List<CustomFieldValue> customFields)

withPath

public Requirement withPath(String path)

hasChildren

public boolean hasChildren()

getNestedChildren

public List<Requirement> getNestedChildren()

getTags

public List<TestTag> getTags()

getScenarioTags

public Map<String,Collection<TestTag>> getScenarioTags()

asTag

public TestTag asTag()

asUnqualifiedTag

public TestTag asUnqualifiedTag()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

matches

public boolean matches(Requirement that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

withChild

public Requirement withChild(Requirement child)

withCustomField

public Requirement.CustomFieldSetter withCustomField(String fieldName)

getCustomFieldValues

public List<CustomFieldValue> getCustomFieldValues()

getCustomField

public Optional<CustomFieldValue> getCustomField(String fieldName)

getCustomFields

public List<String> getCustomFields()

getFeatureFileName

public String getFeatureFileName()

qualifiedName

public String qualifiedName()

qualifier

public String qualifier()

matchesTag

public boolean matchesTag(TestTag testTag)

merge

public Requirement merge(Requirement newRequirement)

withNarrative

public Requirement withNarrative(String narrativeText)

getPath

public String getPath()

withTags

public Requirement withTags(List<TestTag> tags)

withScenarioTags

public Requirement withScenarioTags(Map<String,Collection<TestTag>> scenarioTags)

hasTag

public boolean hasTag(TestTag tag)

containsNoScenarios

public boolean containsNoScenarios()

withBackground

public Requirement withBackground(FeatureBackgroundNarrative background)

getBackground

public FeatureBackgroundNarrative getBackground()

getOrder

public String getOrder()

stream

public Stream<Requirement> stream()

tagsOfType

public Collection<TestTag> tagsOfType(List<String> tagTypes)