net.thucydides.core.requirements.model

Class NarrativeReader

java.lang.Object

net.thucydides.core.requirements.model.NarrativeReader

public class NarrativeReader
extends Object

Load a narrative text from a directory. A narrative is a text file that describes a requirement, feature, or epic, or whatever terms you are using in your project. The directory structure itself is used to organize capabilities into features, and so on. At the leaf level, the directory will contain story files (e.g. JBehave stories, JUnit test cases, etc). At each level, a "narrative.txt" file provides a description.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NarrativeReader(String rootDirectory, List<String> requirementTypes)

Method Summary

Modifier and Type	Method and Description
static NarrativeReader	forRootDirectory(EnvironmentVariables environmentVariables, String rootDirectory)
static NarrativeReader	forRootDirectory(String rootDirectory)
Optional<Narrative>	loadFrom(File directory)
Optional<Narrative>	loadFrom(File directory, int requirementsLevel)
Optional<Narrative>	loadFromStoryFile(File storyFile)
NarrativeReader	withRequirementTypes(List<String> requirementTypes)

Methods inherited from class java.lang.Object

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

Constructor Detail

NarrativeReader

protected NarrativeReader(String rootDirectory,
                          List<String> requirementTypes)

Method Detail

forRootDirectory

public static NarrativeReader forRootDirectory(String rootDirectory)

forRootDirectory

public static NarrativeReader forRootDirectory(EnvironmentVariables environmentVariables,
                                               String rootDirectory)

withRequirementTypes

public NarrativeReader withRequirementTypes(List<String> requirementTypes)

loadFrom

public Optional<Narrative> loadFrom(File directory)

loadFrom

public Optional<Narrative> loadFrom(File directory,
                                    int requirementsLevel)

loadFromStoryFile

public Optional<Narrative> loadFromStoryFile(File storyFile)