Package org.kquiet.browser

Class ActionComposerBuilder.ActionSequenceBuilder

java.lang.Object

org.kquiet.browser.ActionComposerBuilder.ActionSequenceBuilder

Enclosing class:

ActionComposerBuilder

public class ActionComposerBuilder.ActionSequenceBuilder
extends Object

A builder to build the actions into a sequence.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ActionComposerBuilder.ActionSequenceBuilder.ClickBuilder	A builder to build Click in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.CloseWindowBuilder	A builder to build CloseWindow in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.CustomBuilder	A builder to build Custom in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.ExtractBuilder	A builder to build Extract in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.GetUrlBuilder	A builder to build GetUrl in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder	A builder to build IfThenElse in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.JustWaitBuilder	A builder to build JustWait in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.MouseOverBuilder	A builder to build MouseOver in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.OpenWindowBuilder	A builder to build OpenWindow in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.PostFormBuilder	A builder to build PostForm in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.ReplyAlertBuilder	A builder to build ReplyAlert in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.ScrollToViewBuilder	A builder to build ScrollToView in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.SelectBuilder	A builder to build Select in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.SendKeyBuilder	A builder to build SendKey in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.UploadBuilder	A builder to build Upload in a fluent way.
class	ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>	A builder to build WaitUntil in a fluent way.

Constructor Summary

Constructors

Constructor	Description
ActionSequenceBuilder(ActionComposerBuilder parentComposerBuilder)	Create a new ActionComposerBuilder.ActionSequenceBuilder with an ActionComposerBuilder as its parent builder.
ActionSequenceBuilder(ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder parentIfThenElseBuilder)	Create a new ActionComposerBuilder.ActionSequenceBuilder with an ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder as its parent builder.

Method Summary

Modifier and Type	Method	Description
ActionComposerBuilder.ActionSequenceBuilder	click(org.openqa.selenium.By by)	Add a Click to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	closeWindow(boolean closeAllRegistered)	Add a CloseWindow to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	custom(Consumer<ActionComposer> customAction)	Add a single-phased Custom to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	customMultiPhase(Function<MultiPhased,Consumer<ActionComposer>> multiPhasedCustomAction)	Add a multiple-phased Custom to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder	endActionSequence()	Finish building the sequence of actions so far and return control to parent builder (ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder).
ActionComposerBuilder.ActionSequenceBuilder	getUrl(String url)	Add a GetUrl to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	justWait(int totalTimeout)	Add a JustWait to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	mouseOver(org.openqa.selenium.By by)	Add a MouseOver to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	openWindow()	Add a OpenWindow to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	postForm(String url, List<AbstractMap.SimpleImmutableEntry<String,String>> formData)	Add a PostForm to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder.ClickBuilder	prepareClick(org.openqa.selenium.By by)	Start building a Click.
ActionComposerBuilder.ActionSequenceBuilder.CloseWindowBuilder	prepareCloseWindow(boolean closeAllRegistered)	Start building a CloseWindow.
ActionComposerBuilder.ActionSequenceBuilder.CustomBuilder	prepareCustom(Consumer<ActionComposer> customAction)	Start building a single-phased Custom.
ActionComposerBuilder.ActionSequenceBuilder.CustomBuilder	prepareCustomMultiPhase(Function<MultiPhased,Consumer<ActionComposer>> multiPhasedCustomAction)	Start building a multiple-phased Custom.
ActionComposerBuilder.ActionSequenceBuilder.ExtractBuilder	prepareExtract(org.openqa.selenium.By by)	Start building a Extract.
ActionComposerBuilder.ActionSequenceBuilder.GetUrlBuilder	prepareGetUrl(String url)	Start building a GetUrl.
ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder	prepareIfThenElse(Function<ActionComposer,?> evalFunction)	Start building an IfThenElse.
ActionComposerBuilder.ActionSequenceBuilder.JustWaitBuilder	prepareJustWait(int totalTimeout)	Start building a JustWait.
ActionComposerBuilder.ActionSequenceBuilder.MouseOverBuilder	prepareMouseOver(org.openqa.selenium.By by)	Start building a MouseOver.
ActionComposerBuilder.ActionSequenceBuilder.OpenWindowBuilder	prepareOpenWindow()	Start building a OpenWindow.
ActionComposerBuilder.ActionSequenceBuilder.PostFormBuilder	preparePostForm(String url, List<AbstractMap.SimpleImmutableEntry<String,String>> formData)	Start building a PostForm.
ActionComposerBuilder.ActionSequenceBuilder.ReplyAlertBuilder	prepareReplyAlert(ReplyAlert.Decision decision)	Start building a ReplyAlert.
ActionComposerBuilder.ActionSequenceBuilder.ScrollToViewBuilder	prepareScrollToView(org.openqa.selenium.By by, boolean toTop)	Start building a ScrollToView.
ActionComposerBuilder.ActionSequenceBuilder.SelectBuilder	prepareSelect(org.openqa.selenium.By by)	Start building a Select.
ActionComposerBuilder.ActionSequenceBuilder.SendKeyBuilder	prepareSendKey(org.openqa.selenium.By by, CharSequence... keysToSend)	Start building a SendKey.
ActionComposerBuilder.ActionSequenceBuilder.UploadBuilder	prepareUpload(org.openqa.selenium.By by, String... pathOfFiles)	Start building a Upload.
<V> ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>	prepareWaitUntil(Function<org.openqa.selenium.WebDriver,V> conditionFunc, int totalTimeout)	Start building a WaitUntil.
ActionComposerBuilder.ActionSequenceBuilder	replyAlert(ReplyAlert.Decision decision)	Add a ReplyAlert to the sequence of actions.
ActionComposerBuilder	returnToComposerBuilder()	Finish building the sequence of actions so far and return control to root builder (ActionComposerBuilder).
ActionComposerBuilder.ActionSequenceBuilder	scrollToView(org.openqa.selenium.By by, boolean toTop)	Add a ScrollToView to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	selectByIndex(org.openqa.selenium.By by, Integer... options)	Add a Select to the sequence of actions, which select by index.
ActionComposerBuilder.ActionSequenceBuilder	selectByText(org.openqa.selenium.By by, String... options)	Add a Select to the sequence of actions, which select by text.
ActionComposerBuilder.ActionSequenceBuilder	selectByValue(org.openqa.selenium.By by, String... options)	Add a Select to the sequence of actions, which select by value.
ActionComposerBuilder.ActionSequenceBuilder	sendKey(org.openqa.selenium.By by, CharSequence... keysToSend)	Add a SendKey to the sequence of actions.
ActionComposerBuilder.ActionSequenceBuilder	upload(org.openqa.selenium.By by, String... pathOfFiles)	Add a Upload to the sequence of actions.
<V> ActionComposerBuilder.ActionSequenceBuilder	waitUntil(Function<org.openqa.selenium.WebDriver,V> conditionFunc, int totalTimeout)	Add a WaitUntil to the sequence of actions.

Methods inherited from class java.lang.Object

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

Constructor Details

ActionSequenceBuilder

public ActionSequenceBuilder(ActionComposerBuilder parentComposerBuilder)

Create a new ActionComposerBuilder.ActionSequenceBuilder with an ActionComposerBuilder as its parent builder.

Parameters:

parentComposerBuilder - parent builder

ActionSequenceBuilder

public ActionSequenceBuilder(ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder parentIfThenElseBuilder)

Create a new ActionComposerBuilder.ActionSequenceBuilder with an ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder as its parent builder.

Parameters:

parentIfThenElseBuilder - parent builder

Method Details

returnToComposerBuilder

public ActionComposerBuilder returnToComposerBuilder()

Finish building the sequence of actions so far and return control to root builder (ActionComposerBuilder).

Returns:

root builder(ActionComposerBuilder)

endActionSequence

public ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder endActionSequence()

Finish building the sequence of actions so far and return control to parent builder (ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder).

Returns:

parent builder(ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder)

Throws:

UnsupportedOperationException - if parent builder is not ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder.

closeWindow

public ActionComposerBuilder.ActionSequenceBuilder closeWindow(boolean closeAllRegistered)

Add a CloseWindow to the sequence of actions.

Parameters:

closeAllRegistered - true: close all regisetered windows; false: close only the focus window.

Returns:

self reference

prepareCloseWindow

public ActionComposerBuilder.ActionSequenceBuilder.CloseWindowBuilder prepareCloseWindow(boolean closeAllRegistered)

Start building a CloseWindow.

Parameters:

closeAllRegistered - true: close all regisetered windows; false: close only the focus window

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.CloseWindowBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

openWindow

public ActionComposerBuilder.ActionSequenceBuilder openWindow()

Add a OpenWindow to the sequence of actions.

Returns:

self reference

prepareOpenWindow

public ActionComposerBuilder.ActionSequenceBuilder.OpenWindowBuilder prepareOpenWindow()

Start building a OpenWindow.

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.OpenWindowBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

waitUntil

public <V>
ActionComposerBuilder.ActionSequenceBuilder waitUntil(Function<org.openqa.selenium.WebDriver,V> conditionFunc,
 int totalTimeout)

Add a WaitUntil to the sequence of actions.

Type Parameters:

V - the expected return type of condition function

Parameters:

conditionFunc - the condition function for evaluation by phases

totalTimeout - the maximum amount of time to wait totally

Returns:

self reference

prepareWaitUntil

public <V>
ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V> prepareWaitUntil(Function<org.openqa.selenium.WebDriver,V> conditionFunc,
 int totalTimeout)

Start building a WaitUntil.

Type Parameters:

V - the expected return type of condition function

Parameters:

conditionFunc - the condition function for evaluation by phases

totalTimeout - the maximum amount of time to wait totally

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

justWait

public ActionComposerBuilder.ActionSequenceBuilder justWait(int totalTimeout)

Add a JustWait to the sequence of actions.

Parameters:

totalTimeout - the maximum amount of time to wait totally

Returns:

self reference

prepareJustWait

public ActionComposerBuilder.ActionSequenceBuilder.JustWaitBuilder prepareJustWait(int totalTimeout)

Start building a JustWait.

Parameters:

totalTimeout - the maximum amount of time to wait totally

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.JustWaitBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

postForm

public ActionComposerBuilder.ActionSequenceBuilder postForm(String url,
 List<AbstractMap.SimpleImmutableEntry<String,String>> formData)

Add a PostForm to the sequence of actions.

Parameters:

url - the address where to submit the form

formData - the form data to submit

Returns:

self reference

preparePostForm

public ActionComposerBuilder.ActionSequenceBuilder.PostFormBuilder preparePostForm(String url,
 List<AbstractMap.SimpleImmutableEntry<String,String>> formData)

Start building a PostForm.

Parameters:

url - the address where to submit the form

formData - the form data to submit

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.PostFormBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

getUrl

public ActionComposerBuilder.ActionSequenceBuilder getUrl(String url)

Add a GetUrl to the sequence of actions.

Parameters:

url - the url of web page

Returns:

self reference

prepareGetUrl

public ActionComposerBuilder.ActionSequenceBuilder.GetUrlBuilder prepareGetUrl(String url)

Start building a GetUrl.

Parameters:

url - the url of web page

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.GetUrlBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

selectByIndex

public ActionComposerBuilder.ActionSequenceBuilder selectByIndex(org.openqa.selenium.By by,
 Integer... options)

Add a Select to the sequence of actions, which select by index.

Parameters:

by - the element locating mechanism

options - the option to select; all options are deselected when no option is supplied and the SELECT element supports selecting multiple options

Returns:

self reference

selectByText

public ActionComposerBuilder.ActionSequenceBuilder selectByText(org.openqa.selenium.By by,
 String... options)

Add a Select to the sequence of actions, which select by text.

Parameters:

by - the element locating mechanism

options - the option to select; all options are deselected when no option is supplied and the SELECT element supports selecting multiple options

Returns:

self reference

selectByValue

public ActionComposerBuilder.ActionSequenceBuilder selectByValue(org.openqa.selenium.By by,
 String... options)

Add a Select to the sequence of actions, which select by value.

Parameters:

by - the element locating mechanism

options - the option to select; all options are deselected when no option is supplied and the SELECT element supports selecting multiple options

Returns:

self reference

prepareSelect

public ActionComposerBuilder.ActionSequenceBuilder.SelectBuilder prepareSelect(org.openqa.selenium.By by)

Start building a Select.

Parameters:

by - the element locating mechanism

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.SelectBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

sendKey

public ActionComposerBuilder.ActionSequenceBuilder sendKey(org.openqa.selenium.By by,
 CharSequence... keysToSend)

Add a SendKey to the sequence of actions.

Parameters:

by - the element locating mechanism

keysToSend - character sequence to send to the element

Returns:

self reference

prepareSendKey

public ActionComposerBuilder.ActionSequenceBuilder.SendKeyBuilder prepareSendKey(org.openqa.selenium.By by,
 CharSequence... keysToSend)

Start building a SendKey.

Parameters:

by - the element locating mechanism

keysToSend - character sequence to send to the element

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.SendKeyBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

prepareExtract

public ActionComposerBuilder.ActionSequenceBuilder.ExtractBuilder prepareExtract(org.openqa.selenium.By by)

Start building a Extract.

Parameters:

by - the element locating mechanism

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.ExtractBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

click

public ActionComposerBuilder.ActionSequenceBuilder click(org.openqa.selenium.By by)

Add a Click to the sequence of actions.

Parameters:

by - the element locating mechanism

Returns:

self reference

prepareClick

public ActionComposerBuilder.ActionSequenceBuilder.ClickBuilder prepareClick(org.openqa.selenium.By by)

Start building a Click.

Parameters:

by - the element locating mechanism

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.ClickBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

mouseOver

public ActionComposerBuilder.ActionSequenceBuilder mouseOver(org.openqa.selenium.By by)

Add a MouseOver to the sequence of actions.

Parameters:

by - the element locating mechanism

Returns:

self reference

prepareMouseOver

public ActionComposerBuilder.ActionSequenceBuilder.MouseOverBuilder prepareMouseOver(org.openqa.selenium.By by)

Start building a MouseOver.

Parameters:

by - the element locating mechanism

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.MouseOverBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

custom

public ActionComposerBuilder.ActionSequenceBuilder custom(Consumer<ActionComposer> customAction)

Add a single-phased Custom to the sequence of actions.

Parameters:

customAction - custom action

Returns:

self reference

customMultiPhase

public ActionComposerBuilder.ActionSequenceBuilder customMultiPhase(Function<MultiPhased,Consumer<ActionComposer>> multiPhasedCustomAction)

Add a multiple-phased Custom to the sequence of actions.

Parameters:

multiPhasedCustomAction - multiple-phased custom action

Returns:

self reference

prepareCustom

public ActionComposerBuilder.ActionSequenceBuilder.CustomBuilder prepareCustom(Consumer<ActionComposer> customAction)

Start building a single-phased Custom.

Parameters:

customAction - custom action

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.CustomBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

prepareCustomMultiPhase

public ActionComposerBuilder.ActionSequenceBuilder.CustomBuilder prepareCustomMultiPhase(Function<MultiPhased,Consumer<ActionComposer>> multiPhasedCustomAction)

Start building a multiple-phased Custom.

Parameters:

multiPhasedCustomAction - multiple-phased custom action

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.CustomBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

scrollToView

public ActionComposerBuilder.ActionSequenceBuilder scrollToView(org.openqa.selenium.By by,
 boolean toTop)

Add a ScrollToView to the sequence of actions.

Parameters:

by - the element locating mechanism

toTop - true: scroll to top;false: scroll to bottom

Returns:

self reference

prepareScrollToView

public ActionComposerBuilder.ActionSequenceBuilder.ScrollToViewBuilder prepareScrollToView(org.openqa.selenium.By by,
 boolean toTop)

Start building a ScrollToView.

Parameters:

by - the element locating mechanism

toTop - true: scroll to top;false: scroll to bottom

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.ScrollToViewBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

upload

public ActionComposerBuilder.ActionSequenceBuilder upload(org.openqa.selenium.By by,
 String... pathOfFiles)

Add a Upload to the sequence of actions.

Parameters:

by - the element locating mechanism

pathOfFiles - the paths of files to upload

Returns:

self reference

prepareUpload

public ActionComposerBuilder.ActionSequenceBuilder.UploadBuilder prepareUpload(org.openqa.selenium.By by,
 String... pathOfFiles)

Start building a Upload.

Parameters:

by - the element locating mechanism

pathOfFiles - the paths of files to upload

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.UploadBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

replyAlert

public ActionComposerBuilder.ActionSequenceBuilder replyAlert(ReplyAlert.Decision decision)

Add a ReplyAlert to the sequence of actions.

Parameters:

decision - the way to deal with alert box

Returns:

self reference

prepareReplyAlert

public ActionComposerBuilder.ActionSequenceBuilder.ReplyAlertBuilder prepareReplyAlert(ReplyAlert.Decision decision)

Start building a ReplyAlert.

Parameters:

decision - the way to deal with alert box

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.ReplyAlertBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder

prepareIfThenElse

public ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder prepareIfThenElse(Function<ActionComposer,?> evalFunction)

Start building an IfThenElse.

Parameters:

evalFunction - the function to evaluate

Returns:

a new ActionComposerBuilder.ActionSequenceBuilder.IfThenElseBuilder with this ActionComposerBuilder.ActionSequenceBuilder as parent builder