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

protected

NarrativeReader(String rootDirectory, List<String> requirementTypes)

Method Summary

static NarrativeReader	forRootDirectory(String rootDirectory)
com.google.common.base.Optional<Narrative>	loadFrom(File directory)
com.google.common.base.Optional<Narrative>	loadFrom(File directory, int requirementsLevel)
com.google.common.base.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)

withRequirementTypes

public NarrativeReader withRequirementTypes(List<String> requirementTypes)

loadFrom

public com.google.common.base.Optional<Narrative> loadFrom(File directory)

loadFrom

public com.google.common.base.Optional<Narrative> loadFrom(File directory,
                                                           int requirementsLevel)

loadFromStoryFile

public com.google.common.base.Optional<Narrative> loadFromStoryFile(File storyFile)