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
static class	Requirement.RequirementBuilderNameStep
static class	Requirement.RequirementBuilderTypeStep

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
TestTag	asTag()
int	compareTo(Object otherRequirement)
String	getCardNumber()
List<Requirement>	getChildren()
int	getChildrenCount()
String	getChildType()
String	getDisplayName()
int	getExampleCount()
List<Example>	getExamples()
String	getName()
String	getNarrativeText()
List<Requirement>	getNestedChildren()
String	getType()
boolean	hasChildren()
Boolean	hasExamples()
static Requirement.RequirementBuilderNameStep	named(String name)
Requirement	withChildren(List<Requirement> children)
Requirement	withExample(Example example)
Requirement	withExamples(List<Example> examples)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Requirement

protected Requirement(String name,
           String displayName,
           String cardNumber,
           String type,
           String narrativeText,
           List<Requirement> children,
           List<Example> examples)

Requirement

protected Requirement(String name,
           String displayName,
           String cardNumber,
           String type,
           String narrativeText)

Method Detail

getName

public String getName()

getDisplayName

public String getDisplayName()

getType

public String getType()

getChildType

public String getChildType()

getNarrativeText

public String getNarrativeText()

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 Requirement.RequirementBuilderNameStep named(String name)

withChildren

public Requirement withChildren(List<Requirement> children)

withExample

public Requirement withExample(Example example)

withExamples

public Requirement withExamples(List<Example> examples)

hasChildren

public boolean hasChildren()

getNestedChildren

public List<Requirement> getNestedChildren()

asTag

public TestTag asTag()