com.atlassian.pageobjects.internal.elements.search

Class WebDriverElementQuery<E extends PageElement>

java.lang.Object

com.atlassian.pageobjects.internal.elements.search.AbstractSearchQuery<E,PageElementQuery<E>>

com.atlassian.pageobjects.internal.elements.search.WebDriverElementQuery<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultWebDriverQuery

public class WebDriverElementQuery<E extends PageElement>
extends AbstractSearchQuery<E,PageElementQuery<E>>
implements PageElementQuery<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<E>	pageElementClass
protected TimeoutType	timeoutType
protected org.openqa.selenium.WebDriver	webDriver

Fields inherited from class com.atlassian.pageobjects.internal.elements.search.AbstractSearchQuery

pageBinder, querySupplier, timeouts

Constructor Summary

Constructors

Constructor and Description
WebDriverElementQuery(com.google.common.base.Supplier<Iterable<E>> querySupplier, Class<E> pageElementClass, TimeoutType timeoutType)

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.
protected <F> AnyQuery<F>	newAnyQueryInstance(com.google.common.base.Supplier<Iterable<F>> supplier)
protected PageElementQuery<E>	newInstance(com.google.common.base.Supplier<Iterable<E>> supplier)
PageElementQuery<E>	withTimeout(TimeoutType timeoutType) Apply a custom timeoutType to all resulting elements.

Methods inherited from class com.atlassian.pageobjects.internal.elements.search.AbstractSearchQuery

bindTo, filter, first, flatMap, flatMapSupplier, get, hasResult, map, mapSupplier, now, timed

Methods inherited from class java.lang.Object

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

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

Field Detail

webDriver

@Inject
protected org.openqa.selenium.WebDriver webDriver

pageElementClass

protected final Class<E extends PageElement> pageElementClass

timeoutType

protected final TimeoutType timeoutType

Constructor Detail

WebDriverElementQuery

public WebDriverElementQuery(@Nonnull
                             com.google.common.base.Supplier<Iterable<E>> querySupplier,
                             @Nonnull
                             Class<E> pageElementClass,
                             @Nonnull
                             TimeoutType timeoutType)

Method Detail

by

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

Description copied from interface: PageElementQuery

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.

Specified by:

by in interface PageElementQuery<E extends PageElement>

Parameters:

by - locator to search by

Returns:

new query with results matching by

by

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

Description copied from interface: PageElementQuery

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

Specified by:

by in interface PageElementQuery<E extends PageElement>

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
public PageElementQuery<E> withTimeout(@Nonnull
                                                TimeoutType timeoutType)

Description copied from interface: PageElementQuery

Apply a custom timeoutType to all resulting elements.

Specified by:

withTimeout in interface PageElementQuery<E extends PageElement>

Parameters:

timeoutType - new timeout type

Returns:

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

as

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

Description copied from interface: PageElementQuery

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

Specified by:

as in interface PageElementQuery<E extends PageElement>

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

newAnyQueryInstance

@Nonnull
protected <F> AnyQuery<F> newAnyQueryInstance(@Nonnull
                                                       com.google.common.base.Supplier<Iterable<F>> supplier)

Specified by:

newAnyQueryInstance in class AbstractSearchQuery<E extends PageElement,PageElementQuery<E extends PageElement>>

newInstance

@Nonnull
protected PageElementQuery<E> newInstance(@Nonnull
                                                   com.google.common.base.Supplier<Iterable<E>> supplier)

Specified by:

newInstance in class AbstractSearchQuery<E extends PageElement,PageElementQuery<E extends PageElement>>