com.atlassian.pageobjects.elements.search

Interface PageElementQuery<E extends PageElement>

All Superinterfaces:

SearchQuery<E,PageElementQuery<E>>, com.google.common.base.Supplier<Iterable<E>>

All Known Subinterfaces:

DefaultQuery

All Known Implementing Classes:

DefaultWebDriverQuery, WebDriverElementQuery

@PublicApi
public interface PageElementQuery<E extends PageElement>
extends SearchQuery<E,PageElementQuery<E>>

SearchQuery, whose element type is an instance of PageElement. Allows for nesting the search (by(By)) and mapping the underlying page elements into elements of specialized type (as(Class), or with a customized timeout (withTimeout(TimeoutType).

Since:

2.3

Method Summary

Modifier and Type	Method and Description
<PE extends E> PageElementQuery<PE>	as(Class<PE> pageElementClass) Map current results to a more specialized pageElementClass (e.g.
PageElementQuery<E>	by(org.openqa.selenium.By by) Search withing all results for child elements matching by.
PageElementQuery<E>	by(org.openqa.selenium.By by, com.google.common.base.Predicate<? super PageElement> filter) Search child elements using by and applying the filter at the same time.
PageElementQuery<E>	withTimeout(TimeoutType timeoutType) Apply a custom timeoutType to all resulting elements.

Methods inherited from interface com.atlassian.pageobjects.elements.search.SearchQuery

bindTo, filter, first, flatMap, hasResult, map, now, timed

Methods inherited from interface com.google.common.base.Supplier

get

Method Detail

by

@Nonnull
PageElementQuery<E> by(@Nonnull
                                org.openqa.selenium.By by)

Search withing all results for child elements matching by. This is technically a flat map that will expand each current result element into a set of child elements matching by.

Parameters:

by - locator to search by

Returns:

new query with results matching by

by

@Nonnull
PageElementQuery<E> by(@Nonnull
                                org.openqa.selenium.By by,
                                @Nonnull
                                com.google.common.base.Predicate<? super PageElement> filter)

Search child elements using by and applying the filter at the same time. This is equivalent to calling by(By) and SearchQuery.filter(Predicate) in succession.

Parameters:

by - locator to search by

filter - filter for the results of the search

Returns:

new query with results matching by and filtered using filter

withTimeout

@Nonnull
PageElementQuery<E> withTimeout(@Nonnull
                                         TimeoutType timeoutType)

Apply a custom timeoutType to all resulting elements.

Parameters:

timeoutType - new timeout type

Returns:

a query equivalent to this query, but with a custom timeout

as

@Nonnull
<PE extends E> PageElementQuery<PE> as(@Nonnull
                                                Class<PE> pageElementClass)

Map current results to a more specialized pageElementClass (e.g. CheckboxElement).

Type Parameters:

PE - the new element type parameter

Parameters:

pageElementClass - the page element class to apply

Returns:

new query equivalent to this query, but with different element type, corresponding to pageElementClass