com.applitools.eyes

Class MatchWindowTask

java.lang.Object

com.applitools.eyes.MatchWindowTask

public class MatchWindowTask
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected AppOutputProvider	appOutputProvider
protected EyesBase	eyes
protected Logger	logger
protected MatchResult	matchResult
protected RunningSession	runningSession
protected IServerConnector	serverConnector

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MatchWindowTask()
	MatchWindowTask(Logger logger, IServerConnector serverConnector, RunningSession runningSession, int retryTimeout, EyesBase eyes)
	MatchWindowTask(Logger logger, IServerConnector serverConnector, RunningSession runningSession, int retryTimeout, EyesBase eyes, AppOutputProvider appOutputProvider)

Method Summary

Modifier and Type	Method and Description
ImageMatchSettings	createImageMatchSettings(ICheckSettingsInternal checkSettingsInternal, EyesScreenshot screenshot) Build match settings by merging the check settings and the default match settings.
Region	getLastScreenshotBounds()
MatchResult	matchWindow(Trigger[] userInputs, Region region, String tag, boolean shouldRunOnceOnTimeout, boolean ignoreMismatch, ICheckSettingsInternal checkSettingsInternal, int retryTimeout) Repeatedly obtains an application snapshot and matches it with the next expected output, until a match is found or the timeout expires.
MatchResult	performMatch(Trigger[] userInputs, AppOutputWithScreenshot appOutput, String tag, boolean ignoreMismatch, ImageMatchSettings imageMatchSettings) Creates the match model 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

Field Detail

logger

protected Logger logger

serverConnector

protected IServerConnector serverConnector

runningSession

protected RunningSession runningSession

appOutputProvider

protected AppOutputProvider appOutputProvider

matchResult

protected MatchResult matchResult

eyes

protected EyesBase eyes

Constructor Detail

MatchWindowTask

protected MatchWindowTask()

MatchWindowTask

public MatchWindowTask(Logger logger,
                       IServerConnector serverConnector,
                       RunningSession runningSession,
                       int retryTimeout,
                       EyesBase eyes,
                       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).

eyes - An EyesBase object.

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

MatchWindowTask

public MatchWindowTask(Logger logger,
                       IServerConnector serverConnector,
                       RunningSession runningSession,
                       int retryTimeout,
                       EyesBase eyes)

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).

Method Detail

performMatch

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

Creates the match model 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,
                               ICheckSettingsInternal checkSettingsInternal,
                               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.

checkSettingsInternal - 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

createImageMatchSettings

public ImageMatchSettings createImageMatchSettings(ICheckSettingsInternal checkSettingsInternal,
                                                   EyesScreenshot screenshot)

Build match settings by merging the check settings and the default match settings.

Parameters:

checkSettingsInternal - the settings to match the image by.

screenshot - the Screenshot wrapper object.

Returns:

Merged match settings.

getLastScreenshotBounds

public Region getLastScreenshotBounds()