hu.ibello.bdd.model

Class Step

java.lang.Object

hu.ibello.bdd.model.Step

Direct Known Subclasses:

ParentStep

public class Step
extends Object

Describes a test step from a BDD document.

Author:

Kornél Simon

Constructor Summary

Constructors

Constructor and Description
Step()

Method Summary

Modifier and Type	Method and Description
String	getKeyword() Returns the keyword of the step.
StepKind	getKind() Returns the recognized type of the test step's keyword.
List<Parameter>	getParameters() Returns the parameters of the step.
String	getText() Returns the text of the test step, without the keyword.
boolean	hasParameter() Are there any parameters in the step?
void	setKeyword(String keyword) Sets the keyword of the step.
void	setKind(StepKind kind) Sets the recognized type of the test step's keyword.
void	setParameters(List<Parameter> parameters) Sets the parameters of the step.
void	setText(String text) Sets the text of the test step, without the keyword.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Step

public Step()

Method Detail

getKeyword

public String getKeyword()

Returns the keyword of the step. It depends on the language of the document. For english language, it can be "Given", "When", "Then", "And" and "But".

Returns:

the keyword of the step

setKeyword

public void setKeyword(String keyword)

Sets the keyword of the step. It depends on the language of the document. For english language, it should be "Given", "When", "Then", "And" and "But".

Parameters:

keyword - the keyword of the step

getKind

public StepKind getKind()

Returns the recognized type of the test step's keyword. The "And" and "But" keywords are not returned, instead of it they are replaced with the correct GIVEN, WHEN or THEN type. If the type cannot be recognized, this method returns StepKind.UNKNOWN. This is the case (for example) if the first step has the "And" keyword.

Returns:

the type of the test step's keyword

setKind

public void setKind(StepKind kind)

Sets the recognized type of the test step's keyword.

Parameters:

kind - type of the test step's keyword

getText

public String getText()

Returns the text of the test step, without the keyword.

Returns:

the text of the test step

setText

public void setText(String text)

Sets the text of the test step, without the keyword.

Parameters:

text - the text of the test step

hasParameter

public boolean hasParameter()

Are there any parameters in the step?

Returns:

true if step has parameters

getParameters

public List<Parameter> getParameters()

Returns the parameters of the step. If the step does not have parameters, it returns an empty list.

Returns:

the parameters of the step

setParameters

public void setParameters(List<Parameter> parameters)

Sets the parameters of the step. If the method is called with null, the result of the getParameters() method will be an empty list.

Parameters:

parameters - the parameters of the step

toString

public String toString()

Overrides:

toString in class Object