Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
CandidateSteps |
|
| 1.0;1 |
1 | package org.jbehave.core.steps; | |
2 | ||
3 | import java.util.List; | |
4 | ||
5 | import org.jbehave.core.configuration.Configuration; | |
6 | ||
7 | /** | |
8 | * Interface providing the list of step candidates, representing methods | |
9 | * annotated with {@link Given @Given}, {@link When @When} or {@link Then @Then} | |
10 | * that can be matched. It also provides the list of before and after steps, | |
11 | * representing methods annotated with {@link BeforeStories @BeforeStories}, | |
12 | * {@link AfterStories @AfterStories}, {@link BeforeStory @BeforeStory}, | |
13 | * {@link AfterStory @AfterStory}, {@link BeforeScenario @BeforeScenario}, | |
14 | * {@link AfterScenario @AfterScenario}, that do not require any matching. | |
15 | */ | |
16 | public interface CandidateSteps { | |
17 | ||
18 | /** | |
19 | * Returns the step candidates that can be matched | |
20 | * | |
21 | * @return The list of step candidates | |
22 | */ | |
23 | List<StepCandidate> listCandidates(); | |
24 | ||
25 | /** | |
26 | * Returns the before or after stories steps | |
27 | * | |
28 | * @return The list of before or after steps | |
29 | */ | |
30 | List<BeforeOrAfterStep> listBeforeOrAfterStories(); | |
31 | ||
32 | /** | |
33 | * Returns the before or after story steps, based on the given story status | |
34 | * | |
35 | * @param givenStory | |
36 | * the boolean flag denoting if it's a given story | |
37 | * @return The list of before or after steps | |
38 | */ | |
39 | List<BeforeOrAfterStep> listBeforeOrAfterStory(boolean givenStory); | |
40 | ||
41 | /** | |
42 | * Returns the before or after scenario steps | |
43 | * | |
44 | * @return The list of before or after steps | |
45 | */ | |
46 | List<BeforeOrAfterStep> listBeforeOrAfterScenario(); | |
47 | ||
48 | /** | |
49 | * Returns the configuration | |
50 | * | |
51 | * @return The Configuration | |
52 | */ | |
53 | Configuration configuration(); | |
54 | ||
55 | } |