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