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 capability 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 capabilities 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
class	Requirement.CustomFieldSetter

Constructor Summary

Constructors

Modifier	Constructor and Description
	Requirement()
protected	Requirement(String name, String displayName, String cardNumber, String type, CustomFieldValue narrative)
protected	Requirement(String name, String displayName, String cardNumber, String type, CustomFieldValue narrative, List<Requirement> children, List<Example> examples, List<String> releaseVersions)
protected	Requirement(String name, String displayName, String cardNumber, String type, CustomFieldValue narrative, List<Requirement> children, List<Example> examples, List<String> releaseVersions, List<CustomFieldValue> customFields)

Method Summary

Methods

Modifier and Type	Method and Description
TestTag	asTag()
String	childType()
int	compareTo(Object otherRequirement)
boolean	equals(Object o)
String	getCardNumber()
List<Requirement>	getChildren()
int	getChildrenCount()
com.google.common.base.Optional<CustomFieldValue>	getCustomField(String fieldName)
List<String>	getCustomFields()
List<CustomFieldValue>	getCustomFieldValues()
String	getDisplayName()
int	getExampleCount()
List<Example>	getExamples()
String	getName()
CustomFieldValue	getNarrative()
List<Requirement>	getNestedChildren()
List<String>	getReleaseVersions()
String	getType()
boolean	hasChildren()
Boolean	hasExamples()
int	hashCode()
static RequirementBuilderNameStep	named(String name)
String	toString()
Requirement	withChild(Requirement child)
Requirement	withChildren(List<Requirement> children)
Requirement.CustomFieldSetter	withCustomField(String fieldName)
Requirement	withExample(Example example)
Requirement	withExamples(List<Example> examples)
Requirement	withReleaseVersions(List<String> releaseVersions)

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 displayName,
           String cardNumber,
           String type,
           CustomFieldValue narrative,
           List<Requirement> children,
           List<Example> examples,
           List<String> releaseVersions)

Requirement

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

Requirement

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

Method Detail

getName

public String getName()

getDisplayName

public String getDisplayName()

getType

public String getType()

childType

public String childType()

getNarrative

public CustomFieldValue getNarrative()

getReleaseVersions

public List<String> getReleaseVersions()

getChildrenCount

public int getChildrenCount()

getChildren

public List<Requirement> getChildren()

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)

withChildren

public Requirement withChildren(List<Requirement> children)

withExample

public Requirement withExample(Example example)

withExamples

public Requirement withExamples(List<Example> examples)

withReleaseVersions

public Requirement withReleaseVersions(List<String> releaseVersions)

hasChildren

public boolean hasChildren()

getNestedChildren

public List<Requirement> getNestedChildren()

asTag

public TestTag asTag()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

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 com.google.common.base.Optional<CustomFieldValue> getCustomField(String fieldName)

getCustomFields

public List<String> getCustomFields()