Package org.kquiet.browser

Class ActionComposerBuilder

java.lang.Object

org.kquiet.browser.ActionComposerBuilder

public class ActionComposerBuilder
extends Object

ActionComposerBuilder is resposible to build a ActionComposer in a fluent way. New ActionComposerBuilder instance is required before building a ActionComposer.

Below example constructs an ActionComposer that searches for the link to source code of ActionComposerBuilder, and then click it:

 ActionComposer actionComposer = new ActionComposerBuilder()
    .prepareActionSequence()
        .getUrl("https://github.com/kquiet/auto-browser/find/main")
        .waitUntil(ExpectedConditions.elementToBeClickable(By.id("tree-finder-field")), 3000)
        .sendKey(By.id("tree-finder-field"), "ActionComposerBuilder")
        .waitUntil(ExpectedConditions.elementToBeClickable(
            By.xpath("//mark[text()='ActionComposerBuilder']")), 3000)
        .click(By.xpath("//mark[text()='ActionComposerBuilder']"))
        .returnToComposerBuilder()
    .buildBasic();
 

More complicated ActionComposer can be built through built-in actions. ActionComposerBuilder includes inner builders for these actions as well.

Author:

Kimberly

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ActionComposerBuilder.ActionSequenceBuilder	A builder to build the actions into a sequence.

Constructor Summary

Constructors

Constructor	Description
ActionComposerBuilder()	Create a new ActionComposerBuilder.

Method Summary

Modifier and Type	Method	Description
ActionComposerBuilder	actionPerformed(Function<ActionComposer,Consumer<Composable>> func)	Set the function to be executed after any managed action of building ActionComposer is performed.
ActionComposerBuilder	actionPerforming(Function<ActionComposer,Consumer<Composable>> func)	Set the function to be executed when any managed action of building ActionComposer is performed.
<T extends ActionComposer> T	build(Class<T> composerType)	Finish building the ActionComposer.
<T extends ActionComposer> T	build(Class<T> composerType, String name)	Finish building the ActionComposer with its name.
<T extends ActionComposer> T	build(T actionComposer, String name)	Finish building the ActionComposer with its name.
BasicActionComposer	buildBasic()	Finish building the BasicActionComposer.
BasicActionComposer	buildBasic(String name)	Finish building the BasicActionComposer with its name.
ActionComposerBuilder	onDone(Consumer<ActionComposer> func)	Set the function to be executed when the execution of building ActionComposer finishes.
ActionComposerBuilder	onFail(Consumer<ActionComposer> func)	Set the function to be executed when the execution of building ActionComposer fails.
ActionComposerBuilder	onSuccess(Consumer<ActionComposer> func)	Set the function to be executed when the execution of building ActionComposer succeeds.
ActionComposerBuilder.ActionSequenceBuilder	prepareActionSequence()	Start building a sequence of actions.

Methods inherited from class java.lang.Object

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

Constructor Details

ActionComposerBuilder

public ActionComposerBuilder()

Create a new ActionComposerBuilder.

Method Details

onFail

public ActionComposerBuilder onFail(Consumer<ActionComposer> func)

Set the function to be executed when the execution of building ActionComposer fails.

Parameters:

func - the function to be executed

Returns:

this ActionComposerBuilder

See Also:

• ActionComposer.onFail(java.util.function.Consumer)

onSuccess

public ActionComposerBuilder onSuccess(Consumer<ActionComposer> func)

Set the function to be executed when the execution of building ActionComposer succeeds.

Parameters:

func - the function to be executed

Returns:

this ActionComposerBuilder

See Also:

• ActionComposer.onSuccess(java.util.function.Consumer)

onDone

public ActionComposerBuilder onDone(Consumer<ActionComposer> func)

Set the function to be executed when the execution of building ActionComposer finishes.

Parameters:

func - the function to be executed

Returns:

this ActionComposerBuilder

See Also:

• ActionComposer.onDone(java.util.function.Consumer)

actionPerforming

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

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

Parameters:

func - the function to be executed

Returns:

this ActionComposerBuilder

See Also:

• ActionComposer.actionPerforming(java.util.function.Function)

actionPerformed

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

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

Parameters:

func - the function to be executed

Returns:

this ActionComposerBuilder

See Also:

• ActionComposer.actionPerformed(java.util.function.Function)

buildBasic

public BasicActionComposer buildBasic()

Finish building the BasicActionComposer.

Returns:

the built BasicActionComposer

buildBasic

public BasicActionComposer buildBasic(String name)

Finish building the BasicActionComposer with its name.

Parameters:

name - name of BasicActionComposer

Returns:

the built BasicActionComposer

build

public <T extends ActionComposer> T build(Class<T> composerType)
                                   throws ClassNotFoundException,
InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException

Finish building the ActionComposer.

Type Parameters:

T - the type of ActionComposer to build

Parameters:

composerType - the type of ActionComposer to build

Returns:

the built ActionComposer

Throws:

ClassNotFoundException - if the class of composer type cannot be located

InstantiationException - if the class of composer type represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason

IllegalAccessException - if the class of composer type or its nullary constructor is not accessible

SecurityException - the class loader of ActionComposerBuilder failed checks on access or permission of the class loader of composer type's class

NoSuchMethodException - if the class of composer type doesn't have a constructor

InvocationTargetException - if the underlying constructor of composer type throws an exception

IllegalArgumentException - if the class of composer type doesn't have a zero-argument constructor

build

public <T extends ActionComposer> T build(Class<T> composerType,
 String name)
                                   throws ClassNotFoundException,
InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException

Finish building the ActionComposer with its name.

Type Parameters:

T - the type of ActionComposer to build

Parameters:

composerType - the type of ActionComposer to build

name - name of ActionComposer

Returns:

the built ActionComposer

Throws:

ClassNotFoundException - if the class of composer type cannot be located

InstantiationException - if the class of composer type represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no nullary constructor; or if the instantiation fails for some other reason

IllegalAccessException - if the class of composer type or its nullary constructor is not accessible

SecurityException - the class loader of ActionComposerBuilder failed checks on access or permission of the class loader of composer type's class

NoSuchMethodException - if the class of composer type doesn't have a constructor

InvocationTargetException - if the underlying constructor of composer type throws an exception

IllegalArgumentException - if the class of composer type doesn't have a zero-argument constructor

build

public <T extends ActionComposer> T build(T actionComposer,
 String name)

Finish building the ActionComposer with its name.

Type Parameters:

T - the type of ActionComposer to build

Parameters:

actionComposer - the instance of ActionComposer to build

name - name of ActionComposer

Returns:

the built ActionComposer

prepareActionSequence

public ActionComposerBuilder.ActionSequenceBuilder prepareActionSequence()

Start building a sequence of actions.

Returns:

ActionComposerBuilder.ActionSequenceBuilder