hu.ibello.bdd.model

Class BDDDocumentItem<STEP extends Step>

java.lang.Object

hu.ibello.bdd.model.BDDDocumentItem<STEP>

Type Parameters:

STEP - the concrete class of the steps specified by this item

Direct Known Subclasses:

Example, Scenario

public abstract class BDDDocumentItem<STEP extends Step>
extends Object

Describes an item of a Cucumber document. It can be Scenario or Example.

Author:

Kornél Simon

Constructor Summary

Constructors

Constructor and Description
BDDDocumentItem()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of the item.
String	getKeyword() Returns the keyword of the item.
String	getName() Returns the name of the item.
List<STEP>	getSteps() Returns the steps of the item.
boolean	hasStep() Are there any steps in the item?
void	setDescription(String description) Sets the description of the item.
void	setKeyword(String keyword) Sets the keyword of the item.
void	setName(String name) Sets the name of the item.
void	setSteps(List<STEP> steps) Sets the steps of the item.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BDDDocumentItem

public BDDDocumentItem()

Method Detail

getKeyword

public String getKeyword()

Returns the keyword of the item. It depends on the language of the document. For english language, it is "Scenario".

Returns:

the keyword of the item

setKeyword

public void setKeyword(String keyword)

Sets the keyword of the item. It depends on the language of the document. For english language, it should be "Scenario".

Parameters:

keyword - the keyword of the item

getName

public String getName()

Returns the name of the item.

Returns:

the name of the item

setName

public void setName(String name)

Sets the name of the item.

Parameters:

name - the name of the item

getDescription

public String getDescription()

Returns the description of the item.

Returns:

the description of the item

setDescription

public void setDescription(String description)

Sets the description of the item.

Parameters:

description - the description of the item

hasStep

public boolean hasStep()

Are there any steps in the item?

Returns:

true if item has steps

getSteps

public List<STEP> getSteps()

Returns the steps of the item. If the item does not have steps, it returns an empty list.

Returns:

the steps of the item

setSteps

public void setSteps(List<STEP> steps)

Sets the steps of the item. If the method is called with null, the result of the getSteps() method will be an empty list.

Parameters:

steps - the steps of the item

toString

public String toString()

Overrides:

toString in class Object