org.jbehave.core.steps

Class StepCandidate

java.lang.Object

org.jbehave.core.steps.StepCandidate

public class StepCandidate
extends java.lang.Object

A StepCandidate is associated to a Java method annotated with Given, When, Then in a steps instance class. The StepCandidate is responsible for matching the textual step against the pattern contained in the method annotation via the StepMatcher and for the creation of the matched executable step via the StepCreator.

Constructor Summary

Constructors

Constructor and Description
StepCandidate(java.lang.String patternAsString, int priority, StepType stepType, java.lang.reflect.Method method, java.lang.Class<?> stepsType, InjectableStepsFactory stepsFactory, Keywords keywords, StepPatternParser stepPatternParser, ParameterConverters parameterConverters, ParameterControls parameterControls)

Method Summary

Methods

Modifier and Type	Method and Description
void	addComposedSteps(java.util.List<Step> steps, java.lang.String stepAsString, java.util.Map<java.lang.String,java.lang.String> namedParameters, java.util.List<StepCandidate> allCandidates)
void	composedOf(java.lang.String[] steps)
java.lang.String[]	composedSteps()
Step	createMatchedStep(java.lang.String stepAsString, java.util.Map<java.lang.String,java.lang.String> namedParameters)
Step	createMatchedStepUponOutcome(java.lang.String stepAsString, java.util.Map<java.lang.String,java.lang.String> namedParameters, AfterScenario.Outcome outcome)
void	doDryRun(boolean dryRun)
java.lang.reflect.Method	getMethod()
java.lang.String	getPatternAsString()
java.lang.Integer	getPriority()
java.lang.String	getStartingWord()
java.lang.Object	getStepsInstance()
java.lang.Class<?>	getStepsType()
StepType	getStepType()
boolean	ignore(java.lang.String stepAsString)
boolean	isAndStep(java.lang.String stepAsString)
boolean	isComposite()
boolean	isIgnorableStep(java.lang.String stepAsString)
boolean	isPending()
boolean	matches(java.lang.String stepAsString)
boolean	matches(java.lang.String step, java.lang.String previousNonAndStep)
java.lang.String	toString()
void	useParanamer(com.thoughtworks.paranamer.Paranamer paranamer)
void	useStepMonitor(StepMonitor stepMonitor)

Methods inherited from class java.lang.Object

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

Constructor Detail

StepCandidate

public StepCandidate(java.lang.String patternAsString,
             int priority,
             StepType stepType,
             java.lang.reflect.Method method,
             java.lang.Class<?> stepsType,
             InjectableStepsFactory stepsFactory,
             Keywords keywords,
             StepPatternParser stepPatternParser,
             ParameterConverters parameterConverters,
             ParameterControls parameterControls)

Method Detail

getMethod

public java.lang.reflect.Method getMethod()

getPriority

public java.lang.Integer getPriority()

getPatternAsString

public java.lang.String getPatternAsString()

getStepsInstance

public java.lang.Object getStepsInstance()

getStepsType

public java.lang.Class<?> getStepsType()

getStepType

public StepType getStepType()

getStartingWord

public java.lang.String getStartingWord()

useStepMonitor

public void useStepMonitor(StepMonitor stepMonitor)

doDryRun

public void doDryRun(boolean dryRun)

useParanamer

public void useParanamer(com.thoughtworks.paranamer.Paranamer paranamer)

composedOf

public void composedOf(java.lang.String[] steps)

isComposite

public boolean isComposite()

composedSteps

public java.lang.String[] composedSteps()

ignore

public boolean ignore(java.lang.String stepAsString)

isPending

public boolean isPending()

matches

public boolean matches(java.lang.String stepAsString)

matches

public boolean matches(java.lang.String step,
              java.lang.String previousNonAndStep)

createMatchedStep

public Step createMatchedStep(java.lang.String stepAsString,
                     java.util.Map<java.lang.String,java.lang.String> namedParameters)

createMatchedStepUponOutcome

public Step createMatchedStepUponOutcome(java.lang.String stepAsString,
                                java.util.Map<java.lang.String,java.lang.String> namedParameters,
                                AfterScenario.Outcome outcome)

addComposedSteps

public void addComposedSteps(java.util.List<Step> steps,
                    java.lang.String stepAsString,
                    java.util.Map<java.lang.String,java.lang.String> namedParameters,
                    java.util.List<StepCandidate> allCandidates)

isAndStep

public boolean isAndStep(java.lang.String stepAsString)

isIgnorableStep

public boolean isIgnorableStep(java.lang.String stepAsString)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object