Merge pull request appium#113 from TikhomirovSergey/interfacesRefactor

appium#105. Act II. AppiumDriver became abstract.

Author: Jonahss

pom.xml

@@ -15,7 +15,7 @@
  <dependency>
  <groupId>org.seleniumhq.selenium</groupId>
  <artifactId>selenium-java</artifactId>
- <version>2.42.2</version>
+ <version>2.43.1</version>
  </dependency>
  <dependency>
  <groupId>junit</groupId>

src/main/java/io/appium/java_client/AppiumDriver.java

@@ -39,22 +39,22 @@
 
 import static io.appium.java_client.MobileCommand.*;
 
-public class AppiumDriver extends RemoteWebDriver implements MobileDriver,
-ContextAware, Rotatable, FindsByIosUIAutomation,
-FindsByAndroidUIAutomator, FindsByAccessibilityId, LocationContext,
-DeviceActionShortcuts, TouchShortcuts, InteractsWithFiles, InteractsWithApps {
+public abstract class AppiumDriver extends RemoteWebDriver implements MobileDriver,
+ContextAware, Rotatable, FindsByAccessibilityId, LocationContext,
+DeviceActionShortcuts, TouchShortcuts, InteractsWithFiles,
+InteractsWithApps {
 
 private final static ErrorHandler errorHandler = new ErrorHandler(
 new ErrorCodesMobile(), true);
 private URL remoteAddress;
 private RemoteLocationContext locationContext;
 private ExecuteMethod executeMethod;
 
-//frequently used command parameters
+// frequently used command parameters
 protected final String KEY_CODE = "keycode";
 protected final String PATH = "path";
 private final String SETTINGS = "settings";
-
+
 /**
  * @param originalCapabilities
  * the given {@link Capabilities}
@@ -71,7 +71,7 @@ protected static Capabilities substituteMobilePlatform(
 }
 
 /**
- * @param param 
+ * @param param
  * is a parameter name
  * @param value
  * is the parameter value
@@ -83,23 +83,25 @@ protected static ImmutableMap<String, Object> getCommandImmutableMap(
 builder.put(param, value);
 return builder.build();
 }
-
+
 /**
  * 
- * @param params is the array with parameter names
- * @param values is the array with parameter values
+ * @param params
+ * is the array with parameter names
+ * @param values
+ * is the array with parameter values
  * @return built {@link ImmutableMap}
  */
 protected static ImmutableMap<String, Object> getCommandImmutableMap(
 String[] params, Object[] values) {
 ImmutableMap.Builder<String, Object> builder = ImmutableMap.builder();
-for (int i=0; i < params.length; i++ ){
-if (_isNotNullOrEmpty(params[i]) && _isNotNullOrEmpty(values[i])){
+for (int i = 0; i < params.length; i++) {
+if (_isNotNullOrEmpty(params[i]) && _isNotNullOrEmpty(values[i])) {
 builder.put(params[i], values[i]);
 }
 }
 return builder.build();
-}
+}
 
 public AppiumDriver(URL remoteAddress, Capabilities desiredCapabilities) {
 
@@ -194,57 +196,56 @@ public void resetApp() {
 execute(MobileCommand.RESET);
 }
 
+/**
+ * @see InteractsWithApps#isAppInstalled(String)
+ */
+@Override
+public boolean isAppInstalled(String bundleId) {
+Response response = execute(IS_APP_INSTALLED,
+ImmutableMap.of("bundleId", bundleId));
+
+return Boolean.parseBoolean(response.getValue().toString());
+}
+
+/**
+ * @see InteractsWithApps#installApp(String)
+ */
+@Override
+public void installApp(String appPath) {
+execute(INSTALL_APP, ImmutableMap.of("appPath", appPath));
+}
 
- /**
- * @see InteractsWithApps#isAppInstalled(String)
- */
- @Override
- public boolean isAppInstalled(String bundleId) {
- Response response = execute(IS_APP_INSTALLED,
- ImmutableMap.of("bundleId", bundleId));
-
- return Boolean.parseBoolean(response.getValue().toString());
- }
-
- /**
- * @see InteractsWithApps#installApp(String)
- */
- @Override
- public void installApp(String appPath) {
- execute(INSTALL_APP, ImmutableMap.of("appPath", appPath));
- }
-
- /**
- * @see InteractsWithApps#removeApp(String)
- */
- @Override
- public void removeApp(String bundleId) {
- execute(REMOVE_APP, ImmutableMap.of("bundleId", bundleId));
- }
-
- /**
- * @see InteractsWithApps#launchApp()
- */
- @Override
- public void launchApp() {
- execute(LAUNCH_APP);
- }
-
- /**
- * @see InteractsWithApps#closeApp()
- */
- @Override
- public void closeApp() {
- execute(CLOSE_APP);
- }
-
- /**
- * @see InteractsWithApps#runAppInBackground(int)
- */
- @Override
- public void runAppInBackground(int seconds) {
- execute(RUN_APP_IN_BACKGROUND, ImmutableMap.of("seconds", seconds));
- }
+/**
+ * @see InteractsWithApps#removeApp(String)
+ */
+@Override
+public void removeApp(String bundleId) {
+execute(REMOVE_APP, ImmutableMap.of("bundleId", bundleId));
+}
+
+/**
+ * @see InteractsWithApps#launchApp()
+ */
+@Override
+public void launchApp() {
+execute(LAUNCH_APP);
+}
+
+/**
+ * @see InteractsWithApps#closeApp()
+ */
+@Override
+public void closeApp() {
+execute(CLOSE_APP);
+}
+
+/**
+ * @see InteractsWithApps#runAppInBackground(int)
+ */
+@Override
+public void runAppInBackground(int seconds) {
+execute(RUN_APP_IN_BACKGROUND, ImmutableMap.of("seconds", seconds));
+}
 
 /**
  * Send a key event to the device
@@ -257,13 +258,13 @@ public void sendKeyEvent(int key) {
 execute(KEY_EVENT, getCommandImmutableMap(KEY_CODE, key));
 }
 
- /**
-  * @see DeviceActionShortcuts#hideKeyboard()
-  */
- @Override
- public void hideKeyboard() {
- execute(HIDE_KEYBOARD);
- }
+/**
+ * @see DeviceActionShortcuts#hideKeyboard()
+ */
+@Override
+public void hideKeyboard() {
+execute(HIDE_KEYBOARD);
+}
 
 /**
  * @see InteractsWithFiles#pullFile(String)
@@ -277,8 +278,8 @@ public byte[] pullFile(String remotePath) {
 return DatatypeConverter.parseBase64Binary(base64String);
 }
 
-/** 
- * @see InteractsWithFiles#pullFolder(String) 
+/**
+ * @see InteractsWithFiles#pullFolder(String)
  */
 @Override
 public byte[] pullFolder(String remotePath) {
@@ -315,7 +316,7 @@ public void performMultiTouchAction(MultiTouchAction multiAction) {
 }
 
 /**
- *@see TouchShortcuts#tap(int, WebElement, int)
+ * @see TouchShortcuts#tap(int, WebElement, int)
  */
 @Override
 public void tap(int fingers, WebElement element, int duration) {
@@ -398,8 +399,8 @@ public void pinch(int x, int y) {
 }
 
 /**
- *  @see TouchShortcuts#zoom(WebElement)
- */ 
+ * @see TouchShortcuts#zoom(WebElement)
+ */
 @Override
 public void zoom(WebElement el) {
 MultiTouchAction multiTouch = new MultiTouchAction(this);
@@ -479,18 +480,18 @@ protected void setSetting(AppiumSetting setting, Object value) {
 setSettings(getCommandImmutableMap(setting.toString(), value));
 }
 
- /**
-  * Lock the device (bring it to the lock screen) for a given number of
-  * seconds
- *
-  * @param seconds
-  * number of seconds to lock the screen for
-  */
- public void lockScreen(int seconds) {
- execute(LOCK, ImmutableMap.of("seconds", seconds));
- }
+/**
+ * Lock the device (bring it to the lock screen) for a given number of
+ * seconds
+ * 
+ * @param seconds
+ * number of seconds to lock the screen for
+ */
+public void lockScreen(int seconds) {
+execute(LOCK, ImmutableMap.of("seconds", seconds));
+}
 
- @Override
+@Override
 public WebDriver context(String name) {
 if (!_isNotNullOrEmpty(name)) {
 throw new IllegalArgumentException("Must supply a context name");
@@ -545,26 +546,6 @@ public ScreenOrientation getOrientation() {
 }
 }
 
-@Override
-public WebElement findElementByIosUIAutomation(String using) {
-return findElement("-ios uiautomation", using);
-}
-
-@Override
-public List<WebElement> findElementsByIosUIAutomation(String using) {
-return findElements("-ios uiautomation", using);
-}
-
-@Override
-public WebElement findElementByAndroidUIAutomator(String using) {
-return findElement("-android uiautomator", using);
-}
-
-@Override
-public List<WebElement> findElementsByAndroidUIAutomator(String using) {
-return findElements("-android uiautomator", using);
-}
-
 @Override
 public WebElement findElementByAccessibilityId(String using) {
 return findElement("accessibility id", using);
@@ -612,19 +593,19 @@ public URL getRemoteAddress() {
 return remoteAddress;
 }
 
- /**
-  * Checks if a string is null, empty, or whitespace.
- *
-  * @param str
-  * String to check.
- *
-  * @return True if str is not null or empty.
-  */
- protected static boolean _isNotNullOrEmpty(String str) {
- return str != null && !str.isEmpty() && str.trim().length() > 0;
- }
-
- protected static boolean _isNotNullOrEmpty(Object ob) {
- return ob != null;
- }
+/**
+ * Checks if a string is null, empty, or whitespace.
+ * 
+ * @param str
+ * String to check.
+ * 
+ * @return True if str is not null or empty.
+ */
+protected static boolean _isNotNullOrEmpty(String str) {
+return str != null && !str.isEmpty() && str.trim().length() > 0;
+}
+
+protected static boolean _isNotNullOrEmpty(Object ob) {
+return ob != null;
+}
 }

src/main/java/io/appium/java_client/DeviceActionShortcuts.java

@@ -1,5 +1,6 @@
 package io.appium.java_client;
 
+
 public interface DeviceActionShortcuts {
 
 /**
@@ -14,7 +15,7 @@ public interface DeviceActionShortcuts {
  * 
  * @param key code for the key pressed on the device
  * 
- * @see AndroidKeyCode
+ * @see io.appium.java_client.android.AndroidKeyCode
  * @see io.appium.java_client.ios.IOSKeyCode
  */
 public void sendKeyEvent(int key);

src/main/java/io/appium/java_client/android/AndroidDeviceActionShortcuts.java

@@ -1,6 +1,5 @@
 package io.appium.java_client.android;
 
-import io.appium.java_client.AndroidKeyCode;
 import io.appium.java_client.DeviceActionShortcuts;
 
 public interface AndroidDeviceActionShortcuts extends DeviceActionShortcuts {

src/main/java/io/appium/java_client/android/AndroidDriver.java

@@ -1,23 +1,27 @@
 package io.appium.java_client.android;
 
 import com.google.common.collect.ImmutableMap;
-import io.appium.java_client.AndroidKeyCode;
+
 import io.appium.java_client.AppiumDriver;
 import io.appium.java_client.AppiumSetting;
+import io.appium.java_client.FindsByAndroidUIAutomator;
 import io.appium.java_client.NetworkConnectionSetting;
 import io.appium.java_client.remote.MobilePlatform;
+
 import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.WebElement;
 import org.openqa.selenium.remote.Response;
 
 import java.net.URL;
+import java.util.List;
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static io.appium.java_client.MobileCommand.*;
 import static io.appium.java_client.remote.MobileCapabilityType.*;
 
 public class AndroidDriver extends AppiumDriver implements
 AndroidDeviceActionShortcuts, HasAppStrings, HasNetworkConnection, PushesFiles, 
-StartsActivity {
+StartsActivity, FindsByAndroidUIAutomator {
 
 private static final String ANDROID_PLATFORM = MobilePlatform.ANDROID;
 
@@ -223,5 +227,15 @@ public boolean isLocked() {
 public void ignoreUnimportantViews(Boolean compress) {
 setSetting(AppiumSetting.IGNORE_UNIMPORTANT_VIEWS, compress);
 }
+
+@Override
+public WebElement findElementByAndroidUIAutomator(String using) {
+return findElement("-android uiautomator", using);
+}
+
+@Override
+public List<WebElement> findElementsByAndroidUIAutomator(String using) {
+return findElements("-android uiautomator", using);
+}
 
 }