Package org.kquiet.browser

Class BasicActionComposer

java.lang.Object

java.util.concurrent.CompletableFuture<Void>

org.kquiet.browser.AbstractActionComposer

org.kquiet.browser.BasicActionComposer

All Implemented Interfaces:

Runnable, CompletionStage<Void>, Future<Void>, ActionComposer, DynamicActionSequence, Prioritized

public class BasicActionComposer
extends AbstractActionComposer

BasicActionComposer provides basic implementation of ActionComposer. In addition to the actions added by add*() methods, BasicActionComposer has two extra/internal actions which are executed at the beginning and the end respectively:

• The action executed at the beginning is called as Initial Action, which opens a new browser window and set it as focus window with an empty register name. All actions should be executed against this focus window to be isolated from other ActionComposer, however it could be changed by actions if necessary. If no focus window is specified, it will use the root window of ActionRunner as its focus window.
• The action executed at the end is called as Final Action, which closes all registered windows.

Author:

Kimberly

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Field Summary

Fields inherited from class org.kquiet.browser.AbstractActionComposer

executionContextStack, totalCostWatch

Constructor Summary

Constructors

Constructor	Description
BasicActionComposer()	Create an BasicActionComposer.

Method Summary

Modifier and Type	Method	Description
BasicActionComposer	addToHead(Composable action)	Add action to the head of the action sequence.
BasicActionComposer	addToPosition(Composable action, int position)	Add action to the specified position of the action sequence.
BasicActionComposer	addToTail(Composable action)	Add action to the tail of the action sequence.
BasicActionComposer	continueWith(BasicActionComposer childActionComposer)	Delegate the execution of given child BasicActionComposer to associated ActionRunner after this BasicActionComposer is done.
protected List<Composable>	getAllActionInSequence()	Get all actions in the action sequence.
BasicActionComposer	getChild()	Get child BasicActionComposer.
String	getFailPage()	Get the content of the last page when this ActionComposer is marked as failed and the flag to keep fail information is enabled.
String	getFailUrl()	Get the url of the last page when this ActionComposer is marked as failed and the flag to keep fail information is enabled.
BasicActionComposer	getParent()	Get parent BasicActionComposer.
boolean	hasChild()	Check whether this BasicActionComposer has child BasicActionComposer.
boolean	hasParent()	Check whether this BasicActionComposer has parent BasicActionComposer.
boolean	isFail()	Check if this BasicActionComposer has been marked as failed.
boolean	isSuccessfulDone()	Check if this BasicActionComposer is done without being marked as failed.
BasicActionComposer	keepFailInfo(boolean flag)	Enable/Disable the function of keeping fail information when this ActionComposer is marked as failed.
BasicActionComposer	onDone(Consumer<ActionComposer> onDoneFunc)	Set the function to be executed when this ActionComposer is done.
BasicActionComposer	onFail(Consumer<ActionComposer> onFailFunc)	Set the function to be executed when this ActionComposer is marked as failed.
BasicActionComposer	onSuccess(Consumer<ActionComposer> onSuccessFunc)	Set the function to be executed when this ActionComposer is finished without being marked as failed.
void	run()
BasicActionComposer	setActionRunner(ActionRunner actionRunner)	Set associated ActionRunner.
BasicActionComposer	setCloseWindow(boolean closeWindowFlag)	Determine whether close all registered windows at the end.
BasicActionComposer	setFocusWindow(String windowIdentity)	Set the specified window as the focus window.
BasicActionComposer	setName(String name)	Set the name of this ActionComposer.
BasicActionComposer	setOpenWindow(boolean openWindowFlag)	Determine whether open a window as focus window at the begining.
BasicActionComposer	setPriority(int priority)	Set the priority of this AbstractActionComposer.
BasicActionComposer	setVariable(String variableName, Object value)	Set variable value.
boolean	skipped()	Check if ActionComposer.skipToFail() or ActionComposer.skipToSuccess() of this ActionComposer has been invoked.
void	skipToFail()	Skip the execution of remaining actions and mark this BasicActionComposer as failed.
void	skipToSuccess()	Skip the execution of remaining actions.

Methods inherited from class org.kquiet.browser.AbstractActionComposer

actionPerformed, actionPerforming, addToHeadByContext, addToPositionByContext, addToTailByContext, callBrowser, getActionPerformedFunction, getActionPerformingFunction, getActionRunner, getCostTime, getDoneFunction, getErrors, getFailFunction, getFocusWindow, getName, getPriority, getRegisteredWindow, getRegisteredWindows, getRootWindow, getSuccessFunction, getVariable, getWebDriver, perform, registerWindow, switchToFocusWindow, switchToInnerFrame, switchToTop, switchToWindow

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedFuture, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, failedFuture, failedStage, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kquiet.browser.ActionComposer

isDone

Methods inherited from interface org.kquiet.browser.DynamicActionSequence

add

Constructor Details

BasicActionComposer

public BasicActionComposer()

Create an BasicActionComposer.

Method Details

run

public void run()

setActionRunner

public BasicActionComposer setActionRunner(ActionRunner actionRunner)

Description copied from interface: ActionComposer

Set associated ActionRunner.

Specified by:

setActionRunner in interface ActionComposer

Overrides:

setActionRunner in class AbstractActionComposer

Parameters:

actionRunner - action runner to set

Returns:

self reference

setVariable

public BasicActionComposer setVariable(String variableName,
 Object value)

Description copied from interface: ActionComposer

Set variable value.

Specified by:

setVariable in interface ActionComposer

Overrides:

setVariable in class AbstractActionComposer

Parameters:

variableName - variable name

value - variable value

Returns:

self reference

continueWith

public BasicActionComposer continueWith(BasicActionComposer childActionComposer)

Delegate the execution of given child BasicActionComposer to associated ActionRunner after this BasicActionComposer is done. Every BasicActionComposer has at most one parent/child BasicActionComposer. If this BasicActionComposer already has a child BasicActionComposer, the original child BasicActionComposer will be postponed.

For example, before calling this method: ComposerA->ChildOfComposerA->GrandChildOfComposerA; after: ComposerA->NewChildOfComposerA->ChildOfComposerA->GrandChildOfComposerA.

This method works differently as methods of CompletableFuture. It just keeps the reference of child BasicActionComposer and this BasicActionComposer will hand it to associated ActionRunner when finished, and then let the ActionRunner schedule the execution.

Parameters:

childActionComposer - the BasicActionComposer to be executed

Returns:

child BasicActionComposer

hasChild

public boolean hasChild()

Check whether this BasicActionComposer has child BasicActionComposer.

Returns:

true whether this BasicActionComposer has child BasicActionComposer; false otherwise

getChild

public BasicActionComposer getChild()

Get child BasicActionComposer.

Returns:

child BasicActionComposer if exists; null otherwise

hasParent

public boolean hasParent()

Check whether this BasicActionComposer has parent BasicActionComposer.

Returns:

true whether this BasicActionComposer has parent BasicActionComposer; false otherwise

getParent

public BasicActionComposer getParent()

Get parent BasicActionComposer.

Returns:

parent BasicActionComposer if exists; null otherwise

onFail

public BasicActionComposer onFail(Consumer<ActionComposer> onFailFunc)

Description copied from interface: ActionComposer

Set the function to be executed when this ActionComposer is marked as failed.

Specified by:

onFail in interface ActionComposer

Overrides:

onFail in class AbstractActionComposer

Parameters:

onFailFunc - the function to be executed

Returns:

self reference

onSuccess

public BasicActionComposer onSuccess(Consumer<ActionComposer> onSuccessFunc)

Description copied from interface: ActionComposer

Set the function to be executed when this ActionComposer is finished without being marked as failed.

Specified by:

onSuccess in interface ActionComposer

Overrides:

onSuccess in class AbstractActionComposer

Parameters:

onSuccessFunc - the function to be executed

Returns:

self reference

onDone

public BasicActionComposer onDone(Consumer<ActionComposer> onDoneFunc)

Description copied from interface: ActionComposer

Set the function to be executed when this ActionComposer is done. This function is executed after fail function and success function.

Specified by:

onDone in interface ActionComposer

Overrides:

onDone in class AbstractActionComposer

Parameters:

onDoneFunc - the function to be executed

Returns:

self reference

setName

public BasicActionComposer setName(String name)

Description copied from interface: ActionComposer

Set the name of this ActionComposer.

Specified by:

setName in interface ActionComposer

Overrides:

setName in class AbstractActionComposer

Parameters:

name - name

Returns:

self reference

setPriority

public BasicActionComposer setPriority(int priority)

Description copied from class: AbstractActionComposer

Set the priority of this AbstractActionComposer.

Overrides:

setPriority in class AbstractActionComposer

Parameters:

priority - priority

Returns:

self reference

skipped

public boolean skipped()

Description copied from interface: ActionComposer

Check if ActionComposer.skipToFail() or ActionComposer.skipToSuccess() of this ActionComposer has been invoked.

Returns:

true if any of both methods has been invoked; otherwise false

isFail

public boolean isFail()

Check if this BasicActionComposer has been marked as failed.

Returns:

true if this BasicActionComposer has been marked as failed; false otherwise

isSuccessfulDone

public boolean isSuccessfulDone()

Check if this BasicActionComposer is done without being marked as failed.

Returns:

true if this BasicActionComposer is done without being marked as failed; false otherwise

getFailUrl

public String getFailUrl()

Description copied from interface: ActionComposer

Get the url of the last page when this ActionComposer is marked as failed and the flag to keep fail information is enabled.

Returns:

the url represented by String

getFailPage

public String getFailPage()

Description copied from interface: ActionComposer

Get the content of the last page when this ActionComposer is marked as failed and the flag to keep fail information is enabled.

Returns:

the content represented by String

keepFailInfo

public BasicActionComposer keepFailInfo(boolean flag)

Description copied from interface: ActionComposer

Enable/Disable the function of keeping fail information when this ActionComposer is marked as failed. The function of keeping fail information takes about one second to complete, however this may seem wasteful in many applications, hence this method can be used to determine keep or not.

Parameters:

flag - true to enable; false to disable

Returns:

self reference

setFocusWindow

public BasicActionComposer setFocusWindow(String windowIdentity)

Description copied from interface: ActionComposer

Set the specified window as the focus window.

Specified by:

setFocusWindow in interface ActionComposer

Overrides:

setFocusWindow in class AbstractActionComposer

Parameters:

windowIdentity - the window identity to set as the focus window

Returns:

self reference

addToHead

public BasicActionComposer addToHead(Composable action)

Description copied from interface: DynamicActionSequence

Add action to the head of the action sequence.

Specified by:

addToHead in interface DynamicActionSequence

Overrides:

addToHead in class AbstractActionComposer

Parameters:

action - action to add

Returns:

self reference

addToTail

public BasicActionComposer addToTail(Composable action)

Description copied from interface: DynamicActionSequence

Add action to the tail of the action sequence.

Specified by:

addToTail in interface DynamicActionSequence

Overrides:

addToTail in class AbstractActionComposer

Parameters:

action - action to add

Returns:

self reference

addToPosition

public BasicActionComposer addToPosition(Composable action,
 int position)

Description copied from interface: DynamicActionSequence

Add action to the specified position of the action sequence.

Specified by:

addToPosition in interface DynamicActionSequence

Overrides:

addToPosition in class AbstractActionComposer

Parameters:

action - action to add

position - the position(zero-based) to add given action

Returns:

self reference

getAllActionInSequence

protected List<Composable> getAllActionInSequence()

Description copied from class: AbstractActionComposer

Get all actions in the action sequence.

Overrides:

getAllActionInSequence in class AbstractActionComposer

Returns:

list of actions

skipToFail

public void skipToFail()

Skip the execution of remaining actions and mark this BasicActionComposer as failed.

skipToSuccess

public void skipToSuccess()

Skip the execution of remaining actions.

setOpenWindow

public BasicActionComposer setOpenWindow(boolean openWindowFlag)

Determine whether open a window as focus window at the begining.

Parameters:

openWindowFlag - true: open; false: not open

Returns:

self reference

setCloseWindow

public BasicActionComposer setCloseWindow(boolean closeWindowFlag)

Determine whether close all registered windows at the end.

Parameters:

closeWindowFlag - true: close; false: not close

Returns:

self reference