com.atlassian.pageobjects.elements.timeout

Enum TimeoutType

java.lang.Object

java.lang.Enum<TimeoutType>

com.atlassian.pageobjects.elements.timeout.TimeoutType

All Implemented Interfaces:

Serializable, Comparable<TimeoutType>

public enum TimeoutType
extends Enum<TimeoutType>

Enumeration of default timeout types in the elements.

NOTE: This enumeration should NOT be extended with further timeout types, unless it is a matter of common (as in: involving more than one developer) consensus that a new timeout type is necessary. Instead, use customized timeouts, if a particular test context requires timeout adjustments (to that end you may use TimedQuery.by(long) and TimedQuery.by(long, java.util.concurrent.TimeUnit)).

Enum Constant Summary

Enum Constants

Enum Constant and Description
AJAX_ACTION An AJAX-like action on the tested page, e.g.
COMPONENT_LOAD Load time of an UI-heavy components (e.g.
DEFAULT Default timeout value.
DIALOG_LOAD Dialog load time.
EVALUATION_INTERVAL Interval between consecutive attempts to evaluate state of a particular test components, used e.g.
PAGE_LOAD Page load of an average product page.
SLOW_PAGE_LOAD Page load of a slow page, e.g.
UI_ACTION Use for any actions executed by the test within the page UI, e.g.

Method Summary

Modifier and Type	Method and Description
static TimeoutType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeoutType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final TimeoutType DEFAULT

Default timeout value. Meant to be used in case there is no explicit timeout provided for a components requiring it.

EVALUATION_INTERVAL

public static final TimeoutType EVALUATION_INTERVAL

Interval between consecutive attempts to evaluate state of a particular test components, used e.g. by timed conditions and queries. This is not really a timeout, but still has significant influence over how the timed operations are executed.

See Also:

TimedQuery, PollingQuery

UI_ACTION

public static final TimeoutType UI_ACTION

Use for any actions executed by the test within the page UI, e.g. typing, clicking, moving mouse etc.

PAGE_LOAD

public static final TimeoutType PAGE_LOAD

Page load of an average product page.

SLOW_PAGE_LOAD

public static final TimeoutType SLOW_PAGE_LOAD

Page load of a slow page, e.g. Dashboard, pages for re-indexing products etc..

DIALOG_LOAD

public static final TimeoutType DIALOG_LOAD

Dialog load time.

COMPONENT_LOAD

public static final TimeoutType COMPONENT_LOAD

Load time of an UI-heavy components (e.g. drop-down, picker etc.)

AJAX_ACTION

public static final TimeoutType AJAX_ACTION

An AJAX-like action on the tested page, e.g. an asynchronous request, a dialog submit (without redirection) etc.

Method Detail

values

public static TimeoutType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimeoutType c : TimeoutType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimeoutType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null