hu.ibello.bdd.model

Class BDDDocument

java.lang.Object

hu.ibello.bdd.model.BDDDocument

Direct Known Subclasses:

Examples, Feature

public abstract class BDDDocument
extends Object

Abstract superclass of a Cucumber document. Descendants are Feature and Examples.

Author:

Kornél Simon

Constructor Summary

Constructors

Constructor and Description
BDDDocument()

Method Summary

Modifier and Type	Method and Description
List<String>	getComments() Returns the comments of the document.
String	getDescription() Returns the description of the document.
String	getFullPath() Getter for the full path of the file containing the document.
String	getKeyword() Returns the root keyword of the document.
String	getLanguage() Returns the language code of the document.
String	getName() Returns the name of the document.
String	getRelativePath() Getter for the relative path of the file containing the document.
boolean	hasComment() Are there any comments in the document?
void	setDescription(String description) Sets the description of the document.
void	setFullPath(String fullPath) Setter for the full path of the file containing the document.
void	setKeyword(String keyword) Sets the root keyword of the document.
void	setLanguage(String language) Sets the language code of the document.
void	setName(String name) Sets the name of the document.
void	setRelativePath(String relativePath) Setter for the relative path of the file containing the document.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BDDDocument

public BDDDocument()

Method Detail

getFullPath

public String getFullPath()

Getter for the full path of the file containing the document. The file separators of the path are the operating system default separators.

Returns:

full path of the file containing the document

setFullPath

public void setFullPath(String fullPath)

Setter for the full path of the file containing the document. The file separators of the path should be the operating system default separators.

Parameters:

fullPath - full path of the file containing the document

getRelativePath

public String getRelativePath()

Getter for the relative path of the file containing the document. The base directory depends on the concrete implementation. For feature file, it is the "features" directory of the project. For example file, it is the "examples" directory of the project. The file separators of the path are the operating system default separators.

Returns:

relative path of the file containing the document

setRelativePath

public void setRelativePath(String relativePath)

Setter for the relative path of the file containing the document. The base directory depends on the concrete implementation. For feature file, it is the "features" directory of the project. For example file, it is the "examples" directory of the project. The file separators of the path should be the operating system default separators.

Parameters:

relativePath - relative path of the file containing the document

hasComment

public boolean hasComment()

Are there any comments in the document?

Returns:

true if document has comments

getComments

public List<String> getComments()

Returns the comments of the document. If the document does not have comments, it returns an empty list.

Returns:

the comments of the document

getLanguage

public String getLanguage()

Returns the language code of the document. It is 2 characters long.

Returns:

the language code of the document

setLanguage

public void setLanguage(String language)

Sets the language code of the document. It is 2 characters long.

Parameters:

language - the language code of the document

getKeyword

public String getKeyword()

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

Returns:

the root keyword of the documents

setKeyword

public void setKeyword(String keyword)

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

Parameters:

keyword - the root keyword of the documents

getName

public String getName()

Returns the name of the document.

Returns:

the name of the document

setName

public void setName(String name)

Sets the name of the document.

Parameters:

name - the name of the document

getDescription

public String getDescription()

Returns the description of the document.

Returns:

the description of the document

setDescription

public void setDescription(String description)

Sets the description of the document.

Parameters:

description - the description of the document

toString

public String toString()

Overrides:

toString in class Object