hu.ibello.search.Find 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.Retention;
import java.lang.annotation.Target;

import hu.ibello.elements.WebElement;
import hu.ibello.elements.WebElements;
import hu.ibello.pages.PageObject;

/**
 * Basic search annotation. All fields in a page object marked with this annotation
 * will be created automatically by the injector. (See {@link PageObject}.)
 * About ibello search engine see {@link hu.ibello.search}.
 * @author Kornél Simon
 *
 */
@Retention(RUNTIME)
@Target(FIELD)
public @interface Find {

	/**
	 * Search algorithm. If not specified, search algorithm will be {@link By#CSS_SELECTOR}.
	 * @return search algorithm
	 */
	By by() default By.CSS_SELECTOR;
	
	/**
	 * Search pattern. It's meaning depends on the search algorithm - see enum constants of {@link By}.
	 * It may contain parameters which can be specified later
	 * (see {@link WebElement#applyParameters(Object...)} and {@link WebElements#applyParameters(Object...)}).
	 * @return search pattern
	 */
	String using();
}