#565: Repeatable complex locators

Author: TikhomirovSergey

src/main/java/io/appium/java_client/pagefactory/AndroidFindAll.java

@@ -16,18 +16,22 @@
 
 package io.appium.java_client.pagefactory;
 
-import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
 /**
  * Used to mark a field on a Page/Screen Object to indicate that lookup should use a
  * series of {@link io.appium.java_client.pagefactory.AndroidFindBy} tags
  * It will then search for all elements that match any criteria. Note that elements
  * are not guaranteed to be in document order.
  */
-@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.TYPE})
+@Retention(RUNTIME) @Target({FIELD, TYPE})
+@Repeatable(AndroidFindByAllSet.class)
 public @interface AndroidFindAll {
     /**
      * It is a set of {@link io.appium.java_client.pagefactory.AndroidFindBy} strategies which may

src/main/java/io/appium/java_client/pagefactory/AndroidFindBy.java

@@ -16,12 +16,14 @@
 
 package io.appium.java_client.pagefactory;
 
-import java.lang.annotation.ElementType;
 import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
 
 /**
  * Used to mark a field on a Page Object to indicate an alternative mechanism for locating the
@@ -30,7 +32,7 @@
  * this allows users to quickly and easily create PageObjects.
  * using Android UI selectors, accessibility, id, name, class name, tag and xpath
  */
-@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.TYPE})
+@Retention(RUNTIME) @Target({FIELD, TYPE})
 @Repeatable(AndroidFindBySet.class)
 public @interface AndroidFindBy {
     /**

src/main/java/io/appium/java_client/pagefactory/AndroidFindByAllSet.java

@@ -0,0 +1,22 @@
+package io.appium.java_client.pagefactory;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Defines set of chained/possible locators. Each one locator
+ * should be defined with {@link AndroidFindAll}
+ */
+@Target(value = {TYPE, FIELD})
+@Retention(value = RUNTIME)
+public @interface AndroidFindByAllSet {
+    /**
+     * @return an array of {@link AndroidFindAll} which builds a sequence of
+     * the chained searching for elements or a set of possible locators
+     */
+    AndroidFindAll[] value();
+}

src/main/java/io/appium/java_client/pagefactory/AndroidFindByChainSet.java

@@ -0,0 +1,22 @@
+package io.appium.java_client.pagefactory;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Defines set of chained/possible locators. Each one locator
+ * should be defined with {@link io.appium.java_client.pagefactory.AndroidFindBys}
+ */
+@Target(value = {TYPE, FIELD})
+@Retention(value = RUNTIME)
+public @interface AndroidFindByChainSet {
+    /**
+     * @return an array of {@link io.appium.java_client.pagefactory.AndroidFindBys} which builds a sequence of
+     * the chained searching for elements or a set of possible locators
+     */
+    AndroidFindBys[] value();
+}

src/main/java/io/appium/java_client/pagefactory/AndroidFindBySet.java

@@ -16,17 +16,19 @@
 
 package io.appium.java_client.pagefactory;
 
-import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
 /**
  * Defines set of chained/possible locators. Each one locator
  * should be defined with {@link io.appium.java_client.pagefactory.AndroidFindBy}
  */
-@Target(value = {ElementType.TYPE, ElementType.FIELD})
-@Retention(value = RetentionPolicy.RUNTIME)
+@Target(value = {TYPE, FIELD})
+@Retention(value = RUNTIME)
 public @interface AndroidFindBySet {
     /**
      * @return an array of {@link io.appium.java_client.pagefactory.AndroidFindBy} which builds a sequence of

src/main/java/io/appium/java_client/pagefactory/AndroidFindBys.java

@@ -16,16 +16,20 @@
 
 package io.appium.java_client.pagefactory;
 
-import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
 /**
  * Used to mark a field on a Page Object to indicate that lookup should use
  * a series of {@link io.appium.java_client.pagefactory.AndroidFindBy} tags.
  */
-@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.TYPE})
+@Retention(RUNTIME) @Target({FIELD, TYPE})
+@Repeatable(AndroidFindByChainSet.class)
 public @interface AndroidFindBys {
     /**
      * It is a set of {@link io.appium.java_client.pagefactory.AndroidFindBy} strategies which build

src/main/java/io/appium/java_client/pagefactory/WindowsFindAll.java

@@ -16,18 +16,22 @@
 
 package io.appium.java_client.pagefactory;
 
-import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
 /**
  * Used to mark a field on a Page/Screen Object to indicate that lookup should use a series
  * of {@link WindowsFindBy} tags
  * It will then search for all elements that match any criteria. Note that elements
  * are not guaranteed to be in document order.
  */
-@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.TYPE})
+@Retention(RUNTIME) @Target({FIELD, TYPE})
+@Repeatable(WindowsFindByAllSet.class)
 public @interface WindowsFindAll {
     /**
      * It is a set of {@link WindowsFindBy} strategies which may be

src/main/java/io/appium/java_client/pagefactory/WindowsFindBy.java

@@ -16,20 +16,22 @@
 
 package io.appium.java_client.pagefactory;
 
-import java.lang.annotation.ElementType;
 import java.lang.annotation.Repeatable;
 import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
 /**
  * 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.
  * using Windows automation selectors, accessibility, id, name, class name, tag and xpath
  */
-@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.TYPE})
+@Retention(RUNTIME) @Target({FIELD, TYPE})
 @Repeatable(WindowsFindBySet.class)
 public @interface WindowsFindBy {
 

src/main/java/io/appium/java_client/pagefactory/WindowsFindByAllSet.java

@@ -0,0 +1,22 @@
+package io.appium.java_client.pagefactory;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Defines set of chained/possible locators. Each one locator
+ * should be defined with {@link WindowsFindAll}
+ */
+@Target(value = {TYPE, FIELD})
+@Retention(value = RUNTIME)
+public @interface WindowsFindByAllSet {
+    /**
+     * @return an array of {@link WindowsFindAll} which builds a sequence of
+     * the chained searching for elements or a set of possible locators
+     */
+    WindowsFindAll[] value();
+}

src/main/java/io/appium/java_client/pagefactory/WindowsFindByChainSet.java

@@ -0,0 +1,22 @@
+package io.appium.java_client.pagefactory;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Defines set of chained/possible locators. Each one locator
+ * should be defined with {@link WindowsFindBys}
+ */
+@Target(value = {TYPE, FIELD})
+@Retention(value = RUNTIME)
+public @interface WindowsFindByChainSet {
+    /**
+     * @return an array of {@link WindowsFindBys} which builds a sequence of
+     * the chained searching for elements or a set of possible locators
+     */
+    WindowsFindBys[] value();
+}