ru.yandex.qatools.allure.utils

Class AnnotationManager

java.lang.Object

ru.yandex.qatools.allure.utils.AnnotationManager

public class AnnotationManager
extends Object

Util, using to collect information from class and method annotations

Constructor Summary

Constructors

Constructor and Description
AnnotationManager(Annotation... annotations) Construct AnnotationManager using given annotations
AnnotationManager(Collection<Annotation> annotations) Construct AnnotationManager using given annotations

Method Summary

Modifier and Type	Method and Description
<T extends Annotation> T	getAnnotation(Class<T> annotationType) Find annotation with specified type into annotations
ru.yandex.qatools.allure.model.Description	getDescription() Find first Description annotation
List<ru.yandex.qatools.allure.model.Label>	getFeatureLabels() Construct label for all Features annotations using AllureModelUtils.createFeatureLabel(String)
String	getIssueKey() Find first Issue annotation
String[]	getIssueKeys() Find Issues annotation and return respective key
ru.yandex.qatools.allure.model.SeverityLevel	getSeverity() Find first Severity annotation
List<ru.yandex.qatools.allure.model.Label>	getStoryLabels() Construct label for all Stories annotations using AllureModelUtils.createStoryLabel(String)
String	getTitle() Find first Title annotation
<T extends Annotation> boolean	isAnnotationPresent(Class<T> annotationType) Returns true if annotations contains annotation with specified type, false otherwise
boolean	isDescriptionAnnotationPresent()
boolean	isFeaturesAnnotationPresent()
boolean	isIssueAnnotationPresent()
boolean	isIssuesAnnotationPresent()
boolean	isSeverityAnnotationPresent()
boolean	isStoriesAnnotationPresent()
boolean	isTestCaseIdAnnotationPresent()
boolean	isTitleAnnotationPresent()
void	setDefaults(Annotation[] defaultAnnotations) Set default values for annotations.
void	update(TestCaseStartedEvent event) Sets into specified TestCaseStartedEvent information from Allure annotations.
void	update(TestSuiteStartedEvent event) Sets into specified TestSuiteStartedEvent information from Allure annotations.
static TestCaseStartedEvent	withExecutorInfo(TestCaseStartedEvent event) Add information about host and thread to specified test case started event

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationManager

public AnnotationManager(Collection<Annotation> annotations)

Construct AnnotationManager using given annotations

Parameters:

annotations - initial value for annotations

AnnotationManager

public AnnotationManager(Annotation... annotations)

Construct AnnotationManager using given annotations

Parameters:

annotations - initial value for annotations

Method Detail

setDefaults

public void setDefaults(Annotation[] defaultAnnotations)

Set default values for annotations. Initial annotation take precedence over the default annotation when both annotation types are present

Parameters:

defaultAnnotations - default value for annotations

update

public void update(TestSuiteStartedEvent event)

Sets into specified TestSuiteStartedEvent information from Allure annotations.

Parameters:

event - to change

update

public void update(TestCaseStartedEvent event)

Sets into specified TestCaseStartedEvent information from Allure annotations.

Parameters:

event - to change

withExecutorInfo

public static TestCaseStartedEvent withExecutorInfo(TestCaseStartedEvent event)

Add information about host and thread to specified test case started event

Parameters:

event - given event to update

Returns:

updated event

isTitleAnnotationPresent

public boolean isTitleAnnotationPresent()

Returns:

true if Title annotation present in annotations and false otherwise

isDescriptionAnnotationPresent

public boolean isDescriptionAnnotationPresent()

Returns:

true if Description annotation present in annotations and false otherwise

isSeverityAnnotationPresent

public boolean isSeverityAnnotationPresent()

Returns:

true if Severity annotation present in annotations and false otherwise

isStoriesAnnotationPresent

public boolean isStoriesAnnotationPresent()

Returns:

true if Stories annotation present in annotations and false otherwise

isFeaturesAnnotationPresent

public boolean isFeaturesAnnotationPresent()

Returns:

true if Features annotation present in annotations and false otherwise

isIssuesAnnotationPresent

public boolean isIssuesAnnotationPresent()

Returns:

true if Issues annotation present in annotations and false otherwise

isIssueAnnotationPresent

public boolean isIssueAnnotationPresent()

Returns:

true if Issue annotation present in annotations and false otherwise

isTestCaseIdAnnotationPresent

public boolean isTestCaseIdAnnotationPresent()

getTitle

public String getTitle()

Find first Title annotation

Returns:

title or null if annotation doesn't present

getDescription

public ru.yandex.qatools.allure.model.Description getDescription()

Find first Description annotation

Returns:

Description or null if annotation doesn't present

getSeverity

public ru.yandex.qatools.allure.model.SeverityLevel getSeverity()

Find first Severity annotation

Returns:

SeverityLevel or null if annotation doesn't present

getIssueKey

public String getIssueKey()

Find first Issue annotation

Returns:

issue key or null if annotation is not present

getStoryLabels

public List<ru.yandex.qatools.allure.model.Label> getStoryLabels()

Construct label for all Stories annotations using AllureModelUtils.createStoryLabel(String)

Returns:

List of created labels

getFeatureLabels

public List<ru.yandex.qatools.allure.model.Label> getFeatureLabels()

Construct label for all Features annotations using AllureModelUtils.createFeatureLabel(String)

Returns:

List of created labels

getIssueKeys

public String[] getIssueKeys()

Find Issues annotation and return respective key

Returns:

issue keys or empty array if annotation isn't present

isAnnotationPresent

public <T extends Annotation> boolean isAnnotationPresent(Class<T> annotationType)

Returns true if annotations contains annotation with specified type, false otherwise

Parameters:

annotationType - annotation type to find

Returns:

true if annotations contains annotation with specified type, false otherwise

getAnnotation

public <T extends Annotation> T getAnnotation(Class<T> annotationType)

Find annotation with specified type into annotations

Parameters:

annotationType - annotation type to find

Returns:

the first found annotation with specified type, of null if annotations doesn't contains such