com.vaadin.testbench.annotations.Attribute Maven / Gradle / Ivy
/**
* Copyright (C) 2000-2022 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.testbench.annotations;
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;
/**
* Additional qualifier to be used on element classes which do not use an unique
* tag name.
*
* While custom elements can be uniquely identified using their tag name, e.g.
* <vaadin-button>. Flow views and server side composites
* cannot be identified this way but typically needs an additional filter which
* can be defined using this annotation.
*
* For instance, given public class MyView extends Div and the
* corresponding element class
* public class MyViewElement extends DivElement would match any
* <div> on the page. To uniquely match
* MyViewElement, you could add e.g.setId("myview");
* in the view and a corresponding
* @Attribute(name="id", value="myview") for
* MyViewElement.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
@Repeatable(Attribute.Container.class)
public @interface Attribute {
public static final String DEFAULT_VALUE = "THE_DEFAULT_VALUE_WHICH_YOU_SURELY_NEVER_EVER_WILL_USE_FOR_REAL, RIGHT?!";
/**
* Replaced by the simple class name of the element class, with any
* Element or PageObject suffix removed, and
* converted to dash-separated-format when used with either
* {@link #contains()} or {@link #value()},
*/
public static final String SIMPLE_CLASS_NAME = "THE_CONVENTION_VALUE_WHICH_YOU_SURELY_NEVER_EVER_WILL_USE_FOR_REAL, RIGHT?!";
/**
* The name of the attribute to check.
*
* Matches the value of the attribute with the value in {@link #value()} or
* matches a token inside this value with {@link #contains()}. If neither
* {@link #value()} nor {@link #contains()} is defined, only ensures that
* the attribute is present.
*
* @return the name of the attribute to match
*/
String name();
/**
* The value to match with the attribute value.
*
* This will match the given value to the full value of the attribute. To
* match only a token, use {@link #contains()}.
*
* @return the value to match with the attribute value
*/
String value() default DEFAULT_VALUE;
/**
* The value to find within the attribute value.
*
* This will match if the given string is one matches one of the space
* separated tokens the attribute value consists of. To match the whole
* attribute value, use {@link #value()}.
*
* @return the value find inside the attribute value
*/
String contains() default DEFAULT_VALUE;
/**
* Internal annotation to enable use of multiple {@link Attribute}
* annotations.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Inherited
public @interface Container {
/**
* Internally used to enable use of multiple {@link Attribute}
* annotations.
*
*
* @return an array of the Attribute annotations
*/
Attribute[] value();
}
}