com.atlassian.pageobjects.internal.elements.search

Class AbstractSearchQuery<E,Q extends SearchQuery<E,Q>>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultAnyQuery, WebDriverElementQuery

public abstract class AbstractSearchQuery<E,Q extends SearchQuery<E,Q>>
extends Object
implements SearchQuery<E,Q>

Field Summary

Fields

Modifier and Type	Field and Description
protected PageBinder	pageBinder
protected com.google.common.base.Supplier<Iterable<E>>	querySupplier
protected Timeouts	timeouts

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSearchQuery(com.google.common.base.Supplier<Iterable<E>> querySupplier)

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.
protected <F> com.google.common.base.Supplier<Iterable<F>>	flatMapSupplier(com.google.common.base.Function<? super E,Iterable<F>> mapper)
Iterable<E>	get()
TimedCondition	hasResult()
<F> AnyQuery<F>	map(com.google.common.base.Function<? super E,F> mapper) Map the query results using mapper.
protected <F> com.google.common.base.Supplier<Iterable<F>>	mapSupplier(com.google.common.base.Function<? super E,F> mapper)
protected abstract <F> AnyQuery<F>	newAnyQueryInstance(com.google.common.base.Supplier<Iterable<F>> supplier)
protected abstract Q	newInstance(com.google.common.base.Supplier<Iterable<E>> supplier)
Iterable<E>	now() Equivalent to Supplier.get().
TimedQuery<Iterable<E>>	timed()

Methods inherited from class java.lang.Object

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

Field Detail

timeouts

@Inject
protected Timeouts timeouts

pageBinder

@Inject
protected PageBinder pageBinder

querySupplier

protected final com.google.common.base.Supplier<Iterable<E>> querySupplier

Constructor Detail

AbstractSearchQuery

protected AbstractSearchQuery(@Nonnull
                              com.google.common.base.Supplier<Iterable<E>> querySupplier)

Method Detail

filter

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

Description copied from interface: SearchQuery

Filter the underlying results using predicate.

Specified by:

filter in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

Parameters:

predicate - predicate to filter the results

Returns:

new query with the applied filter

map

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

Description copied from interface: SearchQuery

Map the query results using mapper.

Specified by:

map in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

Type Parameters:

F - the new result type

Parameters:

mapper - a function to map the results

Returns:

new query with mapped results

flatMap

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

Description copied from interface: SearchQuery

Flat map the results using mapper.

Specified by:

flatMap in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

Type Parameters:

F - the new result type

Parameters:

mapper - the function to use to flat map

Returns:

new query with mapped results.

bindTo

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

Description copied from interface: SearchQuery

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

Specified by:

bindTo in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

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...)

get

public final Iterable<E> get()

Specified by:

get in interface com.google.common.base.Supplier<Iterable<E>>

first

@Nullable
public final E first()

Specified by:

first in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

Returns:

first result , or null if there is no results

now

@Nonnull
public final Iterable<E> now()

Description copied from interface: SearchQuery

Equivalent to Supplier.get().

Specified by:

now in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

Returns:

all results, as they are now

hasResult

@Nonnull
public final TimedCondition hasResult()

Specified by:

hasResult in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

Returns:

timed condition to check whether this query has any result

timed

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

Specified by:

timed in interface SearchQuery<E,Q extends SearchQuery<E,Q>>

Returns:

timed query for all results

newInstance

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

newAnyQueryInstance

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

flatMapSupplier

protected final <F> com.google.common.base.Supplier<Iterable<F>> flatMapSupplier(@Nonnull
                                                                                 com.google.common.base.Function<? super E,Iterable<F>> mapper)

mapSupplier

protected final <F> com.google.common.base.Supplier<Iterable<F>> mapSupplier(@Nonnull
                                                                             com.google.common.base.Function<? super E,F> mapper)