net.thucydides.core.model

Class Story

java.lang.Object

net.thucydides.core.model.Story

public class Story
extends Object

Represents a given user story or feature. Used to record test results and so on.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Story(Class<?> userStoryClass)
protected	Story(String id, String storyName, String displayName, ApplicationFeature feature, String path)
	Story(String id, String storyName, String storyClassName, String displayName, String path, ApplicationFeature feature)
	Story(String id, String storyName, String storyClassName, String displayName, String path, ApplicationFeature feature, String narrative)
	Story(String id, String storyName, String storyClassName, String displayName, String path, ApplicationFeature feature, String narrative, String type)

Method Summary

Modifier and Type	Method and Description
Story	asFeature()
TestTag	asQualifiedTag()
TestTag	asTag()
static Story	called(String storyName)
boolean	equals(Object o)
static Story	from(Class<?> userStoryClass) Obtain a story instance from a given story class.
String	getDisplayName()
ApplicationFeature	getFeature()
static Class<?>	getFeatureClass(Class<?> userStoryClass) What feature does this story belong to?
String	getId()
String	getName() Each story has a descriptive name.
String	getNarrative()
String	getNarrativeSummary()
String	getPath()
String	getReportName()
String	getReportName(ReportType type) Find the name of the report for this story for the specified report type (XML, HTML,...).
String	getStoryClassName()
String	getStoryName()
String	getType()
int	hashCode()
static Class<?>	testedInTestCase(Class<?> testClass) Returns the class representing the story that is tested by a given test class This is indicated by the Story annotation.
static Story	withId(String storyId, String storyName) Create a story using a full class name as an id.
static Story	withId(String storyId, String storyName, String featureClassName, String featureName)
static Story	withIdAndPath(String storyId, String storyName, String storyPath)
static Story	withIdAndPathAndFeature(String storyId, String storyName, String storyPath, String featureClassName, String featureName)
Story	withNarrative(String narrative)
Story	withPath(String path)
Story	withType(String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

Story

protected Story(Class<?> userStoryClass)

Story

public Story(String id,
             String storyName,
             String storyClassName,
             String displayName,
             String path,
             ApplicationFeature feature)

Story

public Story(String id,
             String storyName,
             String storyClassName,
             String displayName,
             String path,
             ApplicationFeature feature,
             String narrative)

Story

public Story(String id,
             String storyName,
             String storyClassName,
             String displayName,
             String path,
             ApplicationFeature feature,
             String narrative,
             String type)

Story

protected Story(String id,
                String storyName,
                String displayName,
                ApplicationFeature feature,
                String path)

Method Detail

getId

public String getId()

from

public static Story from(Class<?> userStoryClass)

Obtain a story instance from a given story class. Story instances are used for recording and reporting test results.

withId

public static Story withId(String storyId,
                           String storyName)

Create a story using a full class name as an id. Note that the class may no longer exist, so the story needs to be able to exist beyond the life of the original story class. This is used to deserialize stories from XML files.

withNarrative

public Story withNarrative(String narrative)

withType

public Story withType(String type)

withIdAndPath

public static Story withIdAndPath(String storyId,
                                  String storyName,
                                  String storyPath)

called

public static Story called(String storyName)

withId

public static Story withId(String storyId,
                           String storyName,
                           String featureClassName,
                           String featureName)

withIdAndPathAndFeature

public static Story withIdAndPathAndFeature(String storyId,
                                            String storyName,
                                            String storyPath,
                                            String featureClassName,
                                            String featureName)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFeatureClass

public static Class<?> getFeatureClass(Class<?> userStoryClass)

What feature does this story belong to?

testedInTestCase

public static Class<?> testedInTestCase(Class<?> testClass)

Returns the class representing the story that is tested by a given test class This is indicated by the Story annotation.

getName

public String getName()

Each story has a descriptive name. This name is usually a human-readable version of the class name, or the story name for an easyb story.

getDisplayName

public String getDisplayName()

getStoryClassName

public String getStoryClassName()

getReportName

public String getReportName(ReportType type)

Find the name of the report for this story for the specified report type (XML, HTML,...).

getReportName

public String getReportName()

getFeature

public ApplicationFeature getFeature()

getPath

public String getPath()

getStoryName

public String getStoryName()

getNarrative

public String getNarrative()

getNarrativeSummary

public String getNarrativeSummary()

getType

public String getType()

withPath

public Story withPath(String path)

asFeature

public Story asFeature()

asTag

public TestTag asTag()

asQualifiedTag

public TestTag asQualifiedTag()