io.appium.java_client.touch.TapOptions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client for Appium Mobile Webdriver

There is a newer version: 9.3.0

/*
 * 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 java.util.Optional.ofNullable;

import io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition;

import java.util.Map;

public class TapOptions extends AbstractOptionCombinedWithPosition {
    private Integer tapsCount = null;

    /**
     * It creates an empty instance of {@link TapOptions}.
     *
     * @return the empty instance of {@link TapOptions}
     */
    public static TapOptions tapOptions() {
        return new TapOptions();
    }

    /**
     * Set the count of taps to perform.
     *
     * @param tapsCount the taps count to perform.
     *                  The value should be greater than zero.
     * @return this instance for chaining.
     */
    public TapOptions withTapsCount(int tapsCount) {
        checkArgument(tapsCount > 0, "Taps count should be greater than zero");
        this.tapsCount = tapsCount;
        return this;
    }

    @Override
    public Map build() {
        final Map result = super.build();
        ofNullable(tapsCount).ifPresent(integer -> result.put("count", integer));
        return result;
    }
}