Class Requirement
java.lang.Object
net.thucydides.core.requirements.model.Requirement
- All Implemented Interfaces:
java.lang.Comparable
public class Requirement
extends java.lang.Object
implements java.lang.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 Description static class
Requirement.CustomFieldSetter
-
Constructor Summary
Constructors Modifier Constructor Description Requirement()
protected
Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, java.lang.String path, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions, java.util.List<CustomFieldValue> customFields)
protected
Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, java.lang.String path, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions, java.util.List<CustomFieldValue> customFields, java.lang.String featureFileName)
protected
Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, java.lang.String path, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions, java.util.List<CustomFieldValue> customFields, java.lang.String featureFileName, java.util.List<TestTag> tags, java.util.Map<java.lang.String,java.util.Collection<TestTag>> scenarioTags, boolean containsNoScenarios, FeatureBackgroundNarrative background)
protected
Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, CustomFieldValue narrative)
protected
Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions)
-
Method Summary
Modifier and Type Method Description TestTag
asTag()
TestTag
asUnqualifiedTag()
java.lang.String
childType()
int
compareTo(java.lang.Object otherRequirement)
boolean
containsNoScenarios()
Requirement
definedInFile(java.io.File featureFile)
boolean
equals(java.lang.Object o)
FeatureBackgroundNarrative
getBackground()
java.lang.String
getCardNumber()
java.util.List<Requirement>
getChildren()
java.util.stream.Stream<Requirement>
getChildrenAsStream()
int
getChildrenCount()
java.util.Optional<CustomFieldValue>
getCustomField(java.lang.String fieldName)
java.util.List<java.lang.String>
getCustomFields()
java.util.List<CustomFieldValue>
getCustomFieldValues()
java.lang.String
getDisplayName()
int
getExampleCount()
java.util.List<Example>
getExamples()
java.lang.String
getFeatureFileName()
java.lang.String
getId()
java.lang.String
getName()
CustomFieldValue
getNarrative()
java.util.List<Requirement>
getNestedChildren()
java.lang.String
getOrder()
java.lang.String
getParent()
java.lang.String
getPath()
java.util.List<java.lang.String>
getReleaseVersions()
java.util.Map<java.lang.String,java.util.Collection<TestTag>>
getScenarioTags()
java.util.List<TestTag>
getTags()
java.lang.String
getType()
boolean
hasChild(Requirement child)
boolean
hasChildren()
java.lang.Boolean
hasExamples()
int
hashCode()
boolean
hasTag(TestTag tag)
boolean
matches(Requirement that)
boolean
matchesTag(TestTag testTag)
Requirement
merge(Requirement newRequirement)
static RequirementBuilderNameStep
named(java.lang.String name)
java.lang.String
qualifiedName()
java.lang.String
qualifier()
void
setChildren(java.util.List<Requirement> children)
java.util.stream.Stream<Requirement>
stream()
java.util.Collection<TestTag>
tagsOfType(java.util.List<java.lang.String> tagTypes)
java.lang.String
toString()
Requirement
withBackground(FeatureBackgroundNarrative background)
Requirement
withChild(Requirement child)
Requirement
withChildren(java.util.List<Requirement> children)
Requirement.CustomFieldSetter
withCustomField(java.lang.String fieldName)
Requirement
withCustomFields(java.util.List<CustomFieldValue> customFields)
Requirement
withDisplayName(java.lang.String displayName)
Requirement
withExample(Example example)
Requirement
withExamples(java.util.List<Example> examples)
Requirement
withFeatureFileyName(java.lang.String featureFileName)
Requirement
withNarrative(java.lang.String narrativeText)
Requirement
withNoScenarios()
Requirement
withParent(java.lang.String parent)
Requirement
withPath(java.lang.String path)
Requirement
withReleaseVersions(java.util.List<java.lang.String> releaseVersions)
Requirement
withScenarioTags(java.util.Map<java.lang.String,java.util.Collection<TestTag>> scenarioTags)
Requirement
withTags(java.util.List<TestTag> tags)
Requirement
withType(java.lang.String type)
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
Requirement
public Requirement() -
Requirement
protected Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions) -
Requirement
protected Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, CustomFieldValue narrative) -
Requirement
protected Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, java.lang.String path, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions, java.util.List<CustomFieldValue> customFields, java.lang.String featureFileName) -
Requirement
protected Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, java.lang.String path, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions, java.util.List<CustomFieldValue> customFields, java.lang.String featureFileName, java.util.List<TestTag> tags, java.util.Map<java.lang.String,java.util.Collection<TestTag>> scenarioTags, boolean containsNoScenarios, FeatureBackgroundNarrative background) -
Requirement
protected Requirement(java.lang.String name, java.lang.String id, java.lang.String displayName, java.lang.String cardNumber, java.lang.String parent, java.lang.String type, java.lang.String path, CustomFieldValue narrative, java.util.List<Requirement> children, java.util.List<Example> examples, java.util.List<java.lang.String> releaseVersions, java.util.List<CustomFieldValue> customFields)
-
-
Method Details
-
withNoScenarios
-
getName
public java.lang.String getName() -
getId
public java.lang.String getId() -
getDisplayName
public java.lang.String getDisplayName() -
getType
public java.lang.String getType() -
childType
public java.lang.String childType() -
getNarrative
-
getReleaseVersions
public java.util.List<java.lang.String> getReleaseVersions() -
getChildrenCount
public int getChildrenCount() -
getParent
public java.lang.String getParent() -
getChildren
-
getChildrenAsStream
-
hasChild
-
getExamples
-
hasExamples
public java.lang.Boolean hasExamples() -
getExampleCount
public int getExampleCount() -
getCardNumber
public java.lang.String getCardNumber() -
compareTo
public int compareTo(java.lang.Object otherRequirement)- Specified by:
compareTo
in interfacejava.lang.Comparable
-
named
-
definedInFile
-
withChildren
-
setChildren
-
withParent
-
withType
-
withDisplayName
-
withFeatureFileyName
-
withExample
-
withExamples
-
withReleaseVersions
-
withCustomFields
-
withPath
-
hasChildren
public boolean hasChildren() -
getNestedChildren
-
getTags
-
getScenarioTags
-
asTag
-
asUnqualifiedTag
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
matches
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
withChild
-
withCustomField
-
getCustomFieldValues
-
getCustomField
-
getCustomFields
public java.util.List<java.lang.String> getCustomFields() -
getFeatureFileName
public java.lang.String getFeatureFileName() -
qualifiedName
public java.lang.String qualifiedName() -
qualifier
public java.lang.String qualifier() -
matchesTag
-
merge
-
withNarrative
-
getPath
public java.lang.String getPath() -
withTags
-
withScenarioTags
public Requirement withScenarioTags(java.util.Map<java.lang.String,java.util.Collection<TestTag>> scenarioTags) -
hasTag
-
containsNoScenarios
public boolean containsNoScenarios() -
withBackground
-
getBackground
-
getOrder
public java.lang.String getOrder() -
stream
-
tagsOfType
-