io.qameta.allure.LabelAnnotation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of allure-java-commons Show documentation
Show all versions of allure-java-commons Show documentation
Module allure-java-commons of Allure Framework.
/*
* Copyright 2016-2024 Qameta Software Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.qameta.allure;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Marker annotation. Annotations marked by this annotation will be discovered
* by Allure and added to test results as a label.
*
* @see Epic
* @see Feature
* @see Story
*/
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
@Repeatable(LabelAnnotations.class)
public @interface LabelAnnotation {
String DEFAULT_VALUE = "$$$$$$$$__value__$$$$$$$$";
/**
* The name of label. Some build-in names can be
* found in {@link io.qameta.allure.util.ResultsUtils}. You can
* also use any custom label name and create mapping for it in
* Allure Enterprise or Allure 3.
*
* @return the name of label to add.
*/
String name();
/**
* Th value of label. In not specified will take value from value()
* method of target annotation.
*
* @return the value of label to add.
*/
String value() default DEFAULT_VALUE;
}