Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- accepted - Enum constant in enum class net.tangly.spec.req.Requirement.Status
- addScene(Scene) - Method in class net.tangly.spec.bdd.engine.StoryRun
- afterAll(ExtensionContext) - Method in class net.tangly.spec.bdd.engine.StoryExtension
- and(String, Consumer<Scene>) - Method in class net.tangly.spec.bdd.Phase
- and(String, Consumer<Scene>) - Method in class net.tangly.spec.bdd.Scene
- AND - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- ands() - Method in class net.tangly.spec.bdd.Phase
B
- BDD_REPORTS_FOLDER - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- BddConstants - Class in net.tangly.spec.bdd.engine
-
JSON field identifiers used to generate a JSON representation of stories and features.
- beforeAll(ExtensionContext) - Method in class net.tangly.spec.bdd.engine.StoryExtension
- beforeEach(ExtensionContext) - Method in class net.tangly.spec.bdd.engine.StoryExtension
C
- CLASS_NAME - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- clazz() - Method in class net.tangly.spec.bdd.engine.StoryRun
D
- description() - Method in class net.tangly.spec.bdd.engine.StoryRun
- description() - Element in annotation interface net.tangly.spec.bdd.Feature
-
Return the detailed description of the story as human-readable information for living documentation.
- description() - Method in class net.tangly.spec.bdd.Scene
- description() - Element in annotation interface net.tangly.spec.bdd.Story
-
Return the detailed description of the story as human-readable information for living documentation.
- DESCRIPTION - Static variable in class net.tangly.spec.bdd.engine.BddConstants
E
- EXT - Static variable in class net.tangly.spec.bdd.engine.BddConstants
F
- Feature - Annotation Interface in net.tangly.spec.bdd
-
A feature or a story describes the behavior of the build system.
- featureDescription() - Method in class net.tangly.spec.bdd.engine.StoryRun
- featureId() - Method in class net.tangly.spec.bdd.engine.StoryRun
- featureName() - Method in class net.tangly.spec.bdd.engine.StoryRun
- featureTags() - Method in class net.tangly.spec.bdd.engine.StoryRun
- findSceneByMethodName(String) - Method in class net.tangly.spec.bdd.engine.StoryRun
G
- get(String) - Method in class net.tangly.spec.bdd.Scene
- getOrCreateBddReportsFolder(Class<?>) - Static method in class net.tangly.spec.bdd.engine.StoryWriter
- given() - Method in class net.tangly.spec.bdd.Scene
- given(String, Consumer<Scene>) - Method in class net.tangly.spec.bdd.Scene
- GIVEN - Static variable in class net.tangly.spec.bdd.engine.BddConstants
H
- high - Enum constant in enum class net.tangly.spec.req.Risk.RiskLevel
I
- id() - Method in class net.tangly.spec.bdd.engine.StoryRun
- id() - Element in annotation interface net.tangly.spec.bdd.Feature
-
Return the identifier of the feature.
- id() - Element in annotation interface net.tangly.spec.bdd.Story
-
Return the identifier of the story.
- id() - Method in interface net.tangly.spec.req.Reference
- id() - Method in interface net.tangly.spec.req.Requirement
- id() - Method in interface net.tangly.spec.req.Risk
- id() - Method in interface net.tangly.spec.req.Section
- ID - Static variable in class net.tangly.spec.bdd.engine.BddConstants
K
L
- lambda() - Method in class net.tangly.spec.bdd.Phase
- low - Enum constant in enum class net.tangly.spec.req.Risk.RiskLevel
M
- medium - Enum constant in enum class net.tangly.spec.req.Risk.RiskLevel
- merge(Path) - Method in class net.tangly.spec.bdd.engine.StoryMerger
-
Merges all BDD reports in the given directory into one file.
- METHOD_NAME - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- methodName() - Method in class net.tangly.spec.bdd.Scene
- mitigate - Enum constant in enum class net.tangly.spec.req.Reference.ReferenceKind
N
- name() - Method in class net.tangly.spec.bdd.engine.StoryRun
- NAME - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- net.tangly.bdd - module net.tangly.bdd
- net.tangly.spec.bdd - package net.tangly.spec.bdd
-
Provides the abstractions to write behaviour driven design tests based on JUnit 5.
- net.tangly.spec.bdd.engine - package net.tangly.spec.bdd.engine
-
Provides the implementation of a behaviour driven design library based on the extension model of JUnit 5.
- net.tangly.spec.req - package net.tangly.spec.req
O
- obsolete - Enum constant in enum class net.tangly.spec.req.Requirement.Status
- open - Enum constant in enum class net.tangly.spec.req.Requirement.Status
P
- PACKAGE_NAME - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- packages() - Method in class net.tangly.spec.bdd.engine.StoryRun
- Phase - Class in net.tangly.spec.bdd
-
Represents a phase in a scene such as a given, when or then phase for the acceptance test modeled within the scene.
- Phase(String, Consumer<Scene>) - Constructor for class net.tangly.spec.bdd.Phase
- put(String, Object) - Method in class net.tangly.spec.bdd.Scene
R
- reference - Enum constant in enum class net.tangly.spec.req.Reference.ReferenceKind
- Reference - Interface in net.tangly.spec.req
- Reference.ReferenceKind - Enum Class in net.tangly.spec.req
- refine - Enum constant in enum class net.tangly.spec.req.Reference.ReferenceKind
- rejected - Enum constant in enum class net.tangly.spec.req.Requirement.Status
- Requirement - Interface in net.tangly.spec.req
- Requirement.Status - Enum Class in net.tangly.spec.req
- resolveParameter(ParameterContext, ExtensionContext) - Method in class net.tangly.spec.bdd.engine.StoryExtension
-
Inject the previously created scene object into the test method.
- Risk - Interface in net.tangly.spec.req
- Risk.RiskLevel - Enum Class in net.tangly.spec.req
- run() - Method in class net.tangly.spec.bdd.Scene
S
- Scenario - Annotation Interface in net.tangly.spec.bdd
-
Represents a use case in a
Story
. - SCENARIOS - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- Scene - Class in net.tangly.spec.bdd
-
A scene is central to BDD or specification by example style of writing tests.
- Scene(Method) - Constructor for class net.tangly.spec.bdd.Scene
- scenes() - Method in class net.tangly.spec.bdd.engine.StoryRun
- Section - Interface in net.tangly.spec.req
- sections() - Method in interface net.tangly.spec.req.Section
- STORIES - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- Story - Annotation Interface in net.tangly.spec.bdd
-
Represents a story in BDD or specification by example style of writing tests.
- StoryAsciiDocPublisher - Class in net.tangly.spec.bdd.engine
-
The publisher creates a AsciiDoc report of the behavior-driven design tests documentation generated as JSON during JUnit 5 runs.
- StoryAsciiDocPublisher(Path, Path) - Constructor for class net.tangly.spec.bdd.engine.StoryAsciiDocPublisher
- StoryExtension - Class in net.tangly.spec.bdd.engine
-
A custom extension that allows test authors to create and run behaviors and stories i.e., BDD specification tests.
- StoryExtension() - Constructor for class net.tangly.spec.bdd.engine.StoryExtension
- StoryMerger - Class in net.tangly.spec.bdd.engine
-
Merges a set of JSON files produced through the execution of BDD JUnit tests.
- StoryMerger() - Constructor for class net.tangly.spec.bdd.engine.StoryMerger
- StoryRun - Class in net.tangly.spec.bdd.engine
-
Recall that our custom extension generates BDD reports after executing the tests.
- StoryRun(Class<?>) - Constructor for class net.tangly.spec.bdd.engine.StoryRun
- storyTags() - Method in class net.tangly.spec.bdd.engine.StoryRun
- StoryWriter - Class in net.tangly.spec.bdd.engine
-
Writes the story with all executed scenarios in a JSON file.
- StoryWriter(StoryRun) - Constructor for class net.tangly.spec.bdd.engine.StoryWriter
- supersede - Enum constant in enum class net.tangly.spec.req.Reference.ReferenceKind
- supportsParameter(ParameterContext, ExtensionContext) - Method in class net.tangly.spec.bdd.engine.StoryExtension
T
- tags() - Element in annotation interface net.tangly.spec.bdd.Feature
-
Return the tags associated with the feature.
- tags() - Element in annotation interface net.tangly.spec.bdd.Story
-
Return the tags associated with the feature.
- TAGS - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- text() - Method in class net.tangly.spec.bdd.Phase
- text() - Method in interface net.tangly.spec.req.Requirement
- text() - Method in interface net.tangly.spec.req.Risk
- text() - Method in interface net.tangly.spec.req.Section
- TEXT - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- then() - Method in class net.tangly.spec.bdd.Scene
- then(String, Consumer<Scene>) - Method in class net.tangly.spec.bdd.Scene
- THEN - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- title() - Method in interface net.tangly.spec.req.Section
V
- value() - Element in annotation interface net.tangly.spec.bdd.Feature
-
Return the name of the feature as human-readable information for living documentation.
- value() - Element in annotation interface net.tangly.spec.bdd.Scenario
-
Return the description of the scenario as human-readable information for living documentation.
- value() - Element in annotation interface net.tangly.spec.bdd.Story
-
Return the name of the story as human-readable information for living documentation.
- valueOf(String) - Static method in enum class net.tangly.spec.req.Reference.ReferenceKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class net.tangly.spec.req.Requirement.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class net.tangly.spec.req.Risk.RiskLevel
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class net.tangly.spec.req.Reference.ReferenceKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class net.tangly.spec.req.Requirement.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class net.tangly.spec.req.Risk.RiskLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- when() - Method in class net.tangly.spec.bdd.Scene
- when(String, Consumer<Scene>) - Method in class net.tangly.spec.bdd.Scene
- WHEN - Static variable in class net.tangly.spec.bdd.engine.BddConstants
- write(Path) - Method in class net.tangly.spec.bdd.engine.StoryMerger
-
Writes the features to the provided file.
All Classes and Interfaces|All Packages|Constant Field Values