#565: The feature was completed

- bug fixes
- test coverage

Author: TikhomirovSergey

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

@@ -0,0 +1,61 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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 io.appium.java_client.pagefactory;
+
+/**
+ * Used to build a complex android automator locator
+ */
+public @interface AndroidBy {
+    /**
+     * It is an is Android UIAutomator string.
+     * Read http://developer.android.com/intl/ru/tools/testing-support-library/
+     * index.html#uia-apis
+     */
+    String uiAutomator() default "";
+
+    /**
+     * It an UI automation accessibility Id which is a convenient to Android.
+     * About Android accessibility
+     * https://developer.android.com/intl/ru/training/accessibility/accessible-app.html
+     */
+    String accessibility() default "";
+
+    /**
+     * It is an id of the target element.
+     */
+    String id() default "";
+
+    /**
+     * It is a className of the target element.
+     */
+    String className() default "";
+
+    /**
+     * It is a desired element tag.
+     */
+    String tagName() default "";
+
+    /**
+     * It is a xpath to the target element.
+     */
+    String xpath() default "";
+
+    /**
+     * @return priority of the searching. Higher number means lower priority.
+     */
+    int priority() default 0;
+}

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

@@ -26,18 +26,18 @@
 
 /**
  * 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
+ * series of {@link io.appium.java_client.pagefactory.AndroidBy} tags
  * It will then search for all elements that match any criteria. Note that elements
  * are not guaranteed to be in document order.
  */
 @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
+     * It is a set of {@link io.appium.java_client.pagefactory.AndroidBy} strategies which may
      * be used to find the target element.
      */
-    AndroidFindBy[] value();
+    AndroidBy[] value();
 
     /**
      * @return priority of the searching. Higher number means lower priority.

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

@@ -26,16 +26,16 @@
 
 /**
  * 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.
+ * a series of {@link io.appium.java_client.pagefactory.AndroidBy} tags.
  */
 @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
+     * It is a set of {@link io.appium.java_client.pagefactory.AndroidBy} strategies which build
      * the chain of the searching for the target element.
      */
-    AndroidFindBy[] value();
+    AndroidBy[] value();
 
     /**
      * @return priority of the searching. Higher number means lower priority.

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

@@ -34,14 +34,12 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
-import java.util.Comparator;
-import java.util.HashMap;
-import java.util.Map;
+import java.util.*;
 
+import static java.util.Arrays.asList;
 import static java.util.Arrays.sort;
 import static java.util.Optional.ofNullable;
 import static org.apache.commons.lang3.ArrayUtils.add;
-import static org.apache.commons.lang3.ArrayUtils.addAll;
 
 public class DefaultElementByBuilder extends AppiumByBuilder {
 
@@ -115,15 +113,16 @@ private By[] getBys(Class<? extends Annotation> singleLocator, Class<? extends A
         AnnotationComparator comparator = new AnnotationComparator();
         AnnotatedElement annotatedElement = annotatedElementContainer.getAnnotated();
 
-        Annotation[] annotations =  annotatedElement.getAnnotationsByType(singleLocator);
-        annotations = addAll(annotations, annotatedElement.getAnnotationsByType(chainedLocator));
-        annotations = addAll(annotations, annotatedElement.getAnnotationsByType(allLocator));
+        List<Annotation> annotations =  new ArrayList<>(asList(annotatedElement.getAnnotationsByType(singleLocator)));
+        annotations.addAll(asList(annotatedElement.getAnnotationsByType(chainedLocator)));
+        annotations.addAll(asList(annotatedElement.getAnnotationsByType(allLocator)));
 
-        sort(annotations, comparator);
+        Annotation[] annotationsArray = annotations.toArray(new Annotation[]{});
+        sort(annotationsArray, comparator);
         By[] result = new By[] {};
 
-        for (Annotation a: annotations) {
-            Class<?> annotationClass = a.getClass().getInterfaces()[0];
+        for (Annotation a: annotationsArray) {
+            Class<?> annotationClass = a.annotationType();
             if (singleLocator.equals(annotationClass)) {
                 result = add(result, createBy(new Annotation[] {a}, HowToUseSelectors.USE_ONE));
                 continue;
@@ -231,32 +230,34 @@ private static class AnnotationComparator implements Comparator<Annotation> {
 
         @Override
         public int compare(Annotation o1, Annotation o2) {
-            int priority1;
-            int priority2;
-            Method priority;
+            int p1;
+            int p2;
+            Method priority1;
+            Method priority2;
 
-            Class<?> c1 = o1.getClass().getInterfaces()[0];
-            Class<?> c2 = o2.getClass().getInterfaces()[0];
+            Class<?> c1 = o1.annotationType();
+            Class<?> c2 = o2.annotationType();
 
-            if (!c1.equals(c2)) {
-                throw new ClassCastException(String.format("Given annotations have different classes (%s, %s). " +
-                                "Annotations of the same classes are required.", c1.getName(), c2.getName()));
+            try {
+                priority1 = c1.getMethod(PRIORITY, ANNOTATION_ARGUMENTS);
+            } catch (NoSuchMethodException e) {
+                throw new ClassCastException(String.format("Class %s has no '%s' method", c1.getName(), PRIORITY));
             }
 
             try {
-                priority = c1.getMethod(PRIORITY, ANNOTATION_ARGUMENTS);
+                priority2 = c2.getMethod(PRIORITY, ANNOTATION_ARGUMENTS);
             } catch (NoSuchMethodException e) {
-                throw new ClassCastException(String.format("Class %s has no '%s' method", c1.getName(), PRIORITY));
+                throw new ClassCastException(String.format("Class %s has no '%s' method", c2.getName(), PRIORITY));
             }
 
             try {
-                priority1 = (int) priority.invoke(o1, ANNOTATION_PARAMETERS);
-                priority2 = (int) priority.invoke(o2, ANNOTATION_PARAMETERS);
+                p1 = (int) priority1.invoke(o1, ANNOTATION_PARAMETERS);
+                p2 = (int) priority2.invoke(o2, ANNOTATION_PARAMETERS);
 
-                if (priority2 > priority1) {
+                if (p2 > p1) {
                     return -1;
                 }
-                else if (priority2 < priority1){
+                else if (p2 < p1){
                     return 1;
                 }
                 else {

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

@@ -0,0 +1,63 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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 io.appium.java_client.pagefactory;
+
+
+/**
+ * Used to build a complex selendroid locator
+ */
+public @interface SelendroidBy {
+    /**
+     * It is an id of the target element.
+     */
+    String id() default "";
+
+    /**
+     * It is used in Selendroid mode instead of accessibility id.
+     */
+    String name() default "";
+
+    /**
+     * It is a className of the target element.
+     */
+    String className() default "";
+
+    /**
+     * It is a desired element tag.
+     */
+    String tagName() default "";
+
+    /**
+     * It is a xpath to the target element.
+     */
+    String xpath() default "";
+
+    /**
+     * It is a text of the desired element.
+     */
+    String linkText() default "";
+
+    /**
+     * It is a part of the text of the desired element.
+     */
+    String partialLinkText() default "";
+
+    /**
+     * @return priority of the searching. Higher number means lower priority.
+     */
+    int priority() default 0;
+}

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

@@ -23,17 +23,17 @@
 
 /**
  * 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.SelendroidFindBy} tags
+ * series of {@link io.appium.java_client.pagefactory.SelendroidBy} 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})
 public @interface SelendroidFindAll {
     /**
-     * It is a set of {@link io.appium.java_client.pagefactory.SelendroidFindBy} strategies which
+     * It is a set of {@link io.appium.java_client.pagefactory.SelendroidBy} strategies which
      * may be used to find the target element.
      */
-    SelendroidFindBy[] value();
+    SelendroidBy[] value();
 
     /**
      * @return priority of the searching. Higher number means lower priority.

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

@@ -23,15 +23,15 @@
 
 /**
  * Used to mark a field on a Page Object to indicate that lookup should
- * use a series of {@link io.appium.java_client.pagefactory.SelendroidFindBy} tags.
+ * use a series of {@link io.appium.java_client.pagefactory.SelendroidBy} tags.
  */
 @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.TYPE})
 public @interface SelendroidFindBys {
     /**
-     * It is a set of {@link io.appium.java_client.pagefactory.SelendroidFindBy} strategies which
+     * It is a set of {@link io.appium.java_client.pagefactory.SelendroidBy} strategies which
      * build the chain of the searching for the target element.
      */
-    SelendroidFindBy[] value();
+    SelendroidBy[] value();
 
     /**
      * @return priority of the searching. Higher number means lower priority.

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

@@ -0,0 +1,58 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * 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 io.appium.java_client.pagefactory;
+
+/**
+ * Used to build a complex Windows automation locator
+ */
+public @interface WindowsBy {
+
+    /**
+     * It is an is Windows automator string.
+     */
+    String windowsAutomation()  default "";
+
+    /**
+     * It an UI automation accessibility Id which is a convenient to Windows.
+     */
+    String accessibility() default "";
+
+    /**
+     * It is an id of the target element.
+     */
+    String id() default "";
+
+    /**
+     * It is a className of the target element.
+     */
+    String className() default "";
+
+    /**
+     * It is a desired element tag.
+     */
+    String tagName() default "";
+
+    /**
+     * It is a xpath to the target element.
+     */
+    String xpath() default "";
+
+    /**
+     * @return priority of the searching. Higher number means lower priority.
+     */
+    int priority() default 0;
+}

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

@@ -26,18 +26,18 @@
 
 /**
  * Used to mark a field on a Page/Screen Object to indicate that lookup should use a series
- * of {@link WindowsFindBy} tags
+ * of {@link WindowsBy} tags
  * It will then search for all elements that match any criteria. Note that elements
  * are not guaranteed to be in document order.
  */
 @Retention(RUNTIME) @Target({FIELD, TYPE})
 @Repeatable(WindowsFindByAllSet.class)
 public @interface WindowsFindAll {
     /**
-     * It is a set of {@link WindowsFindBy} strategies which may be
+     * It is a set of {@link WindowsBy} strategies which may be
      * used to find the target element.
      */
-    WindowsFindBy[] value();
+    WindowsBy[] value();
 
     /**
      * @return priority of the searching. Higher number means lower priority.

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

@@ -26,16 +26,16 @@
 
 /**
  * Used to mark a field on a Page Object to indicate that lookup should use
- * a series of {@link WindowsFindBy} tags.
+ * a series of {@link WindowsBy} tags.
  */
 @Retention(RUNTIME) @Target({FIELD, TYPE})
 @Repeatable(WindowsFindByChainSet.class)
 public @interface WindowsFindBys {
     /**
-     * It is a set of {@link WindowsFindBy} strategies which build
+     * It is a set of {@link WindowsBy} strategies which build
      * the chain of the searching for the target element.
      */
-    WindowsFindBy[] value();
+    WindowsBy[] value();
 
     /**
      * @return priority of the searching. Higher number means lower priority.