Package io.appium.java_client.touch.offset

Class AbstractOptionCombinedWithPosition<T extends AbstractOptionCombinedWithPosition<T>>

java.lang.Object

io.appium.java_client.touch.ActionOptions<AbstractOptionCombinedWithPosition<T>>

io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition<T>

Direct Known Subclasses:

IOSPressOptions, LongPressOptions, TapOptions

public abstract class AbstractOptionCombinedWithPosition<T extends AbstractOptionCombinedWithPosition<T>>
extends ActionOptions<AbstractOptionCombinedWithPosition<T>>

Constructor Summary

Constructors

Constructor	Description
AbstractOptionCombinedWithPosition()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	build()	Creates a map based on the provided options.
protected void	verify()	This method is automatically called before building options map to verify the consistency of the instance.
T	withElement(ElementOption element)	Most of touch action may use position which is relative to some element.
T	withPosition(PointOption positionOption)	Some actions may require coordinates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractOptionCombinedWithPosition

public AbstractOptionCombinedWithPosition()

Method Detail

withPosition

public T withPosition(PointOption positionOption)

Some actions may require coordinates. Invocation of this method replaces the result of previous withElement(ElementOption) invocation.

Parameters:

positionOption - required coordinates. *

Returns:

self-reference

withElement

public T withElement(ElementOption element)

Most of touch action may use position which is relative to some element. In order to unify this behaviour this method was added. Invocation of this method replaces the result of previous withPosition(PointOption) invocation.

Parameters:

element - required position which is relative to some element

Returns:

self-reference

verify

protected void verify()

Description copied from class: ActionOptions

This method is automatically called before building options map to verify the consistency of the instance.

Specified by:

verify in class ActionOptions<AbstractOptionCombinedWithPosition<T extends AbstractOptionCombinedWithPosition<T>>>

build

public java.util.Map<java.lang.String,java.lang.Object> build()

Description copied from class: ActionOptions

Creates a map based on the provided options.

Overrides:

build in class ActionOptions<AbstractOptionCombinedWithPosition<T extends AbstractOptionCombinedWithPosition<T>>>

Returns:

options mapping.