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.

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 root package is defined using ThucydidesSystemProperty.THUCYDIDES_TEST_ROOT It is recommended to change the root package if the FileSystemRequirementsTagProvider is used.

See Also:

Narrative, ThucydidesSystemProperty.THUCYDIDES_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

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()
SortedMap<String,Requirement>	getRequirementsByPath()
Set<TestTag>	getTagsFor(TestOutcome testOutcome) Returns the tags associated with a given test outcome.
protected List<Class<?>>	loadClasses()

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

PackageAnnotationBasedTagProvider

public PackageAnnotationBasedTagProvider()

PackageAnnotationBasedTagProvider

public PackageAnnotationBasedTagProvider(EnvironmentVariables vars)

Method Detail

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

getRequirements

public List<Requirement> getRequirements()

Specified by:

getRequirements in interface RequirementsTagProvider

loadClasses

protected List<Class<?>> loadClasses()

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

getRequirementsByPath

public SortedMap<String,Requirement> getRequirementsByPath()