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 ServerConnector	serverConnector

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static void	collectRegions(ImageMatchSettings imageMatchSettings, ICheckSettingsInternal checkSettingsInternal)
static void	collectRegions(ImageMatchSettings imageMatchSettings, Location location, List<? extends IRegion> regions, List<VisualGridSelector[]> regionSelectors)
static ImageMatchSettings	createImageMatchSettings(ICheckSettingsInternal checkSettingsInternal, EyesBase eyes) Build match settings by merging the check settings and the default match settings.
static ImageMatchSettings	createImageMatchSettings(ICheckSettingsInternal checkSettingsInternal, EyesScreenshot screenshot, EyesBase eyesBase) Build match settings by merging the check settings and the default match settings.
EyesScreenshot	getLastScreenshot()
MatchResult	matchWindow(Trigger[] userInputs, Region region, String tag, boolean shouldRunOnceOnTimeout, ICheckSettingsInternal checkSettingsInternal, String source) Repeatedly obtains an application snapshot and matches it with the next expected output, until a match is found or the timeout expires.

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 ServerConnector serverConnector

runningSession

protected RunningSession runningSession

appOutputProvider

protected AppOutputProvider appOutputProvider

matchResult

protected MatchResult matchResult

eyes

protected EyesBase eyes

Constructor Detail

MatchWindowTask

public MatchWindowTask(Logger logger,
                       ServerConnector 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.

Method Detail

collectRegions

public static void collectRegions(ImageMatchSettings imageMatchSettings,
                                  ICheckSettingsInternal checkSettingsInternal)

collectRegions

public static void collectRegions(ImageMatchSettings imageMatchSettings,
                                  Location location,
                                  List<? extends IRegion> regions,
                                  List<VisualGridSelector[]> regionSelectors)

matchWindow

public MatchResult matchWindow(Trigger[] userInputs,
                               Region region,
                               String tag,
                               boolean shouldRunOnceOnTimeout,
                               ICheckSettingsInternal checkSettingsInternal,
                               String source)

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.

checkSettingsInternal - The settings to use.

Returns:

Returns the results of the match

createImageMatchSettings

public static ImageMatchSettings createImageMatchSettings(ICheckSettingsInternal checkSettingsInternal,
                                                          EyesScreenshot screenshot,
                                                          EyesBase eyesBase)

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.

createImageMatchSettings

public static ImageMatchSettings createImageMatchSettings(ICheckSettingsInternal checkSettingsInternal,
                                                          EyesBase eyes)

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

Parameters:

checkSettingsInternal - the settings to match the image by.

Returns:

Merged match settings.

getLastScreenshot

public EyesScreenshot getLastScreenshot()