implement driver options

Author: titusfortner

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

@@ -0,0 +1,33 @@
+/*
+ * 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.android;
+
+import io.appium.java_client.remote.MobileOptions;
+import io.appium.java_client.remote.MobilePlatform;
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.remote.CapabilityType;
+
+public class AndroidMobileOptions extends MobileOptions<AndroidMobileOptions> {
+    public AndroidMobileOptions() {
+        setCapability(CapabilityType.PLATFORM_NAME, MobilePlatform.ANDROID);
+    }
+
+    public AndroidMobileOptions(Capabilities source) {
+        this();
+        merge(source);
+    }
+}

src/main/java/io/appium/java_client/ios/IOSMobileOptions.java

@@ -0,0 +1,33 @@
+/*
+ * 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.ios;
+
+import io.appium.java_client.remote.MobileOptions;
+import io.appium.java_client.remote.MobilePlatform;
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.remote.CapabilityType;
+
+public class IOSMobileOptions extends MobileOptions<IOSMobileOptions> {
+    public IOSMobileOptions() {
+        setCapability(CapabilityType.PLATFORM_NAME, MobilePlatform.IOS);
+    }
+
+    public IOSMobileOptions(Capabilities source) {
+        this();
+        merge(source);
+    }
+}

src/main/java/io/appium/java_client/remote/MobileCapabilityType.java

@@ -124,7 +124,7 @@ public interface MobileCapabilityType extends CapabilityType {
     String EVENT_TIMINGS = "eventTimings";
 
     /**
-     * This is the flag which forces server to switch to the mobile WSONWP.
+     * This is the flag which forces server to switch to the mobile JSONWP.
      * If {@code false} then it is switched to W3C mode.
      */
     String FORCE_MJSONWP = "forceMjsonwp";

src/main/java/io/appium/java_client/remote/MobileOptions.java

@@ -0,0 +1,211 @@
+/*
+ * 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.remote;
+
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.MutableCapabilities;
+import org.openqa.selenium.ScreenOrientation;
+import org.openqa.selenium.remote.CapabilityType;
+
+import java.net.URL;
+
+public abstract class MobileOptions<T extends MobileOptions<T>> extends MutableCapabilities {
+
+    public String getPlatformName() {
+        return (String) getCapability(CapabilityType.PLATFORM_NAME);
+    }
+
+    public T setApp(String url) {
+        return amend(MobileCapabilityType.APP, url);
+    }
+
+    public T setApp(URL url) {
+        return setApp(url.toString());
+    }
+
+    public String getApp() {
+        return (String) getCapability(MobileCapabilityType.APP);
+    }
+
+    public T setAutomationName(String name) {
+        return amend(MobileCapabilityType.AUTOMATION_NAME, name);
+    }
+
+    public String getAutomationName() {
+        return (String) getCapability(MobileCapabilityType.AUTOMATION_NAME);
+    }
+
+    public T setAutoWebview() {
+        return setAutoWebview(true);
+    }
+
+    public T setAutoWebview(boolean bool) {
+        return amend(MobileCapabilityType.AUTO_WEBVIEW, bool);
+    }
+
+    public boolean isAutoWebview() {
+        return (boolean) getCapability(MobileCapabilityType.AUTO_WEBVIEW);
+    }
+
+    public T setClearSystemFiles() {
+        return setClearSystemFiles(true);
+    }
+
+    public T setClearSystemFiles(boolean bool) {
+        return amend(MobileCapabilityType.CLEAR_SYSTEM_FILES, bool);
+    }
+
+    public boolean isClearSystemFiles() {
+        return (boolean) getCapability(MobileCapabilityType.CLEAR_SYSTEM_FILES);
+    }
+
+    public T setDeviceName(String deviceName) {
+        return amend(MobileCapabilityType.DEVICE_NAME, deviceName);
+    }
+
+    public String getDeviceName() {
+        return (String) getCapability(MobileCapabilityType.DEVICE_NAME);
+    }
+
+    public T setEnablePerformanceLogging(boolean bool) {
+        return amend(MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING, bool);
+    }
+
+    public T setEnablePerformanceLogging() {
+        return setEnablePerformanceLogging(true);
+    }
+
+    public boolean isEnablePerformanceLogging() {
+        return (boolean) getCapability(MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING);
+    }
+
+    public T setEventTimings(boolean bool) {
+        return amend(MobileCapabilityType.EVENT_TIMINGS, bool);
+    }
+
+    public T setEventTimings() {
+        return setEventTimings(true);
+    }
+
+    public boolean isEventTimings() {
+        return (boolean) getCapability(MobileCapabilityType.EVENT_TIMINGS);
+    }
+
+    public T setFullReset(boolean bool) {
+        return amend(MobileCapabilityType.FULL_RESET, bool);
+    }
+
+    public T setFullReset() {
+        return setFullReset(true);
+    }
+
+    public boolean isFullReset() {
+        return (boolean) getCapability(MobileCapabilityType.FULL_RESET);
+    }
+
+    public T setLanguage(String language) {
+        return amend(MobileCapabilityType.LANGUAGE, language);
+    }
+
+    public String getLanguage() {
+        return (String) getCapability(MobileCapabilityType.LANGUAGE);
+    }
+
+    public T setLocale(String locale) {
+        return amend(MobileCapabilityType.LOCALE, locale);
+    }
+
+    public String getLocale() {
+        return (String) getCapability(MobileCapabilityType.LOCALE);
+    }
+
+    public T setNewCommandTimeout(int seconds) {
+        return amend(MobileCapabilityType.NEW_COMMAND_TIMEOUT, seconds);
+    }
+
+    public int getNewCommandTimeout() {
+        return (int) getCapability(MobileCapabilityType.NEW_COMMAND_TIMEOUT);
+    }
+
+    public T setNoReset(boolean bool) {
+        return amend(MobileCapabilityType.NO_RESET, bool);
+    }
+
+    public T setNoReset() {
+        return setNoReset(true);
+    }
+
+    public boolean isNoReset() {
+        return (boolean) getCapability(MobileCapabilityType.NO_RESET);
+    }
+
+    public T setOrientation(ScreenOrientation orientation) {
+        return amend(MobileCapabilityType.ORIENTATION, orientation);
+    }
+
+    public ScreenOrientation getOrientation() {
+        return (ScreenOrientation) getCapability(MobileCapabilityType.ORIENTATION);
+    }
+
+    // TODO: add new method for List
+    public T setOtherApps(String app) {
+        return amend(MobileCapabilityType.OTHER_APPS, app);
+    }
+
+    public String getOtherApps() {
+        return (String) getCapability(MobileCapabilityType.OTHER_APPS);
+    }
+
+    public T setPlatformVersion(String version) {
+        return amend(MobileCapabilityType.PLATFORM_VERSION, version);
+    }
+
+    public String getPlatformVersion() {
+        return (String) getCapability(MobileCapabilityType.PLATFORM_VERSION);
+    }
+
+    public T setPrintPageSourceOnFindFailure() {
+        return setPrintPageSourceOnFindFailure(true);
+    }
+
+    public T setPrintPageSourceOnFindFailure(boolean bool) {
+        return amend(MobileCapabilityType.PRINT_PAGE_SOURCE_ON_FIND_FAILURE, bool);
+    }
+
+    public boolean isPrintPageSourceOnFindFailure() {
+        return (boolean) getCapability(MobileCapabilityType.PRINT_PAGE_SOURCE_ON_FIND_FAILURE);
+    }
+
+    public T setUdid(String id) {
+        return amend(MobileCapabilityType.UDID, id);
+    }
+
+    public String getUdid() {
+        return (String) getCapability(MobileCapabilityType.UDID);
+    }
+
+    @Override
+    public T merge(Capabilities extraCapabilities) {
+        super.merge(extraCapabilities);
+        return (T) this;
+    }
+
+    protected T amend(String optionName, Object value) {
+        setCapability(optionName, value);
+        return (T) this;
+    }
+}