hu.ibello.bdd

Interface FeatureHandler

public interface FeatureHandler

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

The return values are in ibello's own format. The Feature class describes a Cucumber feature with scenarios and steps. Child steps are also loaded from step definition files.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
boolean	existsFeatureFile(String relativePath) Checks if a feature file exists.
Feature	loadFeature(String relativePath) Loads a single Cucumber feature file.
List<Feature>	loadFeatures() Loads all Cucumber features files.
List<Feature>	loadFeatures(Pattern relativePath) Loads multiple Cucumber features files.
List<Feature>	loadFeaturesWithTags(String... tags) Loads multiple Cucumber features files.
void	saveFeature(Feature feature) Saves the given feature into a gherkin feature file.

Method Detail

loadFeature

Feature loadFeature(String relativePath)
             throws BDDException

Loads a single Cucumber feature file.

Parameters:

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

Returns:

the loaded Cucumber feature data

Throws:

BDDException - if there was an error during loading the file

loadFeatures

List<Feature> loadFeatures(Pattern relativePath)
                    throws BDDException

Loads multiple Cucumber features 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 "features" directory of the project)

Returns:

the list of the loaded Cucumber features

Throws:

BDDException - if there was an error during loading a file

loadFeatures

List<Feature> loadFeatures()
                    throws BDDException

Loads all Cucumber features files.

Returns:

the list of the loaded Cucumber features

Throws:

BDDException - if there was an error during loading a file

loadFeaturesWithTags

List<Feature> loadFeaturesWithTags(String... tags)
                            throws BDDException

Loads multiple Cucumber features files. This method loads features by tags. If a feature has one of the specified tags, it will be loaded.

Parameters:

tags - the tags of the loaded features

Returns:

the list of the loaded Cucumber features

Throws:

BDDException - if there was an error during loading a file

existsFeatureFile

boolean existsFeatureFile(String relativePath)

Checks if a feature file exists.

Parameters:

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

Returns:

true if the given file exists, false otherwise

saveFeature

void saveFeature(Feature feature)
          throws BDDException

Saves the given feature 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:

feature - the feature we want to save

Throws:

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