io.appium.java_client.pagefactory

Class AppiumFieldDecorator

java.lang.Object

io.appium.java_client.pagefactory.AppiumFieldDecorator

All Implemented Interfaces:

org.openqa.selenium.support.pagefactory.FieldDecorator

public class AppiumFieldDecorator
extends java.lang.Object
implements org.openqa.selenium.support.pagefactory.FieldDecorator

Default decorator for use with PageFactory. Will decorate 1) all of the WebElement fields and 2) List of WebElement that have @AndroidFindBy, @AndroidFindBys, or @iOSFindBy/@iOSFindBys annotation with a proxy that locates the elements using the passed in ElementLocatorFactory. Please pay attention: fields of WebElement, RemoteWebElement, MobileElement, AndroidElement and IOSElement are allowed to use with this decorator

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIMEOUT Deprecated.
static java.util.concurrent.TimeUnit	DEFAULT_TIMEUNIT Deprecated.
static java.time.Duration	DEFAULT_WAITING_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AppiumFieldDecorator(SearchContext context)
AppiumFieldDecorator(SearchContext context, java.time.Duration duration) Creates field decorator based on SearchContext and timeout duration.
AppiumFieldDecorator(SearchContext context, long timeout, java.util.concurrent.TimeUnit timeUnit) Deprecated.
AppiumFieldDecorator(SearchContext context, TimeOutDuration duration) Deprecated. This constructor is going to be removed. Use AppiumFieldDecorator(SearchContext, Duration) instead.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	decorate(java.lang.ClassLoader ignored, java.lang.reflect.Field field) Decorated page object field.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WAITING_TIMEOUT

public static final java.time.Duration DEFAULT_WAITING_TIMEOUT

DEFAULT_TIMEOUT

@Deprecated
public static final long DEFAULT_TIMEOUT

Deprecated.

See Also:

Constant Field Values

DEFAULT_TIMEUNIT

@Deprecated
public static final java.util.concurrent.TimeUnit DEFAULT_TIMEUNIT

Deprecated.

Constructor Detail

AppiumFieldDecorator

@Deprecated
public AppiumFieldDecorator(SearchContext context,
                                         long timeout,
                                         java.util.concurrent.TimeUnit timeUnit)

Deprecated.

AppiumFieldDecorator

@Deprecated
public AppiumFieldDecorator(SearchContext context,
                                         TimeOutDuration duration)

Deprecated. This constructor is going to be removed. Use AppiumFieldDecorator(SearchContext, Duration) instead.

Creates field decorator based on SearchContext and timeout duration.

Parameters:

context - is an instance of SearchContext It may be the instance of WebDriver or WebElement or Widget or some other user's extension/implementation.

duration - is a desired duration of the waiting for an element presence.

AppiumFieldDecorator

public AppiumFieldDecorator(SearchContext context,
                            java.time.Duration duration)

Creates field decorator based on SearchContext and timeout duration.

Parameters:

context - is an instance of SearchContext It may be the instance of WebDriver or WebElement or Widget or some other user's extension/implementation.

duration - is a desired duration of the waiting for an element presence.

AppiumFieldDecorator

public AppiumFieldDecorator(SearchContext context)

Method Detail

decorate

public java.lang.Object decorate(java.lang.ClassLoader ignored,
                                 java.lang.reflect.Field field)

Decorated page object field.

Specified by:

decorate in interface org.openqa.selenium.support.pagefactory.FieldDecorator

Parameters:

ignored - class loader is ignored by current implementation

field - is Field of page object which is supposed to be decorated.

Returns:

a field value or null.