Package net.thucydides.core.requirements.model

Class NarrativeReader

java.lang.Object
net.thucydides.core.requirements.model.NarrativeReader
public class NarrativeReader
extends java.lang.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 Description
    protected NarrativeReader​(java.lang.String rootDirectory, java.util.List<java.lang.String> requirementTypes)  

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • NarrativeReader

      protected NarrativeReader​(java.lang.String rootDirectory, java.util.List<java.lang.String> requirementTypes)

  • Method Details

    • forRootDirectory

      public static NarrativeReader forRootDirectory​(java.lang.String rootDirectory)

    • forRootDirectory

      public static NarrativeReader forRootDirectory​(EnvironmentVariables environmentVariables, java.lang.String rootDirectory)

    • withRequirementTypes

      public NarrativeReader withRequirementTypes​(java.util.List<java.lang.String> requirementTypes)

    • loadFrom

      public java.util.Optional<Narrative> loadFrom​(java.io.File directory)

    • loadFrom

      public java.util.Optional<Narrative> loadFrom​(java.io.File directory, int requirementsLevel)

    • loadFromStoryFile

      public java.util.Optional<Narrative> loadFromStoryFile​(java.io.File storyFile)