net.thucydides.core.requirements

Class PackageAnnotationBasedTagProvider

java.lang.Object

net.thucydides.core.requirements.AbstractRequirementsTagProvider

net.thucydides.core.requirements.PackageAnnotationBasedTagProvider

All Implemented Interfaces:

CoreTagProvider, OverridableTagProvider, RequirementsTagProvider, TagProvider

public class PackageAnnotationBasedTagProvider
extends AbstractRequirementsTagProvider
implements RequirementsTagProvider, OverridableTagProvider

A requirements Provider that reads requirement from class or package annotation. The root package is defined using ThucydidesSystemProperty.SERENITY_TEST_ROOT It is recommended to change the root package if the FileSystemRequirementsTagProvider is used.

See Also:

Narrative, ThucydidesSystemProperty.SERENITY_TEST_ROOT

Field Summary

Fields inherited from class net.thucydides.core.requirements.AbstractRequirementsTagProvider

environmentVariables, requirementsConfiguration, requirementsService, rootDirectory

Constructor Summary

Constructors

Constructor and Description
PackageAnnotationBasedTagProvider()
PackageAnnotationBasedTagProvider(EnvironmentVariables vars)

Method Summary

Modifier and Type	Method and Description
Optional<Requirement>	getParentRequirementOf(TestOutcome testOutcome)
Optional<Requirement>	getRequirementFor(TestTag testTag)
List<Requirement>	getRequirements()
Set<TestTag>	getTagsFor(TestOutcome testOutcome) Returns the tags associated with a given test outcome.
protected List<Class<?>>	loadClassesFromPath()

Methods inherited from class net.thucydides.core.requirements.AbstractRequirementsTagProvider

firstRequirementFoundIn, getDefaultRootDirectory, getDefaultType, getDefaultType, getParentRequirementOf, getRequirementTypes, getRequirementTypes, humanReadableVersionOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.thucydides.core.requirements.RequirementsTagProvider

getOverview, getParentRequirementOf

Constructor Detail

PackageAnnotationBasedTagProvider

public PackageAnnotationBasedTagProvider()

PackageAnnotationBasedTagProvider

public PackageAnnotationBasedTagProvider(EnvironmentVariables vars)

Method Detail

getRequirements

public List<Requirement> getRequirements()

Specified by:

getRequirements in interface RequirementsTagProvider

Specified by:

getRequirements in class AbstractRequirementsTagProvider

getParentRequirementOf

public Optional<Requirement> getParentRequirementOf(TestOutcome testOutcome)

Specified by:

getParentRequirementOf in interface RequirementsTagProvider

getRequirementFor

public Optional<Requirement> getRequirementFor(TestTag testTag)

Specified by:

getRequirementFor in interface RequirementsTagProvider

getTagsFor

public Set<TestTag> getTagsFor(TestOutcome testOutcome)

Description copied from interface: TagProvider

Returns the tags associated with a given test outcome.

Specified by:

getTagsFor in interface TagProvider

Parameters:

testOutcome - the outcome for a specific test

Returns:

the tags associated with a given test outcome.

loadClassesFromPath

protected List<Class<?>> loadClassesFromPath()