Package io.cucumber.messages.types

Class Pickle

java.lang.Object

io.cucumber.messages.types.Pickle

public class Pickle
extends Object

//// Pickles * A `Pickle` represents a template for a `TestCase`. It is typically derived from another format, such as [GherkinDocument](#io.cucumber.messages.GherkinDocument). In the future a `Pickle` may be derived from other formats such as Markdown or Excel files. By making `Pickle` the main data structure Cucumber uses for execution, the implementation of Cucumber itself becomes simpler, as it doesn't have to deal with the complex structure of a [GherkinDocument](#io.cucumber.messages.GherkinDocument). Each `PickleStep` of a `Pickle` is matched with a `StepDefinition` to create a `TestCase`

Constructor Summary

Constructors

Constructor	Description
Pickle()	No args constructor for use in serialization
Pickle(String id, String uri, String name, String language, List<PickleStep> steps, List<PickleTag> tags, List<String> astNodeIds)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
List<String>	getAstNodeIds()	* Points to the AST node locations of the pickle.
String	getId()	* A unique id for the pickle.
String	getLanguage()	The language of the pickle (Required)
String	getName()	The name of the pickle (Required)
List<PickleStep>	getSteps()	One or more steps (Required)
List<PickleTag>	getTags()	* One or more tags.
String	getUri()	The uri of the source file (Required)
int	hashCode()
void	setAstNodeIds(List<String> astNodeIds)	* Points to the AST node locations of the pickle.
void	setId(String id)	* A unique id for the pickle.
void	setLanguage(String language)	The language of the pickle (Required)
void	setName(String name)	The name of the pickle (Required)
void	setSteps(List<PickleStep> steps)	One or more steps (Required)
void	setTags(List<PickleTag> tags)	* One or more tags.
void	setUri(String uri)	The uri of the source file (Required)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pickle

public Pickle()

No args constructor for use in serialization

Pickle

public Pickle(String id,
              String uri,
              String name,
              String language,
              List<PickleStep> steps,
              List<PickleTag> tags,
              List<String> astNodeIds)

Parameters:

name -

language -

id -

uri -

steps -

astNodeIds -

tags -

Method Detail

getId

public String getId()

* A unique id for the pickle. This is a [SHA1](https://en.wikipedia.org/wiki/SHA-1) hash from the source data and the `locations` of the pickle. This ID will change if source the file is modified. (Required)

setId

public void setId(String id)

* A unique id for the pickle. This is a [SHA1](https://en.wikipedia.org/wiki/SHA-1) hash from the source data and the `locations` of the pickle. This ID will change if source the file is modified. (Required)

getUri

public String getUri()

The uri of the source file (Required)

setUri

public void setUri(String uri)

The uri of the source file (Required)

getName

public String getName()

The name of the pickle (Required)

setName

public void setName(String name)

The name of the pickle (Required)

getLanguage

public String getLanguage()

The language of the pickle (Required)

setLanguage

public void setLanguage(String language)

The language of the pickle (Required)

getSteps

public List<PickleStep> getSteps()

One or more steps (Required)

setSteps

public void setSteps(List<PickleStep> steps)

One or more steps (Required)

getTags

public List<PickleTag> getTags()

* One or more tags. If this pickle is constructed from a Gherkin document, It includes inherited tags from the `Feature` as well. (Required)

setTags

public void setTags(List<PickleTag> tags)

* One or more tags. If this pickle is constructed from a Gherkin document, It includes inherited tags from the `Feature` as well. (Required)

getAstNodeIds

public List<String> getAstNodeIds()

* Points to the AST node locations of the pickle. The last one represents the unique id of the pickle. A pickle constructed from `Examples` will have the first id originating from the `Scenario` AST node, and the second from the `TableRow` AST node. (Required)

setAstNodeIds

public void setAstNodeIds(List<String> astNodeIds)

* Points to the AST node locations of the pickle. The last one represents the unique id of the pickle. A pickle constructed from `Examples` will have the first id originating from the `Scenario` AST node, and the second from the `TableRow` AST node. (Required)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object