Package io.github.jspinak.brobot.actions.actionConfigurations

Class Success

java.lang.Object

io.github.jspinak.brobot.actions.actionConfigurations.Success

@Component
public class Success
extends Object

Defines the success condition for individual Actions. CompositeActions may have more complex success conditions that cannot be defined by just using the Matches returned by the Action. For example, ClickUntil can click until an object appears or an object vanishes. This option is in the ActionOptions parameter.

Constructor Summary

Constructors

Constructor	Description
Success()

Method Summary

Modifier and Type	Method	Description
Predicate<Matches>	getCriteria(ActionOptions actionOptions)
void	set(ActionOptions actionOptions, Matches matches)	If new success criteria has been added to the operation, use it to determine success.

Methods inherited from class java.lang.Object

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

Constructor Details

Success

public Success()

Method Details

getCriteria

public Predicate<Matches> getCriteria(ActionOptions actionOptions)

set

public void set(ActionOptions actionOptions,
 Matches matches)

If new success criteria has been added to the operation, use it to determine success. If not, use the standard success criteria as defined in this class.

Parameters:

actionOptions - holds any new success criteria

matches - are normally used by success criteria to calculate success