Module io.cucumber.core
Package io.cucumber.core.backend

Interface Snippet

@API(status=STABLE) public interface Snippet

  • Method Details

    • language

      default Optional<String> language()
      The programming language of the generated snippet.
      Returns:
      the language of the generated snippet.
      See Also:
      • Snippet.getLanguage()

    • template

      MessageFormat template()
      Returns a MessageFormat template used to generate a snippet.

      The template can access the following variables:

      Returns:
      a template used to generate a snippet.

    • tableHint

      String tableHint()
      Returns a hint about alternative ways to declare a table argument
      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)
      Escape representation of the pattern, if escaping is necessary.
      Parameters:
      pattern - the computed pattern that will match an undefined step
      Returns:
      an escaped representation of the pattern, if escaping is necessary.