me.alb_i986.selenium.tinafw.tasks

Class CompositeWebTask

java.lang.Object

me.alb_i986.selenium.tinafw.tasks.BaseWebTask

me.alb_i986.selenium.tinafw.tasks.CompositeWebTask

All Implemented Interfaces:

Iterable<WebTask>, WebTask

Direct Known Subclasses:

OrWebTask, SingleUserInteraction

public class CompositeWebTask
extends BaseWebTask
implements Iterable<WebTask>

A WebTask made up of many supposedly small (sub-)tasks, which in turn may be CompositeWebTask's too.

CompositeWebTask allows you to build trees of WebTask's. The idea is to have many atomic WebTask's (the leaves of the tree) focused on a very small user interaction. And then you start build up tasks by composition.

With CompositeWebTask you may even get rid of page objects (!), and have WebTask's talk directly to PageComponent's.

Exploiting the Composite design pattern.

Field Summary

Fields inherited from class me.alb_i986.selenium.tinafw.tasks.BaseWebTask

logger, user

Constructor Summary

Constructors

Constructor and Description
CompositeWebTask(List<WebTask> subtasks) Set the given list as the list of components of this composite.
CompositeWebTask(WebTask... subtasks)

Method Summary

Modifier and Type	Method and Description
CompositeWebTask	append(WebTask... subtasks) Append the given subtasks to the list of components.
Iterator<WebTask>	iterator() The iterator for iterating over the subtasks this composite is made up of.
WebPage	run(WebPage initialPage) Runs each subtask in order, and finally return the page that the last task was visiting.

Methods inherited from class me.alb_i986.selenium.tinafw.tasks.BaseWebTask

browser, driver, getUser, setUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface me.alb_i986.selenium.tinafw.tasks.WebTask

or

Constructor Detail

CompositeWebTask

public CompositeWebTask(WebTask... subtasks)

See Also:

CompositeWebTask(List)

CompositeWebTask

public CompositeWebTask(List<WebTask> subtasks)

Set the given list as the list of components of this composite. Replace any null subtask with a WebTasks.nullTask().

Method Detail

run

public WebPage run(WebPage initialPage)

Runs each subtask in order, and finally return the page that the last task was visiting. Each subtask will run with the same user as the composite.

Specified by:

run in interface WebTask

Parameters:

initialPage - the page it is displayed before this task starts

Returns:

the last page that is displayed after this task finishes

Throws:

IllegalStateException - if the user set in this composite is null

iterator

public Iterator<WebTask> iterator()

The iterator for iterating over the subtasks this composite is made up of.

Backed by List.iterator().

Specified by:

iterator in interface Iterable<WebTask>

append

public CompositeWebTask append(WebTask... subtasks)

Append the given subtasks to the list of components.

Parameters:

subtasks -

Returns:

this