cucumber.runtime

Interface StepDefinition

public interface StepDefinition

Method Summary

Modifier and Type	Method and Description
void	execute(Object[] args) Invokes the step definition.
String	getLocation(boolean detail) The source line where the step definition is defined.
Integer	getParameterCount() How many declared parameters this step definition has.
List<?>	getParameters() list of declared parameters this step definition has.
String	getPattern()
boolean	isDefinedAt(StackTraceElement stackTraceElement) Return true if this matches the location.
boolean	isScenarioScoped()
List<io.cucumber.stepexpression.Argument>	matchedArguments(gherkin.pickles.PickleStep step) Returns a list of arguments.

Method Detail

matchedArguments

List<io.cucumber.stepexpression.Argument> matchedArguments(gherkin.pickles.PickleStep step)

Returns a list of arguments. Return null if the step definition doesn't match at all. Return an empty List if it matches with 0 arguments and bigger sizes if it matches several.

Parameters:

step -

Returns:

getLocation

String getLocation(boolean detail)

The source line where the step definition is defined. Example: foo/bar/Zap.brainfuck:42

Parameters:

detail - true if extra detailed location information should be included.

Returns:

getParameterCount

Integer getParameterCount()

How many declared parameters this step definition has. Returns null if unknown.

Returns:

getParameters

List<?> getParameters()

list of declared parameters this step definition has. Returns null if unknown.

Returns:

execute

void execute(Object[] args)
      throws Throwable

Invokes the step definition. The method should raise a Throwable if the invocation fails, which will cause the step to fail.

Parameters:

args -

Throws:

Throwable

isDefinedAt

boolean isDefinedAt(StackTraceElement stackTraceElement)

Return true if this matches the location. This is used to filter stack traces.

Parameters:

stackTraceElement -

Returns:

getPattern

String getPattern()

Returns:

the pattern associated with this instance. Used for error reporting only.

isScenarioScoped

boolean isScenarioScoped()

Returns:

true if this instance is scoped to a single scenario, or false if it can be reused across scenarios.