Package io.cucumber.core.backend

Interface Snippet

@API(status=STABLE)
public interface Snippet

Method Summary

Modifier and Type	Method	Description
String	arguments(Map<String,Type> arguments)	Constructs a string representation of the arguments a step definition should accept.
String	escapePattern(String pattern)
String	tableHint()
MessageFormat	template()

Method Details

template

MessageFormat template()

Returns:

a MessageFormat template used to generate a snippet. The template can access the following variables:

• {0} : Step Keyword
• {1} : Value of escapePattern(String)
• {2} : Function name
• {3} : Value of arguments(Map)
• {4} : Regexp hint comment
• {5} : value of tableHint() if the step has a table

tableHint

String tableHint()

Returns:

a hint about alternative ways to declare a table argument

arguments

String arguments(Map<String,Type> arguments)

Constructs a string representation of the arguments a step definition should accept. The arguments are provided a map of (suggested) names and types. The arguments are ordered by their position.

Parameters:

arguments - ordered pairs of names and types

Returns:

a string representation of the arguments

escapePattern

String escapePattern(String pattern)

Parameters:

pattern - the computed pattern that will match an undefined step

Returns:

an escaped representation of the pattern, if escaping is necessary.