com.atlassian.pageobjects

Class PageObjects

java.lang.Object

com.atlassian.pageobjects.PageObjects

@PublicApi
public final class PageObjects
extends Object

Predicates, functions and other utilities for use with PageBinder and other page-object-related APIs.

Since:

2.3

Method Summary

Modifier and Type	Method and Description
static <E,EE> Iterable<EE>	bind(PageBinder binder, Iterable<E> pageElements, Class<EE> pageObjectClass, Object... extraArguments) Transforms a list of objects into a list of page objects wrapping those objects.
static <E,PO> com.google.common.base.Function<E,PO>	bindTo(PageBinder binder, Class<E> inputType, Class<PO> pageObjectClass, Object... extraArguments) Binds 'wrapper' page objects that take one constructor parameter (and optionally any number of "fixed" extraArguments.
static <E,PO> com.google.common.base.Function<E,PO>	bindTo(PageBinder binder, Class<PO> pageObjectClass, Object... extraArguments) Version of bindTo(PageBinder, Class, Class, Object...) for where there's no explicit input type.

Methods inherited from class java.lang.Object

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

Method Detail

bindTo

@Nonnull
public static <E,PO> com.google.common.base.Function<E,PO> bindTo(@Nonnull
                                                                           PageBinder binder,
                                                                           @Nonnull
                                                                           Class<PO> pageObjectClass,
                                                                           @Nonnull
                                                                           Object... extraArguments)

Version of bindTo(PageBinder, Class, Class, Object...) for where there's no explicit input type.

Type Parameters:

E - input type

PO - wrapping object type

Parameters:

binder - page binder

pageObjectClass - target page object class

extraArguments - extra arguments to use when binding each page object

Returns:

page binding function

See Also:

bindTo(PageBinder, Class, Object...)

bindTo

@Nonnull
public static <E,PO> com.google.common.base.Function<E,PO> bindTo(@Nonnull
                                                                           PageBinder binder,
                                                                           @Nullable
                                                                           Class<E> inputType,
                                                                           @Nonnull
                                                                           Class<PO> pageObjectClass,
                                                                           @Nonnull
                                                                           Object... extraArguments)

Binds 'wrapper' page objects that take one constructor parameter (and optionally any number of "fixed" extraArguments. Most useful for simple page objects wrapping page elements, e.g. table rows.

Note: the wrapping type needs to have a constructor that accepts a single instance of the input type and all the extra parameters as provided by extraArguments.

Type Parameters:

E - input type

PO - wrapping object type

Parameters:

binder - page binder

inputType - source class to use this method more conveniently

pageObjectClass - target page object class

extraArguments - extra arguments to use when binding each page object

Returns:

page binding function

See Also:

PageBinder.bind(Class, Object...)

bind

@Nonnull
public static <E,EE> Iterable<EE> bind(@Nonnull
                                                PageBinder binder,
                                                @Nonnull
                                                Iterable<E> pageElements,
                                                @Nonnull
                                                Class<EE> pageObjectClass,
                                                @Nonnull
                                                Object... extraArguments)

Transforms a list of objects into a list of page objects wrapping those objects. Most commonly the input list will contain page elements of some sort.

Type Parameters:

E - input object type

EE - wrapping object type

Parameters:

binder - page binder

pageElements - a list of page elements to transform

pageObjectClass - target page object class

extraArguments - extra arguments to use when binding each page object

Returns:

a list of page objects wrapping the inputs

See Also:

bindTo(PageBinder, Class, Object...)