org.openqa.selenium.support.FindBy Maven / Gradle / Ivy

Go to download
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC 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 org.openqa.selenium.support;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Field;
import org.openqa.selenium.By;

/**
 * Used to mark a field on a Page Object to indicate an alternative mechanism for locating the
 * element or a list of elements. Used in conjunction with {@link
 * org.openqa.selenium.support.PageFactory} this allows users to quickly and easily create
 * PageObjects.
 *
 * It can be used on a types as well, but will not be processed by default.
 *
 * 
You can either use this annotation by specifying both "how" and "using" or by specifying one
 * of the location strategies (eg: "id") with an appropriate value to use. Both options will
 * delegate down to the matching {@link org.openqa.selenium.By} methods in By class.
 *
 * 
For example, these two annotations point to the same element:
 *
 * 
 * @FindBy(id = "foobar") WebElement foobar;
 * @FindBy(how = How.ID, using = "foobar") WebElement foobar;
 * 
 *
 * and these two annotations point to the same list of elements:
 *
 * 
 * @FindBy(tagName = "a") List<WebElement> links;
 * @FindBy(how = How.TAG_NAME, using = "a") List<WebElement> links;
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE})
@PageFactoryFinder(FindBy.FindByBuilder.class)
public @interface FindBy {
  How how() default How.UNSET;

  String using() default "";

  String id() default "";

  String name() default "";

  String className() default "";

  String css() default "";

  String tagName() default "";

  String linkText() default "";

  String partialLinkText() default "";

  String xpath() default "";

  class FindByBuilder extends AbstractFindByBuilder {
    @Override
    public By buildIt(Object annotation, Field field) {
      FindBy findBy = (FindBy) annotation;
      assertValidFindBy(findBy);

      By ans = buildByFromShortFindBy(findBy);
      if (ans == null) {
        ans = buildByFromLongFindBy(findBy);
      }

      return ans;
    }
  }
}