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 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) Lists all the BeforeOrAfterSteps of a specific type.
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.

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

configuration, instance, listBeforeOrAfterStories, listBeforeOrAfterStory, listCandidates, 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 - : the configuration of JBehave.

type - : the type of the step.

stepsFactory - : the stepsfactory.

Method Detail

listBeforeOrAfterScenario

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

Lists all the BeforeOrAfterSteps of a specific type.

Specified by:

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

Overrides:

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

Parameters:

type - : any/normal/example

Returns:

List

See Also:

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

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 - : the ScenarioType.

stage - : the stage (before/after).

annotationClass - : the annotation

outcomes - : an Array of outcomes.

Returns:

List

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 - : the method in the step

annotationClass - : check if this annotation exists on the method

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 - : before/after

method - : the method in the step.

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 - : before/after

method - : the method in the step

outcome - : success/failure/any

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 - : the method in the step.

annotationClass - : check if this annotation exists on the method.

Returns:

AfterScenario.Outcome

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 - : check if this annotation exists on the method.

stepType - : the type of the step

stepPatternAsString - : the pattern of the step

priority - : the priority of the step

configuration - : the JBehave configuration

Returns:

StepCandidate

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