com.applitools.eyes

Class MatchWindowTask

java.lang.Object

com.applitools.eyes.MatchWindowTask

public class MatchWindowTask
extends Object

Constructor Summary

Constructors

Constructor and Description
MatchWindowTask(Logger logger, ServerConnector serverConnector, RunningSession runningSession, int retryTimeout, AppOutputProvider appOutputProvider)

Method Summary

Modifier and Type	Method and Description
Region	getLastScreenshotBounds()
MatchResult	matchWindow(Trigger[] userInputs, Region region, String tag, boolean shouldRunOnceOnTimeout, boolean ignoreMismatch, ImageMatchSettings imageMatchSettings, int retryTimeout) Repeatedly obtains an application snapshot and matches it with the next expected output, until a match is found or the timeout expires.
protected MatchResult	performMatch(Trigger[] userInputs, AppOutputWithScreenshot appOutput, String tag, boolean ignoreMismatch, ImageMatchSettings imageMatchSettings) Creates the match data and calls the server connector matchWindow method.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchWindowTask

public MatchWindowTask(Logger logger,
                       ServerConnector serverConnector,
                       RunningSession runningSession,
                       int retryTimeout,
                       AppOutputProvider appOutputProvider)

Parameters:

logger - A logger instance.

serverConnector - Our gateway to the agent

runningSession - The running session in which we should match the window

retryTimeout - The default total time to retry matching (ms).

appOutputProvider - A callback for getting the application output when performing match.

Method Detail

performMatch

protected MatchResult performMatch(Trigger[] userInputs,
                                   AppOutputWithScreenshot appOutput,
                                   String tag,
                                   boolean ignoreMismatch,
                                   ImageMatchSettings imageMatchSettings)

Creates the match data and calls the server connector matchWindow method.

Parameters:

userInputs - The user inputs related to the current appOutput.

appOutput - The application output to be matched.

tag - Optional tag to be associated with the match (can be null).

ignoreMismatch - Whether to instruct the server to ignore the match attempt in case of a mismatch.

imageMatchSettings - The settings to use.

Returns:

The match result.

matchWindow

public MatchResult matchWindow(Trigger[] userInputs,
                               Region region,
                               String tag,
                               boolean shouldRunOnceOnTimeout,
                               boolean ignoreMismatch,
                               ImageMatchSettings imageMatchSettings,
                               int retryTimeout)

Repeatedly obtains an application snapshot and matches it with the next expected output, until a match is found or the timeout expires.

Parameters:

userInputs - User input preceding this match.

region - Window region to capture.

tag - Optional tag to be associated with the match (can be null).

shouldRunOnceOnTimeout - Force a single match attempt at the end of the match timeout.

ignoreMismatch - Whether to instruct the server to ignore the match attempt in case of a mismatch.

imageMatchSettings - The settings to use.

retryTimeout - The amount of time to retry matching in milliseconds or a negative value to use the default retry timeout.

Returns:

Returns the results of the match

getLastScreenshotBounds

public Region getLastScreenshotBounds()