Package org.jbehave.core.steps

Interface CandidateSteps

All Known Implementing Classes:

AbstractCandidateSteps, CompositeCandidateSteps, Steps

public interface CandidateSteps

Interface providing the list of step candidates, representing methods annotated with @Given, @When or @Then that can be matched. It also provides the list of before and after steps, representing methods annotated with @BeforeStories, @AfterStories, @BeforeStory, @AfterStory, @BeforeScenario, @AfterScenario, that do not require any matching.

Method Summary

Modifier and Type	Method	Description
Map<ScenarioType,List<BeforeOrAfterStep>>	listAfterScenario()	Returns the after scenario steps
List<BeforeOrAfterStep>	listAfterStories()	Returns the after stories steps
List<BeforeOrAfterStep>	listAfterStory(boolean givenStory)	Returns the after story steps, based on the given story status
Map<ScenarioType,List<BeforeOrAfterStep>>	listBeforeScenario()	Returns the before scenario steps
List<BeforeOrAfterStep>	listBeforeStories()	Returns the before stories steps
List<BeforeOrAfterStep>	listBeforeStory(boolean givenStory)	Returns the before story steps, based on the given story status
List<StepCandidate>	listCandidates()	Returns the step candidates that can be matched

Method Detail

listCandidates

List<StepCandidate> listCandidates()

Returns the step candidates that can be matched

Returns:

The list of step candidates

listBeforeStories

List<BeforeOrAfterStep> listBeforeStories()

Returns the before stories steps

Returns:

The list of the before stories steps

listAfterStories

List<BeforeOrAfterStep> listAfterStories()

Returns the after stories steps

Returns:

The list of the after stories steps

listBeforeStory

List<BeforeOrAfterStep> listBeforeStory(boolean givenStory)

Returns the before story steps, based on the given story status

Parameters:

givenStory - the boolean flag denoting if it's a given story

Returns:

The list of the before story steps

listAfterStory

List<BeforeOrAfterStep> listAfterStory(boolean givenStory)

Returns the after story steps, based on the given story status

Parameters:

givenStory - the boolean flag denoting if it's a given story

Returns:

The list of the after story steps

listBeforeScenario

Map<ScenarioType,List<BeforeOrAfterStep>> listBeforeScenario()

Returns the before scenario steps

Returns:

The list of the before scenario steps

listAfterScenario

Map<ScenarioType,List<BeforeOrAfterStep>> listAfterScenario()

Returns the after scenario steps

Returns:

The list of the after scenario steps