Package io.github.jspinak.brobot.fluent

Class ActionSequenceBuilder

java.lang.Object

io.github.jspinak.brobot.fluent.ActionSequenceBuilder

public class ActionSequenceBuilder
extends Object

Fluent API builder for creating DSL-compatible action sequences.

This builder allows developers to programmatically create automation sequences that are fully compatible with the Brobot DSL. Each method call creates ActionStep objects that are added to an internal TaskSequence.

Example usage:

 // Assuming userField, passwordField, submitButton are StateImage objects
 // and username, password are StateString objects
 InstructionSet loginSequence = Brobot.buildSequence()
     .withName("login")
     .find(userField)
     .thenClick()
     .thenType(username)
     .find(passwordField)
     .thenClick()
     .thenType(password)
     .find(submitButton)
     .thenClick()
     .build();
 

Constructor Summary

Constructors

Constructor	Description
ActionSequenceBuilder()

Method Summary

Modifier and Type	Method	Description
ActionSequenceBuilder	addCustomAction(ActionConfig options, ObjectCollection objects)	Adds a custom action with full control over options and objects.
InstructionSet	build()	Builds the final InstructionSet containing the automation function.
TaskSequence	buildTaskSequence()	Builds and returns just the TaskSequence without wrapping in InstructionSet.
ActionSequenceBuilder	declareTaskSequence(String variableName)	Creates a variable declaration statement for the task sequence.
ActionSequenceBuilder	find(StateImage target)	Adds a find action to the sequence.
ActionSequenceBuilder	thenClick()	Adds a click action on the last found object.
ActionSequenceBuilder	thenDragTo(StateImage target)	Adds a drag action from the last found object to a target.
ActionSequenceBuilder	thenHighlight(StateImage target, double seconds)	Adds a highlight action to visually mark regions on screen.
ActionSequenceBuilder	thenScroll(ScrollOptions.Direction direction, int times)	Adds a scroll action.
ActionSequenceBuilder	thenType(StateString stateString)	Adds a type action with a StateString.
ActionSequenceBuilder	thenWaitVanish(StateImage target)	Adds a vanish action to wait for an object to disappear.
ActionSequenceBuilder	withDescription(String description)	Sets the description for the automation function.
ActionSequenceBuilder	withName(String name)	Sets the name for the automation function.

Methods inherited from class java.lang.Object

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

Constructor Details

ActionSequenceBuilder

public ActionSequenceBuilder()

Method Details

withName

public ActionSequenceBuilder withName(String name)

Sets the name for the automation function.

withDescription

public ActionSequenceBuilder withDescription(String description)

Sets the description for the automation function.

find

public ActionSequenceBuilder find(StateImage target)

Adds a find action to the sequence. The found object becomes the target for subsequent actions.

thenClick

public ActionSequenceBuilder thenClick()

Adds a click action on the last found object.

thenType

public ActionSequenceBuilder thenType(StateString stateString)

Adds a type action with a StateString.

thenDragTo

public ActionSequenceBuilder thenDragTo(StateImage target)

Adds a drag action from the last found object to a target. This creates the 6 chained actions: Find→Find→MouseMove→MouseDown→MouseMove→MouseUp

thenHighlight

public ActionSequenceBuilder thenHighlight(StateImage target,
 double seconds)

Adds a highlight action to visually mark regions on screen.

thenWaitVanish

public ActionSequenceBuilder thenWaitVanish(StateImage target)

Adds a vanish action to wait for an object to disappear.

thenScroll

public ActionSequenceBuilder thenScroll(ScrollOptions.Direction direction,
 int times)

Adds a scroll action.

addCustomAction

public ActionSequenceBuilder addCustomAction(ActionConfig options,
 ObjectCollection objects)

Adds a custom action with full control over options and objects.

declareTaskSequence

public ActionSequenceBuilder declareTaskSequence(String variableName)

Creates a variable declaration statement for the task sequence.

build

public InstructionSet build()

Builds the final InstructionSet containing the automation function.

buildTaskSequence

public TaskSequence buildTaskSequence()

Builds and returns just the TaskSequence without wrapping in InstructionSet.