Package org.kquiet.browser

Class AbstractActionComposer

java.lang.Object

java.util.concurrent.CompletableFuture<Void>

org.kquiet.browser.AbstractActionComposer

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicActionComposer

public abstract class AbstractActionComposer
extends CompletableFuture<Void>
implements ActionComposer

AbstractActionComposer implements most methods of ActionComposer to lay ground works for possible subclasses. AbstractActionComposer itself is a subclass of CompletableFuture, so any subclass of AbstractActionComposer should complete itself explictly in Runnable.run().

Author:

Kimberly

Nested Class Summary

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

CompletableFuture.AsynchronousCompletionTask

Field Summary

Fields

Modifier and Type	Field	Description
protected final Stack<DynamicActionSequence>	executionContextStack	The execution context stack of this AbstractActionComposer, the DynamicActionSequence must be pushed into this stack before any action in it gets executed to reflect execution context.
protected final Stopwatch	totalCostWatch	The stop watch used to measure run cost of this AbstractActionComposer.

Constructor Summary

Constructors

Constructor	Description
AbstractActionComposer()	Create an AbstractActionComposer.

Method Summary

Modifier and Type	Method	Description
ActionComposer	actionPerformed(Function<ActionComposer,Consumer<Composable>> func)	Set the function to be executed after any managed action is performed.
ActionComposer	actionPerforming(Function<ActionComposer,Consumer<Composable>> func)	Set the function to be executed when any managed action is performed.
AbstractActionComposer	addToHead(Composable action)	Add action to the head of the action sequence.
DynamicActionSequence	addToHeadByContext(Composable action)	Add action to the head of the action sequence of execution context.
AbstractActionComposer	addToPosition(Composable action, int position)	Add action to the specified position of the action sequence.
DynamicActionSequence	addToPositionByContext(Composable action, int position)	Add action to specified position of the action sequence of execution context.
AbstractActionComposer	addToTail(Composable action)	Add action to the tail of the action sequence.
DynamicActionSequence	addToTailByContext(Composable action)	Add action to the tail of the action sequence of execution context.
CompletableFuture<Void>	callBrowser(Runnable runnable)	Delegate the execution of Runnable to associated ActionRunner with this ActionComposer's priority.
protected Function<ActionComposer,Consumer<Composable>>	getActionPerformedFunction()	Get the function to be executed after any managed action is performed.
protected Function<ActionComposer,Consumer<Composable>>	getActionPerformingFunction()	Get the function to be executed when any managed action is performed.
protected ActionRunner	getActionRunner()	Get associated ActionRunner.
protected List<Composable>	getAllActionInSequence()	Get all actions in the action sequence.
Duration	getCostTime()	Get total execution time of this AbstractActionComposer.
protected Consumer<ActionComposer>	getDoneFunction()	Get the function to be executed when finished.
List<Exception>	getErrors()	Get the error list from executed actions.
protected Consumer<ActionComposer>	getFailFunction()	Get the function executed when failed.
String	getFocusWindow()	Get the window identity of focus window.
String	getName()	Get the name of this ActionComposer.
int	getPriority()	Get priority.
String	getRegisteredWindow(String registerName)	Get registered window by given name.
Map<String,String>	getRegisteredWindows()	Get all registered windows.
String	getRootWindow()	Get the window identity of root window.
protected Consumer<ActionComposer>	getSuccessFunction()	Get the function executed when finished without fail.
Object	getVariable(String variableName)	Get the value of specified variable.
org.openqa.selenium.WebDriver	getWebDriver()	Get WebDriver from associated ActionRunner.
ActionComposer	onDone(Consumer<ActionComposer> onDoneFunc)	Set the function to be executed when this ActionComposer is done.
ActionComposer	onFail(Consumer<ActionComposer> onFailFunc)	Set the function to be executed when this ActionComposer is marked as failed.
ActionComposer	onSuccess(Consumer<ActionComposer> onSuccessFunc)	Set the function to be executed when this ActionComposer is finished without being marked as failed.
void	perform(Composable action)	Perform action.
boolean	registerWindow(String name, String windowIdentity)	Register a window to keep window identity.
AbstractActionComposer	setActionRunner(ActionRunner actionRunner)	Set associated ActionRunner.
AbstractActionComposer	setFocusWindow(String windowIdentity)	Set the specified window as the focus window.
AbstractActionComposer	setName(String name)	Set the name of this ActionComposer.
AbstractActionComposer	setPriority(int priority)	Set the priority of this AbstractActionComposer.
AbstractActionComposer	setVariable(String variableName, Object value)	Set variable value.
boolean	switchToFocusWindow()	Switch browser's focus window to this ActionComposer's focus window.
void	switchToInnerFrame(List<org.openqa.selenium.By> frameBySequence)	Switch to send future commands to a frame.
boolean	switchToTop()	Switch the focus of future commands to either the first frame on the page, or the main document when a page contains iframes.
boolean	switchToWindow(String windowIdentity)	Switch browser's focus window to specified window.

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

getFailPage, getFailUrl, isDone, isFail, isSuccessfulDone, keepFailInfo, skipped, skipToFail, skipToSuccess

Methods inherited from interface org.kquiet.browser.DynamicActionSequence

add

Methods inherited from interface java.lang.Runnable

run

Field Details

executionContextStack

protected final Stack<DynamicActionSequence> executionContextStack

The execution context stack of this AbstractActionComposer, the DynamicActionSequence must be pushed into this stack before any action in it gets executed to reflect execution context.

totalCostWatch

protected final Stopwatch totalCostWatch

The stop watch used to measure run cost of this AbstractActionComposer.

Constructor Details

AbstractActionComposer

public AbstractActionComposer()

Create an AbstractActionComposer.

Method Details

setActionRunner

public AbstractActionComposer setActionRunner(ActionRunner actionRunner)

Description copied from interface: ActionComposer

Set associated ActionRunner.

Specified by:

setActionRunner in interface ActionComposer

Parameters:

actionRunner - action runner to set

Returns:

self reference

getActionRunner

protected ActionRunner getActionRunner()

Get associated ActionRunner.

Returns:

ActionRunner

getRootWindow

public String getRootWindow()

Description copied from interface: ActionComposer

Get the window identity of root window.

Specified by:

getRootWindow in interface ActionComposer

Returns:

window identity represented by String

registerWindow

public boolean registerWindow(String name,
 String windowIdentity)

Description copied from interface: ActionComposer

Register a window to keep window identity.

Specified by:

registerWindow in interface ActionComposer

Parameters:

name - register name

windowIdentity - window identity

Returns:

true if register name is not null and window identity are not empty and the register name isn't registered; false otherwise

getRegisteredWindow

public String getRegisteredWindow(String registerName)

Description copied from interface: ActionComposer

Get registered window by given name.

Specified by:

getRegisteredWindow in interface ActionComposer

Parameters:

registerName - register name of window

Returns:

window identity

getRegisteredWindows

public Map<String,String> getRegisteredWindows()

Description copied from interface: ActionComposer

Get all registered windows.

Specified by:

getRegisteredWindows in interface ActionComposer

Returns:

all registered windows represented by Map (register name paire with window identity)

getVariable

public Object getVariable(String variableName)

Description copied from interface: ActionComposer

Get the value of specified variable.

Specified by:

getVariable in interface ActionComposer

Parameters:

variableName - variable name

Returns:

variable value

setVariable

public AbstractActionComposer setVariable(String variableName,
 Object value)

Description copied from interface: ActionComposer

Set variable value.

Specified by:

setVariable in interface ActionComposer

Parameters:

variableName - variable name

value - variable value

Returns:

self reference

callBrowser

public CompletableFuture<Void> callBrowser(Runnable runnable)

Description copied from interface: ActionComposer

Delegate the execution of Runnable to associated ActionRunner with this ActionComposer's priority.

Specified by:

callBrowser in interface ActionComposer

Parameters:

runnable - the object whose run method will be invoked

Returns:

a CompletableFuture representing pending completion of given Runnable

perform

public void perform(Composable action)

Description copied from interface: ActionComposer

Perform action. Any Composable should be performed by this method.

Specified by:

perform in interface ActionComposer

Parameters:

action - action to perform

switchToFocusWindow

public boolean switchToFocusWindow()

Description copied from interface: ActionComposer

Switch browser's focus window to this ActionComposer's focus window.

Specified by:

switchToFocusWindow in interface ActionComposer

Returns:

true if switch success; false otherwise

switchToWindow

public boolean switchToWindow(String windowIdentity)

Description copied from interface: ActionComposer

Switch browser's focus window to specified window.

Specified by:

switchToWindow in interface ActionComposer

Parameters:

windowIdentity - the window identity to switch to

Returns:

true if switch success; false otherwise

switchToInnerFrame

public void switchToInnerFrame(List<org.openqa.selenium.By> frameBySequence)

Description copied from interface: ActionComposer

Switch to send future commands to a frame.

Specified by:

switchToInnerFrame in interface ActionComposer

Parameters:

frameBySequence - the sequence of the frame locating mechanism

switchToTop

public boolean switchToTop()

Description copied from interface: ActionComposer

Switch the focus of future commands to either the first frame on the page, or the main document when a page contains iframes.

Specified by:

switchToTop in interface ActionComposer

Returns:

true if switch success; false otherwise

onFail

public ActionComposer 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

Parameters:

onFailFunc - the function to be executed

Returns:

self reference

getFailFunction

protected Consumer<ActionComposer> getFailFunction()

Get the function executed when failed.

Returns:

the function consuming ActionComposer

onSuccess

public ActionComposer 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

Parameters:

onSuccessFunc - the function to be executed

Returns:

self reference

getSuccessFunction

protected Consumer<ActionComposer> getSuccessFunction()

Get the function executed when finished without fail.

Returns:

the function consuming ActionComposer

onDone

public ActionComposer 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

Parameters:

onDoneFunc - the function to be executed

Returns:

self reference

getActionPerformedFunction

protected Function<ActionComposer,Consumer<Composable>> getActionPerformedFunction()

Get the function to be executed after any managed action is performed.

Returns:

the function consuming ActionComposer

actionPerformed

public ActionComposer actionPerformed(Function<ActionComposer,Consumer<Composable>> func)

Description copied from interface: ActionComposer

Set the function to be executed after any managed action is performed.

Specified by:

actionPerformed in interface ActionComposer

Parameters:

func - the function to be executed

Returns:

self reference

getActionPerformingFunction

protected Function<ActionComposer,Consumer<Composable>> getActionPerformingFunction()

Get the function to be executed when any managed action is performed.

Returns:

the function consuming ActionComposer

actionPerforming

public ActionComposer actionPerforming(Function<ActionComposer,Consumer<Composable>> func)

Description copied from interface: ActionComposer

Set the function to be executed when any managed action is performed.

Specified by:

actionPerforming in interface ActionComposer

Parameters:

func - the function to be executed

Returns:

self reference

getDoneFunction

protected Consumer<ActionComposer> getDoneFunction()

Get the function to be executed when finished.

Returns:

the function consuming ActionComposer

getName

public String getName()

Description copied from interface: ActionComposer

Get the name of this ActionComposer.

Specified by:

getName in interface ActionComposer

Returns:

name represented by String

setName

public AbstractActionComposer setName(String name)

Description copied from interface: ActionComposer

Set the name of this ActionComposer.

Specified by:

setName in interface ActionComposer

Parameters:

name - name

Returns:

self reference

getPriority

public int getPriority()

Description copied from interface: Prioritized

Get priority. Smaller value means higher priority.

Specified by:

getPriority in interface Prioritized

Returns:

priority

setPriority

public AbstractActionComposer setPriority(int priority)

Set the priority of this AbstractActionComposer.

Parameters:

priority - priority

Returns:

self reference

getCostTime

public Duration getCostTime()

Get total execution time of this AbstractActionComposer.

Returns:

the total execution time represented by Duration

getWebDriver

public org.openqa.selenium.WebDriver getWebDriver()

Description copied from interface: ActionComposer

Get WebDriver from associated ActionRunner. Use this with caution because the associated ActionRunner use the same WebDriver when executing browser actions, however WebDriver is not thread-safe.

A safer way to use this is to encapsulate the process in a Runnable, or use built-in custom action, and then execute it through ActionRunner.executeAction(java.lang.Runnable, int).

Specified by:

getWebDriver in interface ActionComposer

Returns:

the WebDriver of associated ActionRunner.

getFocusWindow

public String getFocusWindow()

Description copied from interface: ActionComposer

Get the window identity of focus window.

Specified by:

getFocusWindow in interface ActionComposer

Returns:

window identity represented by String

setFocusWindow

public AbstractActionComposer setFocusWindow(String windowIdentity)

Description copied from interface: ActionComposer

Set the specified window as the focus window.

Specified by:

setFocusWindow in interface ActionComposer

Parameters:

windowIdentity - the window identity to set as the focus window

Returns:

self reference

addToHead

public AbstractActionComposer addToHead(Composable action)

Description copied from interface: DynamicActionSequence

Add action to the head of the action sequence.

Specified by:

addToHead in interface DynamicActionSequence

Parameters:

action - action to add

Returns:

self reference

addToTail

public AbstractActionComposer addToTail(Composable action)

Description copied from interface: DynamicActionSequence

Add action to the tail of the action sequence.

Specified by:

addToTail in interface DynamicActionSequence

Parameters:

action - action to add

Returns:

self reference

addToPosition

public AbstractActionComposer 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

Parameters:

action - action to add

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

Returns:

self reference

addToHeadByContext

public DynamicActionSequence addToHeadByContext(Composable action)

Description copied from interface: ActionComposer

Add action to the head of the action sequence of execution context.

Specified by:

addToHeadByContext in interface ActionComposer

Parameters:

action - action to add

Returns:

execution context of actions

addToTailByContext

public DynamicActionSequence addToTailByContext(Composable action)

Description copied from interface: ActionComposer

Add action to the tail of the action sequence of execution context.

Specified by:

addToTailByContext in interface ActionComposer

Parameters:

action - action to add

Returns:

execution context of actions

addToPositionByContext

public DynamicActionSequence addToPositionByContext(Composable action,
 int position)

Description copied from interface: ActionComposer

Add action to specified position of the action sequence of execution context.

Specified by:

addToPositionByContext in interface ActionComposer

Parameters:

action - action to add

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

Returns:

execution context of actions

getAllActionInSequence

protected List<Composable> getAllActionInSequence()

Get all actions in the action sequence.

Returns:

list of actions

getErrors

public List<Exception> getErrors()

Get the error list from executed actions.

Specified by:

getErrors in interface ActionComposer

Returns:

a list of Exception