hu.ibello.search.Relation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ibello-api Show documentation

Ibello is an easy-to-use automated test framework for web applications. It's public API is ibello-api.

There is a newer version: 1.22.0

/*
 * Ark-Sys Kft. licenses this file to you 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 hu.ibello.search;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import hu.ibello.pages.PageObject;

/**
 * 
 * This annotation modifies the element search in a page object (see {@link PageObject}).
 * The modification means that the desired element is the descendant or the ancestor
 * of an anchor element. (This can be specified with the {@link Relation#type()}.)
 * The anchor element can be specified with the {@link Relation#by()} and {@link Relation#using()}
 * properties.
 * 
 * 
 * It is possible to add more than one Relation annotations to a field in a page object.
 * In this case, all modifiers will be applied on the field during the search.
 * 
 * About ibello search engine see {@link hu.ibello.search}.
 * @author Kornél Simon
 * @see Find
 * @see PageObject
 */
@Retention(RUNTIME)
@Target(FIELD)
@Repeatable(Relations.class)
public @interface Relation {

	/**
	 * Type of the relation between the desired and the anchor element.
	 * Optional, default is {@link RelationType#DESCENDANT_OF}
	 * @return relation type
	 * @see RelationType
	 */
	RelationType type() default RelationType.DESCENDANT_OF;
	
	/**
	 * Search algorithm of the anchor element.
	 * Optional, it's default value is {@link By#CSS_SELECTOR}.
	 * @return search algorithm
	 * @see By
	 */
	By by() default By.CSS_SELECTOR;
	
	/**
	 * Search pattern of the anchor element.
	 * It's value depends on the search algorithm - see {@link By}.
	 * @return search pattern
	 */
	String using();
}