net.thucydides.core.model

Class Story

java.lang.Object

net.thucydides.core.model.Story

public class Story
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Story.RequirementType

Constructor Summary

Constructors

Constructor and Description
Story(java.lang.String id, java.lang.String storyName, java.lang.String storyClassName, java.lang.String path, ApplicationFeature feature)
Story(java.lang.String id, java.lang.String storyName, java.lang.String storyClassName, java.lang.String path, ApplicationFeature feature, java.lang.String narrative)
Story(java.lang.String id, java.lang.String storyName, java.lang.String storyClassName, java.lang.String path, ApplicationFeature feature, java.lang.String narrative, Story.RequirementType type)

Method Summary

Modifier and Type	Method and Description
Story	asFeature()
TestTag	asTag()
static Story	called(java.lang.String storyName)
boolean	equals(java.lang.Object o)
static Story	from(java.lang.Class<?> userStoryClass) Obtain a story instance from a given story class.
ApplicationFeature	getFeature()
static java.lang.Class<?>	getFeatureClass(java.lang.Class<?> userStoryClass) What feature does this story belong to?
java.lang.String	getId()
java.lang.String	getName() Each story has a descriptive name.
java.lang.String	getNarrative()
java.lang.String	getPath()
java.lang.String	getReportName()
java.lang.String	getReportName(ReportType type) Find the name of the report for this story for the specified report type (XML, HTML,...).
java.lang.String	getStoryClassName()
java.lang.String	getStoryName()
Story.RequirementType	getType()
int	hashCode()
static java.lang.Class<?>	testedInTestCase(java.lang.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(java.lang.String storyId, java.lang.String storyName) Create a story using a full class name as an id.
static Story	withId(java.lang.String storyId, java.lang.String storyName, java.lang.String featureClassName, java.lang.String featureName)
static Story	withIdAndPath(java.lang.String storyId, java.lang.String storyName, java.lang.String storyPath)
static Story	withIdAndPathAndFeature(java.lang.String storyId, java.lang.String storyName, java.lang.String storyPath, java.lang.String featureClassName, java.lang.String featureName)
Story	withNarrative(java.lang.String narrative)
Story	withPath(java.lang.String storyPath)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Story

public Story(java.lang.String id,
             java.lang.String storyName,
             java.lang.String storyClassName,
             java.lang.String path,
             ApplicationFeature feature)

Story

public Story(java.lang.String id,
             java.lang.String storyName,
             java.lang.String storyClassName,
             java.lang.String path,
             ApplicationFeature feature,
             java.lang.String narrative)

Story

public Story(java.lang.String id,
             java.lang.String storyName,
             java.lang.String storyClassName,
             java.lang.String path,
             ApplicationFeature feature,
             java.lang.String narrative,
             Story.RequirementType type)

Method Detail

getId

public java.lang.String getId()

from

public static Story from(java.lang.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(java.lang.String storyId,
                           java.lang.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(java.lang.String narrative)

withIdAndPath

public static Story withIdAndPath(java.lang.String storyId,
                                  java.lang.String storyName,
                                  java.lang.String storyPath)

called

public static Story called(java.lang.String storyName)

withId

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

withIdAndPathAndFeature

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getFeatureClass

public static java.lang.Class<?> getFeatureClass(java.lang.Class<?> userStoryClass)

What feature does this story belong to?

testedInTestCase

public static java.lang.Class<?> testedInTestCase(java.lang.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 java.lang.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.

getStoryClassName

public java.lang.String getStoryClassName()

getReportName

public java.lang.String getReportName(ReportType type)

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

getReportName

public java.lang.String getReportName()

getFeature

public ApplicationFeature getFeature()

getPath

public java.lang.String getPath()

getStoryName

public java.lang.String getStoryName()

getNarrative

public java.lang.String getNarrative()

getType

public Story.RequirementType getType()

withPath

public Story withPath(java.lang.String storyPath)

asFeature

public Story asFeature()

asTag

public TestTag asTag()