hu.ibello.bdd

Interface ExamplesHandler

public interface ExamplesHandler

With the methods of this class we can load and save Cucumber example files. The files will be loaded from the current ibello project.

The return values are in ibello's own format. The Examples class describes a Cucumber example with scenarios and steps.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
boolean	existsExamplesFile(String relativePath) Checks if an examples file exists.
List<Examples>	loadExamples(Pattern relativePath) Loads multiple Cucumber example files.
Examples	loadExamples(String relativePath) Loads a single Cucumber example file.
void	saveExamples(Examples examples) Saves the given examples into a gherkin feature file.

Method Detail

loadExamples

Examples loadExamples(String relativePath)
               throws BDDException

Loads a single Cucumber example file.

Parameters:

relativePath - the path to the file, relative to the "examples" directory of the project

Returns:

the loaded Cucumber example data

Throws:

BDDException - if there was an error during loading the file

loadExamples

List<Examples> loadExamples(Pattern relativePath)
                     throws BDDException

Loads multiple Cucumber example files. The method uses a regular expression to find the files. If a file's relative path matches the regular expression, it will be loaded.

Parameters:

relativePath - regular expression for the path to the file (which is relative to the "examples" directory of the project)

Returns:

the list of the loaded Cucumber examples

Throws:

BDDException - if there was an error during loading a file

existsExamplesFile

boolean existsExamplesFile(String relativePath)

Checks if an examples file exists.

Parameters:

relativePath - the path to the file, relative to the "examples" directory of the project

Returns:

true if the given file exists, false otherwise

saveExamples

void saveExamples(Examples examples)
           throws BDDException

Saves the given examples into a gherkin feature file. It overwrites the existing file. The file path should be specified with the BDDDocument.setFullPath(String) or BDDDocument.setRelativePath(String) method.

Parameters:

examples - the examples we want to save

Throws:

BDDException - if there was an error during saving the file or the file path is not specified