net.thucydides.core.requirements

Class AnnotationBasedTagProvider

java.lang.Object

net.thucydides.core.requirements.AbstractRequirementsTagProvider

net.thucydides.core.requirements.AnnotationBasedTagProvider

All Implemented Interfaces:

RequirementsTagProvider, TagProvider

public class AnnotationBasedTagProvider
extends AbstractRequirementsTagProvider
implements RequirementsTagProvider

A requirements Provider that read requirement from class or package annotation. A class or package needs to be annotated with Narrative to be a requirement. All package above the class or package will also be considered requirement. The default root package is "stories", but can be change using ThucydidesSystemProperty.ANNOTATED_REQUIREMENTS_DIRECTORY It is recommanded to change the root package if the FileSystemRequirementsTagProvider is used.

See Also:

Narrative, ThucydidesSystemProperty.ANNOTATED_REQUIREMENTS_DIRECTORY

Field Summary

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

DEFAULT_CAPABILITY_TYPES, DEFAULT_ROOT_DIRECTORY, environmentVariables, rootDirectory

Constructor Summary

Constructors

Constructor and Description
AnnotationBasedTagProvider()
AnnotationBasedTagProvider(EnvironmentVariables vars)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.base.Optional<Requirement>	getParentRequirementOf(TestOutcome testOutcome)
com.google.common.base.Optional<Requirement>	getRequirementFor(TestTag testTag)
List<Requirement>	getRequirements()
Set<TestTag>	getTagsFor(TestOutcome testOutcome) Returns the tags associated with a given test outcome.

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

getDefaultRootDirectory, getDefaultType, getRequirementTypes, humanReadableVersionOf

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationBasedTagProvider

public AnnotationBasedTagProvider()

AnnotationBasedTagProvider

public AnnotationBasedTagProvider(EnvironmentVariables vars)

Method Detail

getRequirements

public List<Requirement> getRequirements()

Specified by:

getRequirements in interface RequirementsTagProvider

getParentRequirementOf

public com.google.common.base.Optional<Requirement> getParentRequirementOf(TestOutcome testOutcome)

Specified by:

getParentRequirementOf in interface RequirementsTagProvider

getRequirementFor

public com.google.common.base.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