org.unitils.jbehave.core

Class UnitilsSteps

java.lang.Object

org.jbehave.core.steps.Steps

org.unitils.jbehave.core.UnitilsSteps

All Implemented Interfaces:

org.jbehave.core.steps.CandidateSteps

public class UnitilsSteps
extends org.jbehave.core.steps.Steps

Extended Steps: This class will add the correct steps to the runner.

Since:

1.0.0

Author:

Willemijn Wouters

Nested Class Summary

Nested classes/interfaces inherited from class org.jbehave.core.steps.Steps

org.jbehave.core.steps.Steps.DuplicateCandidateFound

Constructor Summary

Constructors

Constructor and Description
UnitilsSteps(org.jbehave.core.configuration.Configuration configuration, Class<?> type, org.jbehave.core.steps.InjectableStepsFactory stepsFactory)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCandidate(List<org.jbehave.core.steps.StepCandidate> candidates, Method method, org.jbehave.core.steps.StepType stepType, String stepPatternAsString, int priority) This method makes a new StepCandidate and adds it to the list of candidates.
protected void	addCandidatesFromAliases(List<org.jbehave.core.steps.StepCandidate> candidates, Method method, org.jbehave.core.steps.StepType stepType, int priority) Adds new StepCandidates.
protected void	addCandidatesFromVariants(List<org.jbehave.core.steps.StepCandidate> candidates, Method method, org.jbehave.core.steps.StepType stepType, String value, int priority) Adds new StepCandidates.
protected void	checkForDuplicateCandidates(List<org.jbehave.core.steps.StepCandidate> candidates, org.jbehave.core.steps.StepType stepType, String patternAsString) checks for duplicate StepCandidates.
protected org.jbehave.core.steps.BeforeOrAfterStep	createBeforeOrAfterStep(org.jbehave.core.steps.StepCollector.Stage stage, Method method) This method creates a basic BeforeOrAfterStep.
protected org.jbehave.core.steps.BeforeOrAfterStep	createBeforeOrAfterStep(org.jbehave.core.steps.StepCollector.Stage stage, Method method, org.jbehave.core.annotations.AfterScenario.Outcome outcome) This method creates a basic BeforeOrAfterStep.
protected org.jbehave.core.steps.StepCandidate	createCandidate(Method method, org.jbehave.core.steps.StepType stepType, String stepPatternAsString, int priority, org.jbehave.core.configuration.Configuration configuration) This method creates a new UnitilsStepCandidate.
org.jbehave.core.steps.StepCreator	createStepCreator() This method creates a new UnitilsStepCreator.
org.jbehave.core.steps.InjectableStepsFactory	getStepsFactory() This is a getter for the stepsFactory.
List<org.jbehave.core.steps.BeforeOrAfterStep>	listBeforeOrAfterScenario(org.jbehave.core.annotations.ScenarioType type)
List<org.jbehave.core.steps.BeforeOrAfterStep>	listBeforeOrAfterStory(boolean givenStory)
List<org.jbehave.core.steps.StepCandidate>	listCandidates() This method creates all the StepCandidates for a specific type.
protected boolean	runnableStoryStep(Annotation annotation, boolean givenStory) Check if an annotation is a runnable story step.
protected org.jbehave.core.annotations.AfterScenario.Outcome	scenarioOutcome(Method method, Class<? extends Annotation> annotationClass) Get the AfterScenario.Outcome out of the AfterScenario.
protected List<org.jbehave.core.steps.BeforeOrAfterStep>	scenarioStepsHaving(org.jbehave.core.annotations.ScenarioType type, org.jbehave.core.steps.StepCollector.Stage stage, Class<? extends Annotation> annotationClass, org.jbehave.core.annotations.AfterScenario.Outcome... outcomes) Creates a list of scenarios by Stage.
protected org.jbehave.core.annotations.ScenarioType	scenarioType(Method method, Class<? extends Annotation> annotationClass) This methods gets the ScenarioType out of the BeforeScenario or AfterScenario.
protected List<org.jbehave.core.steps.BeforeOrAfterStep>	stepsHaving(org.jbehave.core.steps.StepCollector.Stage stage, Class<? extends Annotation> annotationClass, boolean givenStory) Creates a List with BeforeOrAfterSteps with methods who use a specific Annotation.
protected boolean	uponGivenStory(Annotation annotation) check the value of the BeforeStory.uponGivenStory() or AfterStory.uponGivenStory().

Methods inherited from class org.jbehave.core.steps.Steps

configuration, instance, listBeforeOrAfterStories, toString, type

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitilsSteps

public UnitilsSteps(org.jbehave.core.configuration.Configuration configuration,
            Class<?> type,
            org.jbehave.core.steps.InjectableStepsFactory stepsFactory)

Parameters:

configuration -

type -

stepsFactory -

Method Detail

listBeforeOrAfterScenario

public List<org.jbehave.core.steps.BeforeOrAfterStep> listBeforeOrAfterScenario(org.jbehave.core.annotations.ScenarioType type)

Specified by:

listBeforeOrAfterScenario in interface org.jbehave.core.steps.CandidateSteps

Overrides:

listBeforeOrAfterScenario in class org.jbehave.core.steps.Steps

See Also:

Steps.listBeforeOrAfterScenario(org.jbehave.core.annotations.ScenarioType)

listBeforeOrAfterStory

public List<org.jbehave.core.steps.BeforeOrAfterStep> listBeforeOrAfterStory(boolean givenStory)

Specified by:

listBeforeOrAfterStory in interface org.jbehave.core.steps.CandidateSteps

Overrides:

listBeforeOrAfterStory in class org.jbehave.core.steps.Steps

See Also:

Steps.listBeforeOrAfterStory(boolean)

scenarioStepsHaving

protected List<org.jbehave.core.steps.BeforeOrAfterStep> scenarioStepsHaving(org.jbehave.core.annotations.ScenarioType type,
                                                                 org.jbehave.core.steps.StepCollector.Stage stage,
                                                                 Class<? extends Annotation> annotationClass,
                                                                 org.jbehave.core.annotations.AfterScenario.Outcome... outcomes)

Creates a list of scenarios by Stage.

Parameters:

type -

stage -

annotationClass -

outcomes -

Returns:

List

stepsHaving

protected List<org.jbehave.core.steps.BeforeOrAfterStep> stepsHaving(org.jbehave.core.steps.StepCollector.Stage stage,
                                                         Class<? extends Annotation> annotationClass,
                                                         boolean givenStory)

Creates a List with BeforeOrAfterSteps with methods who use a specific Annotation.

Parameters:

stage -

annotationClass -

givenStory -

Returns:

List

runnableStoryStep

protected boolean runnableStoryStep(Annotation annotation,
                        boolean givenStory)

Check if an annotation is a runnable story step.

Parameters:

annotation -

givenStory -

Returns:

Boolean

uponGivenStory

protected boolean uponGivenStory(Annotation annotation)

check the value of the BeforeStory.uponGivenStory() or AfterStory.uponGivenStory().

Parameters:

annotation -

Returns:

boolean

scenarioType

protected org.jbehave.core.annotations.ScenarioType scenarioType(Method method,
                                                     Class<? extends Annotation> annotationClass)

This methods gets the ScenarioType out of the BeforeScenario or AfterScenario.

Parameters:

method -

annotationClass -

Returns:

ScenarioType

createBeforeOrAfterStep

protected org.jbehave.core.steps.BeforeOrAfterStep createBeforeOrAfterStep(org.jbehave.core.steps.StepCollector.Stage stage,
                                                               Method method)

This method creates a basic BeforeOrAfterStep.

Parameters:

stage -

method -

Returns:

BeforeOrAfterStep

createBeforeOrAfterStep

protected org.jbehave.core.steps.BeforeOrAfterStep createBeforeOrAfterStep(org.jbehave.core.steps.StepCollector.Stage stage,
                                                               Method method,
                                                               org.jbehave.core.annotations.AfterScenario.Outcome outcome)

This method creates a basic BeforeOrAfterStep.

Parameters:

stage -

method -

outcome -

Returns:

BeforeOrAfterStep

scenarioOutcome

protected org.jbehave.core.annotations.AfterScenario.Outcome scenarioOutcome(Method method,
                                                                 Class<? extends Annotation> annotationClass)

Get the AfterScenario.Outcome out of the AfterScenario.

Parameters:

method -

annotationClass -

Returns:

createCandidate

protected org.jbehave.core.steps.StepCandidate createCandidate(Method method,
                                                   org.jbehave.core.steps.StepType stepType,
                                                   String stepPatternAsString,
                                                   int priority,
                                                   org.jbehave.core.configuration.Configuration configuration)

This method creates a new UnitilsStepCandidate.

Parameters:

method -

stepType -

stepPatternAsString -

priority -

configuration -

Returns:

StepCandidate

addCandidate

protected void addCandidate(List<org.jbehave.core.steps.StepCandidate> candidates,
                Method method,
                org.jbehave.core.steps.StepType stepType,
                String stepPatternAsString,
                int priority)

This method makes a new StepCandidate and adds it to the list of candidates.

Parameters:

candidates -

method -

stepType -

stepPatternAsString -

priority -

addCandidatesFromVariants

protected void addCandidatesFromVariants(List<org.jbehave.core.steps.StepCandidate> candidates,
                             Method method,
                             org.jbehave.core.steps.StepType stepType,
                             String value,
                             int priority)

Adds new StepCandidates.

Parameters:

candidates -

method -

stepType -

value -

priority -

addCandidatesFromAliases

protected void addCandidatesFromAliases(List<org.jbehave.core.steps.StepCandidate> candidates,
                            Method method,
                            org.jbehave.core.steps.StepType stepType,
                            int priority)

Adds new StepCandidates.

Parameters:

candidates -

method -

stepType -

priority -

checkForDuplicateCandidates

protected void checkForDuplicateCandidates(List<org.jbehave.core.steps.StepCandidate> candidates,
                               org.jbehave.core.steps.StepType stepType,
                               String patternAsString)

checks for duplicate StepCandidates.

Parameters:

candidates -

stepType -

patternAsString -

listCandidates

public List<org.jbehave.core.steps.StepCandidate> listCandidates()

This method creates all the StepCandidates for a specific type.

Specified by:

listCandidates in interface org.jbehave.core.steps.CandidateSteps

Overrides:

listCandidates in class org.jbehave.core.steps.Steps

See Also:

Steps.listCandidates()

createStepCreator

public org.jbehave.core.steps.StepCreator createStepCreator()

This method creates a new UnitilsStepCreator.

Returns:

StepCreator

getStepsFactory

public org.jbehave.core.steps.InjectableStepsFactory getStepsFactory()

This is a getter for the stepsFactory.

Returns:

InjectableStepsFactory