net.thucydides.core.steps

Class ExecutedStepDescription

java.lang.Object

net.thucydides.core.steps.ExecutedStepDescription

All Implemented Interfaces:

Cloneable

public class ExecutedStepDescription
extends Object
implements 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 and Description
protected	ExecutedStepDescription(Class<? extends Object> stepsClass, String name)
protected	ExecutedStepDescription(Class<? extends Object> stepsClass, String name, boolean isAGroup)
protected	ExecutedStepDescription(Class<? extends Object> stepsClass, String name, List<Object> argumentsList, Map<String,Object> displayedFields, boolean isAGroup)
protected	ExecutedStepDescription(String name)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutedStepDescription

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

ExecutedStepDescription

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

ExecutedStepDescription

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

ExecutedStepDescription

protected ExecutedStepDescription(String name)

Method Detail

clone

public ExecutedStepDescription clone()

Overrides:

clone in class Object

getStepClass

public Class<? extends Object> getStepClass()

The class of the step library being executed.

getName

public String getName()

getArguments

public List<String> getArguments()

getRawArguments

public List<Object> getRawArguments()

withName

public ExecutedStepDescription withName(String newName)

withDisplayedFields

public ExecutedStepDescription withDisplayedFields(Map<String,Object> displayedFields)

of

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

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

of

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

withTitle

public static ExecutedStepDescription withTitle(String name)

isAGroup

public boolean isAGroup()

setAGroup

public void setAGroup(boolean aGroup)

getStepMethod

public Method getStepMethod()

isAQuestion

public boolean isAQuestion()

getTitle

public String getTitle()

Turns a method into a human-readable title.

getDisplayedFields

public Map<String,Object> getDisplayedFields()

asAQuestion

public ExecutedStepDescription asAQuestion()