Package net.thucydides.core.steps

Class ExecutedStepDescription

java.lang.Object

net.thucydides.core.steps.ExecutedStepDescription

All Implemented Interfaces:

java.lang.Cloneable

public class ExecutedStepDescription
extends java.lang.Object
implements java.lang.Cloneable

A description of a step executed during a Thucydides step run. Used in the reporting to generate user-readable names for the executed steps.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExecutedStepDescription(java.lang.Class<? extends java.lang.Object> stepsClass, java.lang.String name)
protected	ExecutedStepDescription(java.lang.Class<? extends java.lang.Object> stepsClass, java.lang.String name, boolean isAGroup)
protected	ExecutedStepDescription(java.lang.Class<? extends java.lang.Object> stepsClass, java.lang.String name, java.util.List<java.lang.Object> argumentsList, java.util.Map<java.lang.String,java.lang.Object> displayedFields, boolean isAGroup)
protected	ExecutedStepDescription(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
ExecutedStepDescription	asAQuestion()
ExecutedStepDescription	clone()
java.util.List<java.lang.String>	getArguments()
java.util.Map<java.lang.String,java.lang.Object>	getDisplayedFields()
java.lang.String	getName()
java.util.List<java.lang.Object>	getRawArguments()
java.lang.Class<? extends java.lang.Object>	getStepClass()	The class of the step library being executed.
java.lang.reflect.Method	getStepMethod()
java.lang.String	getTitle()	Turns a method into a human-readable title.
boolean	isAGroup()
boolean	isAQuestion()
static ExecutedStepDescription	of(java.lang.Class<? extends java.lang.Object> stepsClass, java.lang.String name)	We might not have the test class provided (e.g.
static ExecutedStepDescription	of(java.lang.Class<? extends java.lang.Object> stepsClass, java.lang.String name, java.lang.Object[] arguments)
void	setAGroup(boolean aGroup)
ExecutedStepDescription	withDisplayedFields(java.util.Map<java.lang.String,java.lang.Object> displayedFields)
ExecutedStepDescription	withName(java.lang.String newName)
static ExecutedStepDescription	withTitle(java.lang.String name)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExecutedStepDescription

protected ExecutedStepDescription(java.lang.Class<? extends java.lang.Object> stepsClass,
java.lang.String name,
java.util.List<java.lang.Object> argumentsList,
java.util.Map<java.lang.String,java.lang.Object> displayedFields,
boolean isAGroup)

ExecutedStepDescription

protected ExecutedStepDescription(java.lang.Class<? extends java.lang.Object> stepsClass,
java.lang.String name,
boolean isAGroup)

ExecutedStepDescription

protected ExecutedStepDescription(java.lang.Class<? extends java.lang.Object> stepsClass,
java.lang.String name)

ExecutedStepDescription

protected ExecutedStepDescription(java.lang.String name)

Method Details

clone

public ExecutedStepDescription clone()

Overrides:

clone in class java.lang.Object

getStepClass

public java.lang.Class<? extends java.lang.Object> getStepClass()

The class of the step library being executed.

getName

public java.lang.String getName()

getArguments

public java.util.List<java.lang.String> getArguments()

getRawArguments

public java.util.List<java.lang.Object> getRawArguments()

withName

public ExecutedStepDescription withName(java.lang.String newName)

withDisplayedFields

public ExecutedStepDescription withDisplayedFields(java.util.Map<java.lang.String,java.lang.Object> displayedFields)

of

public static ExecutedStepDescription of(java.lang.Class<? extends java.lang.Object> stepsClass,
java.lang.String name)

We might not have the test class provided (e.g. at the end of a test).

of

public static ExecutedStepDescription of(java.lang.Class<? extends java.lang.Object> stepsClass,
java.lang.String name,
java.lang.Object[] arguments)

withTitle

public static ExecutedStepDescription withTitle(java.lang.String name)

isAGroup

public boolean isAGroup()

setAGroup

public void setAGroup(boolean aGroup)

getStepMethod

public java.lang.reflect.Method getStepMethod()

isAQuestion

public boolean isAQuestion()

getTitle

public java.lang.String getTitle()

Turns a method into a human-readable title.

getDisplayedFields

public java.util.Map<java.lang.String,java.lang.Object> getDisplayedFields()

asAQuestion

public ExecutedStepDescription asAQuestion()