Refactor setting of touch actions options

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

@@ -0,0 +1,29 @@
+/*
+ * 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.PerformsTouchActions;
+import io.appium.java_client.TouchAction;
+
+
+public class AndroidTouchAction extends TouchAction<AndroidTouchAction> {
+
+    public AndroidTouchAction(PerformsTouchActions performsTouchActions) {
+        super(performsTouchActions);
+    }
+
+}

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

@@ -1,12 +1,28 @@
+/*
+ * 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.PerformsTouchActions;
 import io.appium.java_client.TouchAction;
+import io.appium.java_client.ios.touch.DoubleTapOptions;
 import org.openqa.selenium.WebElement;
-import org.openqa.selenium.internal.HasIdentity;
 
 
-public class IOSTouchAction extends TouchAction {
+public class IOSTouchAction extends TouchAction<IOSTouchAction> {
 
     public IOSTouchAction(PerformsTouchActions performsTouchActions) {
         super(performsTouchActions);
@@ -18,12 +34,15 @@ public IOSTouchAction(PerformsTouchActions performsTouchActions) {
      * @param el element to tap.
      * @param x  x offset.
      * @param y  y offset.
-     * @return this TouchAction, for chaining.
+     * @return this IOSTouchAction, for chaining.
+     * @deprecated use {@link #tap(ActionOptions)} with count=2 instead.
      */
+    @Deprecated
     public IOSTouchAction doubleTap(WebElement el, int x, int y) {
-        ActionParameter action = new ActionParameter("doubleTap", (HasIdentity) el);
-        action.addParameter("x", x);
-        action.addParameter("y", y);
+        ActionParameter action = new ActionParameter("doubleTap",
+                new DoubleTapOptions()
+                        .withElement(el)
+                        .withRelativeOffset(x, y));
         parameterBuilder.add(action);
         return this;
     }
@@ -32,10 +51,14 @@ public IOSTouchAction doubleTap(WebElement el, int x, int y) {
      * Double taps an element, offset from upper left corner.
      *
      * @param el element to tap.
-     * @return this TouchAction, for chaining.
+     * @return this IOSTouchAction, for chaining.
+     * @deprecated use {@link #tap(ActionOptions)} with count=2 instead.
      */
+    @Deprecated
     public IOSTouchAction doubleTap(WebElement el) {
-        ActionParameter action = new ActionParameter("doubleTap", (HasIdentity) el);
+        ActionParameter action = new ActionParameter("doubleTap",
+                new DoubleTapOptions()
+                        .withElement(el));
         parameterBuilder.add(action);
         return this;
     }

src/main/java/io/appium/java_client/ios/touch/DoubleTapOptions.java

@@ -0,0 +1,26 @@
+/*
+ * 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.touch;
+
+import io.appium.java_client.touch.OptionsWithAbsolutePositioning;
+
+/**
+ * @deprecated this class will be removed
+ */
+@Deprecated
+public class DoubleTapOptions extends OptionsWithAbsolutePositioning<DoubleTapOptions> {
+}

src/main/java/io/appium/java_client/touch/ActionOptions.java

@@ -0,0 +1,40 @@
+/*
+ * 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.touch;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public abstract class ActionOptions<T extends ActionOptions<T>> {
+    /**
+     * This method is automatically called before building
+     * options map to verify the consistency of the instance.
+     *
+     * @throws IllegalArgumentException if there are problems with this options map.
+     */
+    protected abstract void verify();
+
+    /**
+     * Creates a map based on the provided options.
+     *
+     * @return options mapping.
+     */
+    public Map<String, Object> build() {
+        verify();
+        return new HashMap<>();
+    }
+}

src/main/java/io/appium/java_client/touch/LongPressOptions.java

@@ -0,0 +1,51 @@
+/*
+ * 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.touch;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.time.Duration;
+import java.util.Map;
+
+public class LongPressOptions extends OptionsWithAbsolutePositioning<LongPressOptions> {
+    protected Duration duration = null;
+
+    /**
+     * Set the long press duration.
+     *
+     * @param duration the duration value to set.
+     *                 Time resolution unit is 1 ms.
+     * @return this instance for chaining.
+     */
+    public LongPressOptions withDuration(Duration duration) {
+        checkNotNull(duration);
+        checkArgument(duration.toMillis() >= 0,
+                "Duration value should be greater or equal to zero");
+        this.duration = duration;
+        return this;
+    }
+
+    @Override
+    public Map<String, Object> build() {
+        final Map<String, Object> result = super.build();
+        if (duration != null) {
+            result.put("duration", this.duration.toMillis());
+        }
+        return result;
+    }
+}

src/main/java/io/appium/java_client/touch/MoveToOptions.java

@@ -0,0 +1,20 @@
+/*
+ * 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.touch;
+
+public class MoveToOptions extends OptionsWithRelativePositioning<MoveToOptions> {
+}

src/main/java/io/appium/java_client/touch/OptionsWithAbsolutePositioning.java

@@ -0,0 +1,107 @@
+/*
+ * 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.touch;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import org.openqa.selenium.Point;
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.internal.HasIdentity;
+
+import java.util.Map;
+
+public abstract class OptionsWithAbsolutePositioning<T extends OptionsWithAbsolutePositioning<T>>
+        extends ActionOptions<T> {
+    private String elementId = null;
+    private Point absoluteOffset = null;
+    private Point relativeOffset = null;
+
+    /**
+     * Set the destination element for the corresponding action.
+     *
+     * @param element the destination element.
+     * @return this instance for chaining.
+     */
+    public T withElement(WebElement element) {
+        checkNotNull(element);
+        this.elementId = ((HasIdentity) element).getId();
+        //noinspection unchecked
+        return (T) this;
+    }
+
+    /**
+     * Set the absolute offset for the corresponding action.
+     *
+     * @param xOffset the absolute distance from the left screen corner (the element must not be set).
+     * @param yOffset the absolute distance from the top screen corner.
+     * @return this instance for chaining.
+     */
+    public T withAbsoluteOffset(int xOffset, int yOffset) {
+        this.absoluteOffset = new Point(xOffset, yOffset);
+        //noinspection unchecked
+        return (T) this;
+    }
+
+    /**
+     * Set the relative offset for the corresponding action.
+     *
+     * @param xOffset the relative distance from the left element corner (the element must be set).
+     * @param yOffset the relative distance from the top element corner (the element must be set).
+     * @return this instance for chaining.
+     */
+    public T withRelativeOffset(int xOffset, int yOffset) {
+        this.relativeOffset = new Point(xOffset, yOffset);
+        //noinspection unchecked
+        return (T) this;
+    }
+
+    @Override
+    protected void verify() {
+        if (elementId == null) {
+            if (absoluteOffset == null) {
+                throw new IllegalArgumentException(
+                        "Absolute offset must be defined if 'element' option is not set");
+            }
+            if (relativeOffset != null) {
+                throw new IllegalArgumentException(
+                        "Relative offset must not be defined if 'element' option is not set");
+            }
+        } else {
+            if (absoluteOffset != null) {
+                throw new IllegalArgumentException(
+                        "Absolute offset must not be defined if 'element' option set");
+            }
+        }
+    }
+
+    @Override
+    public Map<String, Object> build() {
+        final Map<String, Object> result = super.build();
+        if (absoluteOffset != null) {
+            result.put("x", absoluteOffset.x);
+            result.put("y", absoluteOffset.y);
+        }
+        if (relativeOffset != null) {
+            result.put("x", relativeOffset.x);
+            result.put("y", relativeOffset.y);
+        }
+        if (elementId != null) {
+            result.put("element", elementId);
+        }
+        return result;
+    }
+}