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 Description static class
Requirement.CustomFieldSetter
-
Constructor Summary
Constructors Modifier Constructor Description 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)
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)
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)
-
Method Summary
-
-
-
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)
-
-
Method Detail
-
withNoScenarios
public Requirement withNoScenarios()
-
getName
public String getName()
-
getId
public String getId()
-
getDisplayName
public String getDisplayName()
-
getType
public String getType()
-
childType
public String childType()
-
getNarrative
public CustomFieldValue getNarrative()
-
getChildrenCount
public int getChildrenCount()
-
getParent
public String getParent()
-
getChildren
public List<Requirement> getChildren()
-
getChildrenAsStream
public Stream<Requirement> getChildrenAsStream()
-
hasChild
public boolean hasChild(Requirement child)
-
hasExamples
public Boolean hasExamples()
-
getExampleCount
public int getExampleCount()
-
getCardNumber
public String getCardNumber()
-
compareTo
public int compareTo(Object otherRequirement)
- Specified by:
compareTo
in interfaceComparable
-
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)
-
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()
-
getScenarioTags
public Map<String,Collection<TestTag>> getScenarioTags()
-
asTag
public TestTag asTag()
-
asUnqualifiedTag
public TestTag asUnqualifiedTag()
-
matches
public boolean matches(Requirement that)
-
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)
-
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)
-
-