Add factories annotations instead of getPriority() and getName()

README.md

@@ -1211,6 +1211,7 @@ A ```WebDriverFactory``` implementation is responsible for creating new instance
 For instance, to run your tests on [BrowserStack](https://browserstack.com)
 
 ```java
+@FactoryName("browserstack")
 public class BrowserStackWebDriverFactory implements WebDriverFactory {
     @Override
     public WebDriver newWebDriver() {
@@ -1233,11 +1234,6 @@ public class BrowserStackWebDriverFactory implements WebDriverFactory {
 
         return new RemoteWebDriver(hubURL, caps);
     }
-
-    @Override
-    public String[] getNames() {
-        return new String[0];
-    }
 }
 ```
 

fluentlenium-core/src/main/java/org/fluentlenium/configuration/AbstractFactoryRegistryImpl.java

@@ -4,6 +4,7 @@
 
 import java.lang.reflect.Modifier;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.LinkedHashMap;
@@ -45,7 +46,13 @@ public synchronized T getDefault() {
         Collections.sort(factories, new Comparator<T>() {
             @Override
             public int compare(T o1, T o2) {
-                return -Integer.compare(o1.getPriority(), o2.getPriority());
+                FactoryPriority annotation1 = o1.getClass().getAnnotation(FactoryPriority.class);
+                int p1 = annotation1 == null ? 0 : annotation1.value();
+
+                FactoryPriority annotation2 = o2.getClass().getAnnotation(FactoryPriority.class);
+                int p2 = annotation2 == null ? 0 : annotation2.value();
+
+                return -Integer.compare(p1, p2);
             }
         });
         List<T> filteredFactories = new ArrayList<>();
@@ -97,23 +104,42 @@ public synchronized T get(String name) {
     /**
      * Register a new factory.
      * <p>
-     * It will also register the factory under names returned by {@link AlternativeNames#getAlternativeNames()} if
-     * it implements {@link AlternativeNames}.
+     * It will use {@link FactoryName} value as the default name.
+     * <p>
+     * It will also register the factory under names returned by {@link FactoryNames#getNames()}} if
+     * it implements {@link FactoryNames}.
      *
      * @param factory factory to register
      */
     public synchronized void register(T factory) {
-        if (factories.containsKey(factory.getName())) {
-            throw new ConfigurationException("A factory is already registered with this name: " +
-                    factory.getName() + " (" + factories.get(factory.getName()) + ")");
+        FactoryName annotation = factory.getClass().getAnnotation(FactoryName.class);
+        String annotationName = annotation == null ? null : annotation.value();
+
+        List<String> names = new ArrayList<>();
+        if (annotationName != null) {
+            names.add(annotationName);
+        }
+        if (factory instanceof FactoryNames) {
+            names.addAll(Arrays.asList(((FactoryNames) factory).getNames()));
         }
-        factories.put(factory.getName(), factory);
-        if (factory instanceof AlternativeNames) {
-            for (String alternativeName : ((AlternativeNames) factory).getAlternativeNames()) {
-                if (!factories.containsKey(alternativeName)) {
-                    factories.put(alternativeName, factory);
-                }
 
+        boolean registered = false;
+
+        if (names.size() == 0) {
+            throw new ConfigurationException("Factory " + factory.getClass().getName() + " has no name defined. Use @FactoryName annotation or implement FactoryNames.");
+        }
+
+        for (String name : names) {
+            if (!registered) {
+                if (factories.containsKey(name)) {
+                    throw new ConfigurationException("A factory is already registered with this name: " +
+                            name + " (" + factories.get(name) + ")");
+                }
+                factories.put(name, factory);
+                registered = true;
+            }
+            if (!factories.containsKey(name)) {
+                factories.put(name, factory);
             }
         }
 

fluentlenium-core/src/main/java/org/fluentlenium/configuration/DefaultWebDriverFactories.java

@@ -12,81 +12,53 @@
 import java.net.URL;
 
 public class DefaultWebDriverFactories {
+    @FactoryPriority(128)
     public static class FirefoxWebDriverFactory extends ReflectiveWebDriverFactory {
         public FirefoxWebDriverFactory() {
             super("firefox", "org.openqa.selenium.firefox.FirefoxDriver");
         }
-
-        @Override
-        public int getPriority() {
-            return 128;
-        }
     }
 
+    @FactoryPriority(127)
     public static class MarionetteWebDriverFactory extends ReflectiveWebDriverFactory {
         public MarionetteWebDriverFactory() {
             super("marionette", "org.openqa.selenium.firefox.MarionetteDriver");
         }
-
-        @Override
-        public int getPriority() {
-            return 127;
-        }
     }
 
+    @FactoryPriority(64)
     public static class ChromeWebDriverFactory extends ReflectiveWebDriverFactory {
         public ChromeWebDriverFactory() {
             super("chrome", "org.openqa.selenium.chrome.ChromeDriver");
         }
-
-        @Override
-        public int getPriority() {
-            return 64;
-        }
     }
 
+    @FactoryPriority(32)
     public static class InternetExplorerWebDriverFactory extends ReflectiveWebDriverFactory {
         public InternetExplorerWebDriverFactory() {
             super("ie", "org.openqa.selenium.ie.InternetExplorerDriver");
         }
-
-        @Override
-        public int getPriority() {
-            return 32;
-        }
     }
 
+    @FactoryPriority(31)
     public static class EdgeWebDriverFactory extends ReflectiveWebDriverFactory {
         public EdgeWebDriverFactory() {
             super("edge", "org.openqa.selenium.edge.EdgeDriver");
         }
-
-        @Override
-        public int getPriority() {
-            return 31;
-        }
     }
 
+    @FactoryPriority(16)
     public static class SafaryWebDriverFactory extends ReflectiveWebDriverFactory {
         public SafaryWebDriverFactory() {
             super("safari", "org.openqa.selenium.safari.SafariDriver");
         }
-
-        @Override
-        public int getPriority() {
-            return 16;
-        }
     }
 
+    @FactoryPriority(8)
     public static class PhantomJSWebDriverFactory extends ReflectiveWebDriverFactory {
         public PhantomJSWebDriverFactory() {
             super("phantomjs", "org.openqa.selenium.phantomjs.PhantomJSDriver");
         }
-
-        @Override
-        public int getPriority() {
-            return 8;
-        }
     }
 
     public static class RemoteWebDriverFactory extends ReflectiveWebDriverFactory {
@@ -121,11 +93,6 @@ protected WebDriver newRemoteWebDriver(Object[] args) throws NoSuchMethodExcepti
             WebDriver webDriver = ReflectionUtils.getConstructor(webDriverClass, URL.class, Capabilities.class).newInstance(args);
             return new Augmenter().augment(webDriver);
         }
-
-        @Override
-        public int getPriority() {
-            return 0;
-        }
     }
 
     public static class HtmlUnitWebDriverFactory extends ReflectiveWebDriverFactory {
@@ -139,11 +106,6 @@ protected DesiredCapabilities newDefaultCapabilities() {
             desiredCapabilities.setJavascriptEnabled(true);
             return desiredCapabilities;
         }
-
-        @Override
-        public int getPriority() {
-            return -128;
-        }
     }
 
 }

fluentlenium-core/src/main/java/org/fluentlenium/configuration/Factory.java

@@ -1,19 +1,11 @@
 package org.fluentlenium.configuration;
 
+/**
+ * Marker interface for factories.
+ *
+ * @see FactoryPriority
+ * @see FactoryName
+ */
 public interface Factory {
-    /**
-     * Primary name of this factory.
-     * <p>
-     * To register it with alternative name, use {@link AlternativeNames}.
-     *
-     * @return Primary name
-     */
-    String getName();
 
-    /**
-     * Priority of the factory to be grabbed as default Factory.
-     *
-     * @return a priority index
-     */
-    int getPriority();
 }

fluentlenium-core/src/main/java/org/fluentlenium/configuration/FactoryName.java

@@ -0,0 +1,17 @@
+package org.fluentlenium.configuration;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Define names for a factory
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface FactoryName {
+    String value();
+}

fluentlenium-core/src/main/java/org/fluentlenium/configuration/FactoryNames.java

@@ -0,0 +1,15 @@
+package org.fluentlenium.configuration;
+
+/**
+ * Add names to a factory.
+ * <p>
+ * {@link Factory} implementations can implement this interface to be registered in registry with those names.
+ */
+public interface FactoryNames {
+    /**
+     * Get the names.
+     *
+     * @return array of names
+     */
+    String[] getNames();
+}

fluentlenium-core/src/main/java/org/fluentlenium/configuration/FactoryPriority.java

@@ -0,0 +1,18 @@
+package org.fluentlenium.configuration;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+
+/**
+ * Defines the priority of the factory.
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+public @interface FactoryPriority {
+    int value();
+}

fluentlenium-core/src/main/java/org/fluentlenium/configuration/MethodInvocationReflectionFactory.java

@@ -6,7 +6,7 @@
 import java.lang.reflect.Method;
 
 @IndexIgnore
-public class MethodInvocationReflectionFactory implements CapabilitiesFactory, AlternativeNames {
+public class MethodInvocationReflectionFactory implements CapabilitiesFactory, FactoryNames {
     private final Method method;
     private final Object instance;
     private final Object[] args;
@@ -17,16 +17,6 @@ public MethodInvocationReflectionFactory(Method method, Object instance, Object.
         this.args = args;
     }
 
-    @Override
-    public String getName() {
-        return this.method.getDeclaringClass().getName() + "." + this.method.getName();
-    }
-
-    @Override
-    public int getPriority() {
-        return 0;
-    }
-
     @Override
     public Capabilities newCapabilities() {
         try {
@@ -39,8 +29,9 @@ public Capabilities newCapabilities() {
     }
 
     @Override
-    public String[] getAlternativeNames() {
+    public String[] getNames() {
         return new String[]{
+                this.method.getDeclaringClass().getName() + "." + this.method.getName(),
                 this.method.getDeclaringClass().getSimpleName() + "." + this.method.getName(),
                 this.method.getName()
         };

fluentlenium-core/src/main/java/org/fluentlenium/configuration/ReflectiveCapabilitiesFactory.java

@@ -6,11 +6,14 @@
 import org.openqa.selenium.remote.DesiredCapabilities;
 
 import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
 
 /**
  * A simple {@link CapabilitiesFactory} that create {@link Capabilities} instances using reflection.
  */
-public class ReflectiveCapabilitiesFactory implements CapabilitiesFactory, AlternativeNames, ReflectiveFactory {
+public class ReflectiveCapabilitiesFactory implements CapabilitiesFactory, FactoryNames, ReflectiveFactory {
     private String name;
     private Object[] args;
     private String capabilitiesClassName;
@@ -62,21 +65,12 @@ public Capabilities newCapabilities() {
         }
     }
 
-    @Override
-    public String getName() {
-        return name;
-    }
-
-    @Override
-    public String[] getAlternativeNames() {
+    public String[] getNames() {
+        List<String> names = new ArrayList<>(Arrays.asList(name));
         if (capabilitiesClass != null) {
-            return new String[]{capabilitiesClass.getName(), capabilitiesClass.getSimpleName()};
+            names.add(capabilitiesClass.getName());
+            names.add(capabilitiesClass.getSimpleName());
         }
-        return new String[0];
-    }
-
-    @Override
-    public int getPriority() {
-        return 0;
+        return names.toArray(new String[names.size()]);
     }
 }