com.atlassian.pageobjects.elements.search

Interface SearchQuery<E,Q extends SearchQuery<E,Q>>

All Superinterfaces:

com.google.common.base.Supplier<Iterable<E>>

All Known Subinterfaces:

AnyQuery<E>, DefaultQuery, PageElementQuery<E>

All Known Implementing Classes:

AbstractSearchQuery, DefaultAnyQuery, DefaultWebDriverQuery, WebDriverElementQuery

@PublicApi
public interface SearchQuery<E,Q extends SearchQuery<E,Q>>
extends com.google.common.base.Supplier<Iterable<E>>

Represents a generic query for any type of object. The query provides API to:

• map and filter the results (filter(Predicate), map(Function), flatMap(Function), bindTo(Class, Object...))
• obtain query results (e.g. Supplier.get(), now(), first(), hasResult(), timed())

Since:

2.3

See Also:

PageElementSearch, AnyQuery, PageElementQuery, PageElements

Method Summary

Modifier and Type	Method and Description
<F> AnyQuery<F>	bindTo(Class<F> pageObjectClass, Object... extraArgs) Map the results by binding into a page object.
Q	filter(com.google.common.base.Predicate<? super E> predicate) Filter the underlying results using predicate.
E	first()
<F> AnyQuery<F>	flatMap(com.google.common.base.Function<? super E,Iterable<F>> mapper) Flat map the results using mapper.
TimedCondition	hasResult()
<F> AnyQuery<F>	map(com.google.common.base.Function<? super E,F> mapper) Map the query results using mapper.
Iterable<E>	now() Equivalent to Supplier.get().
TimedQuery<Iterable<E>>	timed()

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

get

Method Detail

filter

@Nonnull
Q filter(@Nonnull
                  com.google.common.base.Predicate<? super E> predicate)

Filter the underlying results using predicate.

Parameters:

predicate - predicate to filter the results

Returns:

new query with the applied filter

map

@Nonnull
<F> AnyQuery<F> map(@Nonnull
                             com.google.common.base.Function<? super E,F> mapper)

Map the query results using mapper.

Type Parameters:

F - the new result type

Parameters:

mapper - a function to map the results

Returns:

new query with mapped results

flatMap

@Nonnull
<F> AnyQuery<F> flatMap(@Nonnull
                                 com.google.common.base.Function<? super E,Iterable<F>> mapper)

Flat map the results using mapper.

Type Parameters:

F - the new result type

Parameters:

mapper - the function to use to flat map

Returns:

new query with mapped results.

bindTo

@Nonnull
<F> AnyQuery<F> bindTo(@Nonnull
                                Class<F> pageObjectClass,
                                @Nonnull
                                Object... extraArgs)

Map the results by binding into a page object. The resulting page objects needs to provide a compatible constructor.

Type Parameters:

F - the new result type

Parameters:

pageObjectClass - page object class

extraArgs - extra arguments to the bind method

Returns:

new query with mapped results

See Also:

PageObjects.bind(PageBinder, Iterable, Class, Object...)

first

@Nullable
E first()

Returns:

first result , or null if there is no results

now

@Nonnull
Iterable<E> now()

Equivalent to Supplier.get().

Returns:

all results, as they are now

hasResult

@Nonnull
TimedCondition hasResult()

Returns:

timed condition to check whether this query has any result

timed

@Nonnull
TimedQuery<Iterable<E>> timed()

Returns:

timed query for all results