Package io.cucumber.core.backend

Interface TestCaseState

@API(status=STABLE)
public interface TestCaseState

Method Summary

Modifier and Type	Method	Description
void	embed(byte[] data, String mediaType)	Deprecated. use embed(byte[], String, String) instead.
void	embed(byte[] data, String mediaType, String name)	Embeds data into the report(s).
String	getId()
Integer	getLine()
String	getName()
Collection<String>	getSourceTagNames()
Status	getStatus()
URI	getUri()
boolean	isFailed()
void	write(String text)	Outputs some text into the report.

Method Detail

getSourceTagNames

Collection<String> getSourceTagNames()

Returns:

source_tag_names.

getStatus

Status getStatus()

Returns:

the most severe status of the Scenario's Steps.

isFailed

boolean isFailed()

Returns:

true if and only if getStatus() returns "failed"

embed

@Deprecated
void embed(byte[] data,
           String mediaType)

Deprecated.

use embed(byte[], String, String) instead.

Parameters:

data - what to embed, for example an image.

mediaType - what is the data? Using the

See Also:

embed(byte[], String, String), embed(byte[], String, String)

embed

void embed(byte[] data,
           String mediaType,
           String name)

Embeds data into the report(s).

 
 // Embed a screenshot. See your UI automation tool's docs for
 // details about how to take a screenshot.
 scenario.embed(pngBytes, "image/png", "Bartholomew and the Bytes of the Oobleck");
 
 

To ensure reporting tools can understand what the data is a mediaType must be provided. For example: text/plain, image/png, text/html;charset=utf-8.

Media types are defined in RFC 7231 Section 3.1.1.1.

Parameters:

data - what to embed, for example an image.

mediaType - what is the data?

name - embedding name

write

void write(String text)

Outputs some text into the report.

Parameters:

text - what to put in the report.

getName

String getName()

Returns:

the name of the Scenario

getId

String getId()

Returns:

the id of the Scenario.

getUri

URI getUri()

Returns:

the uri of the Scenario.

getLine

Integer getLine()

Returns:

the line in the feature file of the Scenario. If this is a Scenario from Scenario Outlines this will return the line of the example row in the Scenario Outline.